< Previous PageNext Page > Hide TOC

NSSearchField Bindings

Related class
Availability
Available in Mac OS X v10.3 and later.

Contents:

Availability Bindings
Font Bindings
Parameters Bindings
Search Bindings
Text Color Bindings
Value Bindings


Availability Bindings

editable

A multiple-value binding that determines if the NSSearchField 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 NSSearchField are editable if a logical AND operation on all the editable bindings results in a Boolean value of YES.

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


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOptionNSNumber (Boolean) or NSNull

enabled

A multiple-value binding that determines if the NSSearchField 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 NSSearchField is enabled if a logical AND operation on all the enabled bindings results in a Boolean value of YES.

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


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOptionNSNumber (Boolean) or NSNull

hidden

A multiple-value binding that determines if the NSSearchField 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 NSSearchField is hidden if a logical OR operation on all the hidden bindings results in a Boolean value of YES.

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


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOptionNSNumber (Boolean) or NSNull

Font Bindings

font

An NSFont used to display the NSSearchField.

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

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


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

fontBold

A Boolean value that determines if the NSFont used to display the NSSearchField 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 Mac OS X v10.3 and later.
Binding is Read-Only.


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOptionNSNumber (Boolean) or NSNull

fontFamilyName

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

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

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


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSString
Null PlaceholderNSNullPlaceholderBindingOptionNSString

fontItalic

A Boolean value that determines if the NSFont used to display the NSSearchField 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 Mac OS X v10.3 and later.
Binding is Read-Only.


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSNumber (Boolean) or NSNull
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSNumber (Boolean) or NSNull
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSNumber (Boolean) or NSNull
Null PlaceholderNSNullPlaceholderBindingOptionNSNumber (Boolean) or NSNull

fontName

An NSString that specifies the full name of the NSFont that is used to display the contents of the NSSearchField. 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 Mac OS X v10.3 and later.
Binding is Read-Only.


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSString
Null PlaceholderNSNullPlaceholderBindingOptionNSString

fontSize

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

If fontSize is bound, the font binding is disabled.

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


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSNumber
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSNumber
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSNumber
Null PlaceholderNSNullPlaceholderBindingOptionNSNumber

Parameters Bindings

alignment

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

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 Mac OS X v10.3 and later.
Binding is Read-Only.


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSNumber
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSNumber
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSNumber
Null PlaceholderNSNullPlaceholderBindingOptionNSNumber

toolTip

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

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


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


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSString
Null PlaceholderNSNullPlaceholderBindingOptionNSString

Search Bindings

predicate

The multiple-value predicate binding allows you to create a search field pop-up menu that is pre populated with menu items that correspond to predicate filters. Each of the predicate bindings correspond to an entry in the search field pop-up menu. See “Predicate Binding” for further information.

When predicate is bound, a new binding, predicate2, is exposed and can be bound. Binding to predicate2 causes predicate3 to be exposed, and so on.

If predicate is bound, the recentSearches binding is not available.

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


Binding Options
OptionBinding option constantValue class
Always Presents Application Modal Alerts. Available in Mac OS X v10.4 and later.NSAlwaysPresentsApplicationModalAlertsBindingOptionNSNumber (Boolean)
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOptionNSNumber (Boolean)
Validates ImmediatelyNSValidatesImmediatelyBindingOptionNSNumber (Boolean)
Display Name. Available in Mac OS X v10.4 and later.NSDisplayNameBindingOptionNSString
Predicate Format String. Available in Mac OS X v10.4 and later.NSPredicateFormatBindingOptionNSString

recentSearches

An indexed collection containing a list of the recent search strings to be displayed in the menu of the NSSearchField

The indexed collection is an NSArray instance or subclass, or a property that is accessible using the key-value-coding indexed accessor methods.

Availability:
Available in Mac OS X v10.3 and later.


Binding Options
OptionBinding option constantValue class
Always Presents Application Modal Alerts. Available in Mac OS X v10.4 and later.NSAlwaysPresentsApplicationModalAlertsBindingOptionNSNumber (Boolean)
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOptionNSNumber (Boolean)
Validates ImmediatelyNSValidatesImmediatelyBindingOptionNSNumber (Boolean)
Display Name. Available in Mac OS X v10.4 and later.NSDisplayNameBindingOptionNSString
Predicate Format String. Available in Mac OS X v10.4 and later.NSPredicateFormatBindingOptionNSString

Text Color Bindings

textColor

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

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


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

Value Bindings

value

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

Availability:
Available in Mac OS X v10.3 and later.


Binding Options
OptionBinding option constantValue class
Allows Editing Multiple Value SelectionNSAllowsEditingMultipleValuesSelectionBindingOptionNSNumber (Boolean)
Always Presents Application Modal Alerts. Available in Mac OS X v10.4 and later.NSAlwaysPresentsApplicationModalAlertsBindingOptionNSNumber (Boolean)
Conditionally Sets EditableNSConditionallySetsEditableBindingOptionNSNumber (Boolean)
Conditionally Sets EnabledNSConditionallySetsEnabledBindingOptionNSNumber (Boolean)
Conditionally Sets HiddenNSConditionallySetsHiddenBindingOptionNSNumber (Boolean)
Continuously Updates ValueNSContinuouslyUpdatesValueBindingOptionNSNumber (Boolean)
Raises for Not Applicable KeysNSRaisesForNotApplicableKeysBindingOptionNSNumber (Boolean)
Validates ImmediatelyNSValidatesImmediatelyBindingOptionNSNumber (Boolean)


Placeholders
DescriptionPlaceholder constantValue class
Multiple Values PlaceholderNSMultipleValuesPlaceholderBindingOptionNSString
No Selection PlaceholderNSNoSelectionPlaceholderBindingOptionNSString
Not Applicable PlaceholderNSNotApplicablePlaceholderBindingOptionNSString
Null PlaceholderNSNullPlaceholderBindingOptionNSString


< Previous PageNext Page > Hide TOC


© 2004, 2007 Apple Inc. All Rights Reserved. (Last updated: 2007-10-31)


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.