NSTokenField Bindings

Related class
Availability
Available in OS X v10.4 and later.

Availability Bindings

editable

A multiple-value binding that determines if the NSTokenField is editable in the user interface.

When editable is bound, a new binding, editable2, is exposed and can be bound. Binding to editable2 causes editable3 to be exposed, and so on.

The contents of the NSTokenField are editable if a logical AND operation on all the editable bindings results in a Boolean value of YES.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOption NSNumber (Boolean) or NSNull

enabled

A multiple-value binding that determines if the NSTokenField is enabled in the user interface.

When enabled is bound, a new binding, enabled2, is exposed and can be bound. Binding to enabled2 causes enabled3 to be exposed, and so on.

The NSTokenField is enabled if a logical AND operation on all the enabled bindings results in a Boolean value of YES.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOption NSNumber (Boolean) or NSNull

hidden

A multiple-value binding that determines if the NSTokenField is displayed in the user interface.

When hidden is bound, a new binding, hidden2, is exposed and can be bound. Binding to hidden2 causes hidden3 to be exposed, and so on.

The NSTokenField is hidden if a logical OR operation on all the hidden bindings results in a Boolean value of YES.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOption NSNumber (Boolean) or NSNull

Font Bindings

font

An NSFont used to display the NSTokenField.

If font is bound, all other Font category bindings are disabled.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)

fontBold

A Boolean value that determines if the NSFont used to display the NSTokenField is bold. If fontBold evaluates to YES, the bold attribute is added to the font.

If fontBold is bound, the font and fontName bindings are disabled.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOption NSNumber (Boolean) or NSNull

fontFamilyName

An NSString that specifies the family name of the NSFont used to display the contents of the NSTokenField.

If fontFamilyName is bound to a key, the font and fontName bindings are disabled.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSString
Null PlaceholderNSNullPlaceholderBindingOption NSString

fontItalic

A Boolean value that determines if the NSFont used to display the NSTokenField is italic. If fontItalic evaluates to YES, the italic attribute is added to the font.

If fontItalic is bound, the font and fontName bindings are disabled.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOption NSNumber (Boolean) or NSNull

fontName

An NSString that specifies the full name of the NSFont that is used to display the contents of the NSTokenField. The full font name includes the family and the style of the font — for example, "Helvetica-Bold".

If fontName bound to a key, the font, fontBold, fontFamilyName and fontItalic bindings are disabled.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSString
Null PlaceholderNSNullPlaceholderBindingOption NSString

fontSize

An integer value that determines the size, in points, of the font used to display the NSTokenField.

If fontSize is bound, the font binding is disabled.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSNumber
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSNumber
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSNumber
Null PlaceholderNSNullPlaceholderBindingOption NSNumber

Parameters Bindings

alignment

An integer value that specifies the alignment of the content displayed in the NSTokenField.

A value of 0 indicates that the content is left aligned, 1 that it is centered, and 2 that is it right aligned.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSNumber
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSNumber
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSNumber
Null PlaceholderNSNullPlaceholderBindingOption NSNumber

toolTip

An NSString that contains the tool tip to display for this NSTokenField.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSString
Null PlaceholderNSNullPlaceholderBindingOption NSString

Text Color Bindings

textColor

An NSColor that specifies the color used to display the text of the NSTokenField.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)

Value Bindings

value

An NSString or NSNumber that is displayed as the content of the NSTokenField.

Availability:
Available in OS X v10.4 and later.


Binding Options
OptionBinding option constantValue class
Allows Editing Multiple Value SelectionNSAllowsEditingMultipleValuesSelectionBindingOption NSNumber (Boolean)
Always Presents Application Modal Alerts. Available in OS X v10.4 and later.NSAlwaysPresentsApplicationModalAlertsBindingOption NSNumber (Boolean)
Conditionally Sets EditableNSConditionallySetsEditableBindingOption NSNumber (Boolean)
Conditionally Sets EnabledNSConditionallySetsEnabledBindingOption NSNumber (Boolean)
Conditionally Sets HiddenNSConditionallySetsHiddenBindingOption NSNumber (Boolean)
Continuously Updates ValueNSContinuouslyUpdatesValueBindingOption NSNumber (Boolean)
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)
Validates ImmediatelyNSValidatesImmediatelyBindingOption NSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSString
Null PlaceholderNSNullPlaceholderBindingOption NSString

Value With Pattern Bindings

displayPatternValue1

A multiple-value binding that specifies a string value that replaces %{value1}@ in a display pattern string that is used to set the value of the NSTokenField.

When displayPatternValue1 is bound, a new binding, displayPatternValue2, is exposed and can be bound. Binding to displayPatternValue2 causes displayPatternValue3 to be exposed, and so on.

The Display Pattern binding option is an NSString that is used as the pattern string. The appropriate displayPatternValueX binding value is substituted for the %{valueX}@ pattern in the display string.

As an example, if displayPatternValue1 evaluates to 22, displayPatternValue2 evaluates to 5 and the Display Pattern string is "%{value2}@ of %{value1}@ rows are selected", the resulting value will be "5 of 22 rows are selected".

If displayPatternValue1 is bound, the value binding is not available.

Availability:
Available in OS X v10.4 and later.
Binding is Read-Only.


Binding Options
OptionBinding option constantValue class
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOption NSNumber (Boolean)
Display PatternNSDisplayPatternBindingOption NSString


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOption NSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOption NSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOption NSString
Null PlaceholderNSNullPlaceholderBindingOption NSString