Class

BinaryStream

---

Description

BinaryStream objects are used to read and write data to and from a binary file. The benefit of using BinaryStreams rather than text streams is that you can read from and write to any position in the file. Text files must be read sequentially from the start to the end.

Compatibility

Project Types	All
Operating Systems	All

Properties

Name	Type	Read-Only	Shared
BytePosition	UInt64
Length	UInt64
LittleEndian	Boolean

WhiteSands

This is a document I use to try out RestructuredText stuff. Don't link to any other page or this page will get indexed for searching.

Testing. One two three four.

Attention

I got your attention.

Caution

Caution!

Danger

Danger, Will Robinson!

Error

Error.

Hint

I've got a hint for you.

Important

This is important.

Note

This is a note.

Tip

I have a tip for you.

Warning

You've been warned.

And, by the way...

You can make up your own admonition too.

See also

See also...

Optional Sidebar Title

Optional Sidebar Subtitle

Subsequent indented lines comprise the body of the sidebar, and are interpreted as body elements.

1. This is the first line.

2. The is another line.

Then we have some text.

1. Ideally, this would be line number 3, but it's not because there's a line with text in-between. :(

book

a thing you read.

page

a component of a book.

Then you can use the item using book and page.

You can do this RETURN or this ⌘-I or Ctrl+I this or like this Ctrl-^.

"{""protocol"":2}" + chr(0)

Testing

• Webapp.unhandledexception does this work?

• admonitions

• Sidebars

• OutOfMemoryException.ErrorNumber

String = " "

value As </api/data_types/string>

#If TargetBoolean [Then]
  ' Target-specific code
[#ElseIf TargetBoolean]
  ' Other Target-specific code
[#Else]
  ' Other Target-specific code
#EndIf

#If TargetBoolean [ Then ]
  ' Target-specific code
[ #ElseIf TargetBoolean ]
  ' Other Target-specific code
[ #Else ]
  ' Other Target-specific code
#EndIf

Martins Testing

ToString(loc As Locale = Nil, dateStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium, timeStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium) As String

Converts the DateTime (along with the time component) to a string format using the optional locale and formats.

ToString(format As String, locale As Locale = Nil) As String

Converts the DateTime (along with the time component) to a string format using the optional locale and formats.

#If TargetBoolean [ Then ]
  ' Target-specific code
[ #ElseIf TargetBoolean ]
  ' Other Target-specific code
[ #Else ]
  ' Other Target-specific code
#EndIf

ToString(dateStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium, timeStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium) As String

Converts the DateTime (along with the time component) to a string format using the optional locale and formats.

Martins Alternative

Internal Link 1

Internal Link 2

Internal Link 3

ToString(loc As Locale = Nil, dateStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium, timeStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium) As String

ToString(format As String, locale As Locale = Nil) As String

ToString(dateStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium, timeStyle As DateTime.FormatStyles = DateTime.FormatStyles.Medium) As String

Converts the DateTime (along with the time component) to a string format using the optional locale and formats.

Important

This method is shared.

#If TargetBoolean [ Then ]
  ' Target-specific code
[ #ElseIf TargetBoolean ]
  ' Other Target-specific code
[ #Else ]
  ' Other Target-specific code
#EndIf

Important

This method is shared.

This is an example reference link

Compatibility

Scheme: The values are sorted alphabetically.

Project Types	Console, Desktop, Mobile, Web
Operating Systems	Android, iOS, Linux, macOS, Windows

or

Project Types	All
Operating Systems	All

All

Previous: All project types on all supported operating systems.

Project Types	All
Operating Systems	All

Console

Project Types	Console
Operating Systems	All

Desktop

Previous: Desktop projects on all supported operating systems.

Project Types	Desktop
Operating Systems	All

Console/Desktop/Web

Previous: Desktop, web and console project on Windows.

Project Types	Console, Desktop, Web
Operating Systems	All

Web

Previous: Web projects on all supported operating systems.

Project Types	Web
Operating Systems	All

iOS/Web

Previous: iOS and Web project types on all supported operating systems.

Project Types	Mobile, Web
Operating Systems	iOS, Linux, macOS, Windows

Mobile

Previous: Mobile projects on all supported mobile operating systems.

Project Types	Mobile
Operating Systems	All

Android

Previous: Android projects on the Android operating system.

Project Types	Mobile
Operating Systems	Android

iOS

Previous: iOS projects on the iOS operating system.

Project Types	Mobile
Operating Systems	iOS

If TargetXojoCloud Then
  // Running on Xojo Cloud
Else
  // Not on Xojo Cloud
End If

---

Class (Version 1)

Pop3SecureSocket

Inheritance: Object → SocketCore → TCPSocket → SSLSocket → Pop3SecureSocket

---

Description

Used to retrieve messages on a POP3 mail server using SSL or TLS encryption.

---

Class (Version 2)

Pop3SecureSocket

Inheritance:

• Object

  • SocketCore

    • TCPSocket

      • SSLSocket

        • Pop3SecureSocket

---

Class (Version 3)

Pop3SecureSocket

Inheritance:

Object

↪︎ SocketCore

↪︎ TCPSocket

↪︎ SSLSocket

↪︎ Pop3SecureSocket

---

Description

Used to retrieve messages on a POP3 mail server using SSL or TLS encryption.

Table with Linebreaks

Tables can be generated here: https://www.tablesgenerator.com/text_tables

It supports merged cells, linebreaks within cells etc.

Header row, column 1 (header rows optional)	Header 2	Header 3	Header 4
body row 1, column 1	column 2	✓	✓
body row 2	Cells may span columns.
body row 3	Cells may span rows.	Table cells contain body elements.
body row 4

Xojo iOS - Android Development: Main Differences

Projects

	iOS	Android
Are iOS / Android Projects compatibles?	No, but is possible to copy / paste controls / screens between iOS / Android projects (always these are using compatible Events / methods / properties / code). Also, while iOS Projects does support the use of SplitView on iPad, that's not supported on Android (Master / Detail views).
Supported API Version	1.0 and 2.0	2.0

Project Structure

	iOS	Android
Separate Layouts for Phone / Tablet	✓
Controls Locking System	Auto-Layout / Constraints.	Locks, as in Desktop and Web projects.

MobileApplication

	iOS	Android
Properties
AndroidContextHandle		✓
BugVersion	✓	✓
BuildDateTime	✓	✓
CurrentLayout	✓
CurrentScreen		✓
DefaultMobileScreen
GoogleMapsAPIKey		✓
IconBadgeNumber	✓
MajorVersion	✓	✓
MinorVersion	✓	✓
NonReleaseVersion	✓	✓
StageCode	✓	✓
ThemeColorName		✓
ThemeDarkColor		✓
ThemeLightColor		✓
ThemeMediumColor		✓
TintColor	✓
Version	✓	✓
Events
Activated	✓	✓
Closing	✓	✓
Deactivating	✓	✓
HandleBackgroundURL	✓
HandleShortcut	✓
HandleURL	✓
LaunchOptions	✓
LowMemoryWarning	✓	✓
Opening	✓	✓
SignificantTimeChange	✓
UnhandledException	✓	✓

MobileButton

	iOS	Android
Properties
Caption	✓	✓
CaptionColor	✓	✓
CaptionFont	✓	✓
Methods
Press	✓	✓
Events
Closing	✓	✓
Opening	✓	✓
Pressed	✓	✓

MobileCanvas

	iOS	Android
Properties
AllowKeyEvents	✓
Methods
Refresh	✓	✓
Events
AppearanceChanged	✓
Closing	✓	✓
KeyDown	✓
Opening	✓	✓
Paint	✓	✓
PointerDown	✓	✓
PointerDrag	✓	✓
PointerUp	✓	✓
TextReceived	✓

MobileContainer

	iOS	Android
Properties
ControlCount	✓	✓
Methods
AddControl	✓	✓
ControlAt	✓	✓
Controls	✓	✓
Objects	✓	✓
RemoveControl	✓	✓
ShowPopover	✓
Events
AppearanceChanged	✓
Closing	✓	✓
Opening	✓	✓

MobileControl

	iOS	Android
Properties
Name	✓	✓
Methods
Handle	✓
Events
Closing	✓	✓
Opening	✓	✓

MobileDateTimePicker

	iOS	Android
Properties
CaptionColor		✓
CaptionFont		✓
DateCaption		✓
DisplayMode	✓	✓
DisplayStyle	✓
MaximumDate	✓	✓
MinimumDate	✓	✓
SelectedDate	✓	✓
TimeCaption		✓
Events
DateChanged	✓	✓

MobileHTMLViewer

	iOS	Android
Properties
CanGoBack	✓	✓
CanGoForward	✓	✓
Methods
Cancel	✓	✓
ExecuteJavaScript	✓	✓
GoBack	✓	✓
GoForward	✓	✓
LoadPage	✓	✓
LoadURL	✓	✓
CancelLoad	✓	✓
Events
DocumentBegin	✓	✓
DocumentComplete	✓	✓
DocumentProgressChanged	✓	✓
Error	✓	✓
JavaScriptRequest	✓	✓
JavaScriptResult		✓
NewWindow	✓	✓
TitleChanged	✓	✓

MobileImagePicker

	iOS	Android
Properties
AllowEditing	✓	✓
Source	✓	✓
Methods
Handle	✓
Show	✓	✓
Events
Cancelled	✓	✓
Selected	✓	✓

MobileImageViewer

	iOS	Android
Properties
DisplayMode	✓	✓
Image	✓	✓
URL	✓
Events
Pressed	✓	✓

MobileLabel

	iOS	Android
Properties
LineBreakMode	✓	✓

MobileLocation

	iOS	Android
Properties
Accuracy	✓	✓
AllowBackgroundUpdates	✓
AuthorizationState	✓	✓
VisitAwarness	✓
Methods
AddAllRegions	✓
AddRegion	✓
AddRegionAt	✓
RegionAt	✓
Regions	✓
RemoveAllRegions	✓
RemoveRegion	✓
RemoveRegionAt	✓
RequestUsageAuthorization	✓	✓
Start	✓	✓
Stop	✓	✓
Events
AuthorizationStateChanged	✓	✓
LocationChanged	✓	✓
RegionEntered	✓
RegionExited	✓
VisitChanged	✓

MobileMessageBox

	iOS	Android
Properties
Handle		✓
Message	✓	✓
Title	✓	✓
Methods
Buttons	✓	✓
Show	✓	✓
Events
Pressed	✓	✓

MobileMotion

	iOS	Android
Properties
GravityAccelerationX	✓	✓
GravityAccelerationY	✓	✓
GravityAccelerationZ	✓	✓
Pitch	✓	✓
Roll	✓	✓
RotationRateX	✓	✓
RotationRateY	✓	✓
RotationRateZ	✓	✓
UpdateInterval	✓	✓
UserAccelerationX	✓	✓
UserAccelerationY	✓	✓
UserAccelerationZ	✓	✓
Yaw	✓	✓
Methods
Handle	✓
Start	✓	✓
Stop	✓	✓

MobileMoviePlayer

	iOS	Android
Properties
Duration	✓	✓
HasController	✓
Movie	✓
Position	✓	✓
Volume	✓	✓
Methods
GoToStart	✓	✓
LoadFile	✓	✓
LoadURL	✓	✓
Pause	✓	✓
Play	✓	✓
Events
PlaybackPaused	✓	✓
PlaybackStarted	✓	✓
PositionChanged	✓	✓

MobileOval

	iOS	Android
Properties
BorderColor	✓	✓
BorderThickness	✓	✓
FillColor	✓	✓

MobilePopupMessage

	iOS	Android
Methods
Show	✓	✓

MobilePopupMenu

	iOS	Android
Properties
InitialValue		✓
LastAddedRowIndex		✓
LastRowIndex		✓
RowCount		✓
SelectedRowIndex		✓
SelectedRowText		✓
Methods
AddAllRows		✓
AddRow		✓
AddRowAt		✓
RemoveAllRows		✓
RemoveRowAt		✓
RowTagAt		✓
RowTextAt		✓
SelectRowWithTag		✓
SelectRowWithText		✓
Events
SelectionChanged		✓

MobileProgressBar

	iOS	Android
Properties
MaximumValue	✓	✓
MinimumValue	✓	✓
Value	✓	✓

MobileProgressWheel

	iOS	Android
Properties
Shade	✓	✓

MobileRectangle

	iOS	Android
Properties
BorderColor	✓	✓
BorderThickness	✓	✓
CornerSize	✓	✓
FillColor	✓	✓
Methods
SetEffect	✓

MobileScreen

	iOS	Android
Properties
BackButtonCaption	✓
BottomLayoutGuide	✓
ControlCount	✓	✓
HasBackButton		✓
HasNavigationBar	✓	✓
LargeTitleDisplayMode	✓
LeftNavigationToolbar	✓
Modal		✓
NavigationBarHeight		✓
NavigationToolbar		✓
RightNavigationToolbar	✓
ScaleFactor	✓	✓
TabBarVisible	✓
TabIcon	✓
TintColor	✓
Title	✓	✓
Toolbar	✓	✓
TopLayoutGuide	✓
Methods
AddConstraint	✓
AddControl	✓	✓
Close	✓	✓
Constraint	✓
ContentSize	✓	✓
ControlAt	✓	✓
Controls	✓	✓
Handle	✓	✓
Objects	✓	✓
RemoveConstraint	✓
RemoveControl	✓	✓
Show	✓	✓
ShowModal	✓	✓
ShowPopover	✓
Size	✓	✓
ViewControllerHandle	✓
Events
Activated	✓	✓
AppearanceChanged	✓
Closing	✓	✓
Deactivated	✓	✓
KeyDown	✓
KeyUp	✓
Opening	✓	✓
OrientationChanged	✓	✓
Resized	✓
ToolbarButtonPressed	✓	✓

MobileScrollableArea

	iOS	Android
Properties
Container	✓	✓
Methods
ScrollTo	✓	✓

MobileSegmentedButton

	iOS	Android
Properties
LastSegmentIndex	✓	✓
SegmentCount	✓	✓
SelectedSegment	✓	✓
SelectedSegmentIndex	✓	✓
Methods
AddSegment	✓	✓
AddSegmentAt	✓	✓
RemoveAllSegments	✓	✓
RemoveSegment	✓	✓
RemoveSegmentAt	✓	✓
ResizeSegmentsToFit		✓
SegmentAt	✓	✓
Events
Pressed	✓	✓

MobileSegment

	iOS	Android
Properties
Caption	✓	✓
Icon	✓	✓
Selected	✓	✓
Width	✓	✓

MobileSharingPanel

	iOS	Android
Methods
ShareFile	✓	✓
SharePicture	✓	✓
ShareText	✓	✓
ShareURL	✓	✓
Events
Cancelled	✓	✓
Completed	✓	✓

MobileSlider

	iOS	Android
Properties
MaximumValue	✓	✓
MinimumValue	✓	✓
Value	✓	✓
Events
ValueChanged	✓	✓

MobileSwitch

	iOS	Android
Properties
Value	✓	✓
Events
ValueChanged	✓	✓

AndroidMobileTable

	iOS	Android
Properties
HasHeader		✓
Header		✓
HeaderFont		✓
InitialValue		✓
LastAddedRowIndex		✓
LastRowIndex		✓
RowCount		✓
RowDetailFont		✓
RowTextFont		✓
ScrollPosition		✓
SelectedRowIndex		✓
SelectedRowText		✓
SeparatorColor		✓
SeparatorThickness		✓
Methods
AddRow		✓
AddRowAt		✓
RemoveAllRows		✓
RemoveRowAt		✓
RowBackgroundColorAt		✓
RowBoldAt		✓
RowDetailAt		✓
RowDetailColorAt		✓
RowDetailTagAt		✓
RowPictureAt		✓
RowTagAt		✓
RowTextAlignmentAt		✓
RowTextAt		✓
RowTextColorAt		✓
Events
SelectionChanged		✓

MobileTabPanel

	iOS	Android
Properties
LastAddedPanelIndex		✓
PanelCount		✓
SelectedPanelIndex		✓
Methods
AddPanel		✓
AddPanelAt		✓
CaptionAt		✓
ContainerAt		✓
IconAt		✓
RemovePanelAt		✓
Events
PanelChanged		✓

MobileTextArea

	iOS	Android
Properties
AllowAutoCorrection	✓
AllowSpellChecking	✓	✓
AutoCapitalizationType	✓
BorderStyle	✓
ReadOnly	✓	✓
SelectedText	✓	✓
SelectionLength	✓	✓
SelectionStart	✓	✓
Methods
AddText	✓	✓
SelectAll	✓	✓
Events
FocusLost	✓	✓
FocusReceived	✓	✓
KeyDown	✓
SelectionChanged	✓	✓
TextChanged	✓	✓

MobileTextControl

	iOS	Android
Properties
Alignment	✓	✓
MaximumCharactersAllowed	✓	✓
Text	✓	✓
TextColor	✓	✓
TextFont	✓	✓

MobileTextField

	iOS	Android
Properties
AllowAutoCorrection	✓
AllowSpellChecking	✓	✓
AutoCapitalizationType	✓
BorderStyle	✓
Hint	✓	✓
InputType	✓	✓
Password	✓	✓
ReadOnly	✓	✓
ReturnCaption	✓
SelectedText	✓	✓
SelectionLength	✓	✓
SelectionStart	✓	✓
Methods
SelectAll	✓	✓
Events
FocusLost	✓	✓
FocusReceived	✓	✓
KeyDown	✓
ReturnPressed	✓	✓
SelectionChanged	✓	✓
TextChanged	✓	✓

MobileUIControl

	iOS	Android
Properties
AccessibilityHint
AccessibilityLabel
ControlCount
Enabled
Height
Left
LockBottom
LockLeft
LockRight
LockTop
Parent
TintColor
Top
Visible
Width
Methods
AddConstraint
AddControl
ClearFocus
ControlAt
Controls
Handle
Refresh
RemoveConstraint
RemoveControl
SetFocus

AndroidMobileUserControl

	iOS	Android
Events
CreateView

MobileToolbarButton

	iOS	Android
Properties
Caption
Enabled
Handle
Icon
MenuOnly
Tag
Type
Width
Methods
Constructor
FromHandle

MobileToolbar

	iOS	Android
Properties
Count
AddButton
AddButtonAt
ButtonAt
Constructor
RemoveAllButtons
RemoveButtonAt

Test Integer Division \

• Fullsearch
• Compiler Directives

• Foo
• Bar Directives