tokenfield statement

	<< Index >>	FutureBasic
TokenField		statement / function

Statement syntax
tokenfield tag, enabled, text, rect, style, wndTag

Function syntax


text = tokenfield(tag)

Description
The tokenfield statement puts a new tokenfield in the current output window, or alters an existing tokenfield's characteristics. The tokenfield function returns the field's text as a CFStringRef and is equivalent to calling fn ControlStringValue.

Parameters

Parameter
Description

tag A number (1 through 1000000) that you assign when you create the tokenfield and that you refer to when altering the field. The number you assign must be different from the tag value of all other existing widgets in the current window. A negative tag hides the tokenfield.

enabled A boolean value which specifies whether the tokenfield should be enabled or disabled.

text The text that appears inside the tokenfield.

rect The tokenfield's enclosing rectangle. This can be specified in either of two ways:

(i) (x,y,w,h) where x,y are the origin and w,h the size of the field.
(ii) A CGRect value

style Specifies the style of the tokenfield:

NSTokenStyleDefault (default)
NSTokenStyleNone
NSTokenStyleRounded
NSTokenStylePlainSquared // macOS 10.10+
NSTokenStyleSquared // macOS 10.10+

wndTag An optional parameter for when the tokenfield's window is not the current output window. Note specifying this parameter does not bring the window to the front or make it the output window.

Dialog events
See: textfield
_tokenFieldDisplayStringForRepresentedObject
_tokenFieldStyleForRepresentedObject
_tokenFieldCompletionsForSubstring
_tokenFieldEditingStringForRepresentedObject
_tokenFieldRepresentedObjectForEditingString
_tokenFieldShouldAddObjects
_tokenFieldReadFromPasteboard
_tokenFieldWriteRepresentedObjectToPasteboard
_tokenFieldHasMenuForRepresentedObject
_tokenFieldMenuForRepresentedObject

Subclass
To subclass a nib tokenfield, set its class name to "TokenFieldSC" in the nib.

See also
textfield

Apple documentation
NSTokenField

Parameter	Description
tag	A number (1 through 1000000) that you assign when you create the tokenfield and that you refer to when altering the field. The number you assign must be different from the tag value of all other existing widgets in the current window. A negative tag hides the tokenfield.
enabled	A boolean value which specifies whether the tokenfield should be enabled or disabled.
text	The text that appears inside the tokenfield.
rect	The tokenfield's enclosing rectangle. This can be specified in either of two ways: (i) `(x,y,w,h)` where x,y are the origin and w,h the size of the field. (ii) A CGRect value
style	Specifies the style of the tokenfield: NSTokenStyleDefault (default) NSTokenStyleNone NSTokenStyleRounded NSTokenStylePlainSquared // macOS 10.10+ NSTokenStyleSquared // macOS 10.10+
wndTag	An optional parameter for when the tokenfield's window is not the current output window. Note specifying this parameter does not bring the window to the front or make it the output window.