Methods

twinBASIC Methods

A method is an action that an object can perform. For example, the SetFocus method of the TextBox control will move the input cursor to the textbox so the user can enter data into it.

---

AddItem

Inputs

• Value - String
• Index - Variant

Outputs

None

The AddItem method adds a new item to a collection object. The Value parameter represents the string to display in the control. The Index is a zero-based index that represents the position in the control in which to insert the new item. Note: the index can be any numeric data type but only the integer portion is used. A string that evaluates to a number is also accepted. If a number larger than the last existing index plus one is used, the item will not be added.

DriveListBox, DirListBox, FileListBox

The AddItem method is not implemented and will raise an error if called.

Change HDC

Inputs

• hdc - Long
• hwnd - Long
• rootwindowelement - RootWindowElement
• picture - StdPicture
• owner - Object

Outputs

The ChangeHDC method...

Circle

The Circle method...

Clear

Inputs

None

Outputs

None

Collection Controls

The Clear method removes all items from a collection. To remove a single item, use the Remove method of the individual item.

Clipboard, ComboBox, and ListBox Controls

Clears the contents of the control. For the ComboBox and ListBox that are bound to a data source, the clear method is not available.

Data Object

The Clear method deletes the contents of a DataObject

Err Object

Explicitly clears the data object.

ClearLog

The ClearLog method...

Cls

The Cls method...

CopyBufferToDC

Inputs

• hdc - Long

Outputs

The CopyBufferToDC method...

CreateBackbrush

Inputs

• Color - Long

Outputs

• Long

The CreateBackbrush method...

CreateDeferredDispatchWrapper

Inputs

• Object - Object

Outputs

• Object

The CreateDeferredDispatchWrapper method...

CreateRootWindowElement

Inputs

• _ControlContext - IUnknown
• ClassName - String
• Caption - String
• WindowStyles - Long
• ExtendedStyles - Long
• SubClass - Boolean (Optional, False)

Outputs

• WindowElement

The CreateRootWindowElement method...

Drag

Inputs

• Action - DragAction

Outputs

None

The Drag method begins, cancels, or ends a drag operation.

EndMouseCapture

Inputs

Outputs

The EndMouseCapture method...

GetFontMetrics

Inputs

None

Outputs

• TextMetric

The GetFontMetrics method...

GetLastLog

Inputs

None

Outputs

• String

The GetLastLog method...

GetNodeFromHandle

Inputs

Handle - LongPtr

Outputs

• Node

The GetNodeFromHandle method...

GetObjPtrFromHandle

Inputs

Handle - LongPtr

Outputs

• Long

The GetObjPtrFromHandle method...

GetVisibleCount

Inputs

None

Outputs

• Long

The GetVisibleCount Method method...

HandleAttributesChange

Inputs

None

Outputs

None

The HandleAttributesChange method...

HandlePathChange

Inputs

None

Outputs

None

The HandlePathChange method...

HandlePatternChange

Inputs

None

Outputs

None

The HandlePatternChange method...

HitTest

Inputs

• x - Single
• y - Single

Outputs

• Node

The HitTest method...

Initialize

Inputs

Outputs

The Initialize method...

IsInRect

Inputs

Outputs

The IsInRect method...

InternalRaiseResize

Inputs

Outputs

The InternalRaiseResize method...

Line

Inputs

Outputs

The Line method...

Move

Inputs

• Left - Single
• Top - Variant
• Width - Variant
• Height - Variant

Outputs

None

The Move method is used to move a control within its container. It can also, optionally, resize the control at the same time.

Note: Left is a required parameter. The remaining parameters are optional.

OLEDrag

Inputs

Outputs

The OLEDrag method...

PaintPicture

Inputs

Outputs

The PaintPicture method...

PSet Method

Inputs

Outputs

The PSet Method method...

Refresh

Inputs

None

Outputs

None

User Interface Controls

The Refresh method causes the control to repaint itself on the screen. This is rarely needed as most controls repaint automatically.

Data and Filesystem Controls

Calling the Refresh method on data and filesystem controls will cause them to refresh their data. This might be necessary if the data or files could have changed.

RemoveItem

Inputs

Outputs

The RemoveItem method...

Scale

Inputs

Outputs

The Scale method...

ScheduleCallback

Inputs

None

Outputs

None

The ScheduleCallback method..

SelectedItem

Inputs

None

Outputs

None

The SelectedItem method.

SetFocus

Inputs

None

Outputs

None

The SetFocus method causes the keyboard input to be directed at the control.

ShowWhatsThis

Inputs

Outputs

The ShowWhatsThis method...

SortNowInternal

Inputs

None

Outputs

None

The SortNowInternal method...

StartLabelEdit

Inputs

Outputs

The StartLabelEdit Method method...

StepIt

Inputs

Outputs

The StepIt method...

SubClassWindowElement

Inputs

• hWnd - Long

Outputs

• IUnknown

The SubClassWindowElement method...

SyncDirs

Inputs

• Path - String
• ForceRefresh - Boolean - When set to true, forces a refresh of the DirListBoxcontrol. This is not normally necessary.
• ChangeSelected - Boolean - When set to true, forces the DirListBox to select the folder specified in the Path property.

Outputs

None

The SyncDirs method changes the folder shown in the DirListBox.

SyncDrives

Inputs

None

Outputs

None

The SyncDrives method...

SyncFiles

Inputs

Outputs

The SyncFiles method...

TextHeight Method

Inputs

Outputs

The TextHeight Method method...

TextWidth Method

Inputs

Outputs

The TextWidth Method method...

ZOrder

Inputs

Outputs

The ZOrder method...