Mac Developer Library

Developer

Address Book Objective-C Framework Reference for Mac ABPeoplePickerView Class Reference

Options
Deployment Target:

On This Page
Language:

ABPeoplePickerView

The ABPeoplePickerView class allows you to customize the behavior of people-picker views in an application’s user interface.

  • The view that is placed to the left of the search field.

    Declaration

    Swift

    var accessoryView: NSView!

    Objective-C

    @property(nonatomic, retain) NSView *accessoryView

    Discussion

    If accessory is nil, the accessory view is removed.

    Availability

    Available in OS X v10.3 and later.

  • Clears the search field and resets the list of displayed records.

    Declaration

    Swift

    func clearSearchField(_ sender: AnyObject!)

    Objective-C

    - (void)clearSearchField:(id)sender

    Parameters

    sender

    The object sending this message.

    Availability

    Available in OS X v10.3 and later.

  • Launches Address Book to edit the item selected in the people picker.

    Declaration

    Swift

    func editInAddressBook(_ sender: AnyObject!)

    Objective-C

    - (void)editInAddressBook:(id)sender

    Parameters

    sender

    The object sending this message.

    Availability

    Available in OS X v10.3 and later.

  • The action to be invoked when a group is double-clicked.

    Declaration

    Swift

    var groupDoubleAction: Selector

    Objective-C

    @property(nonatomic, assign) SEL groupDoubleAction

    Availability

    Available in OS X v10.3 and later.

  • The action to be invoked when a name is double-clicked.

    Declaration

    Swift

    var nameDoubleAction: Selector

    Objective-C

    @property(nonatomic, assign) SEL nameDoubleAction

    Availability

    Available in OS X v10.3 and later.

  • Launches Address Book and selects the item selected in the people picker.

    Declaration

    Swift

    func selectInAddressBook(_ sender: AnyObject!)

    Objective-C

    - (void)selectInAddressBook:(id)sender

    Parameters

    sender

    The object sending this message.

    Availability

    Available in OS X v10.3 and later.

  • The target for double-click actions.

    Declaration

    Swift

    unowned(unsafe) var target: AnyObject!

    Objective-C

    @property(nonatomic, assign) id target

    Discussion

    The target is the object on which the action specified by groupDoubleAction and nameDoubleAction is invoked.

    Availability

    Available in OS X v10.3 and later.

  • The name under which the column positions and the filter selection are saved.

    Declaration

    Swift

    var autosaveName: String!

    Objective-C

    @property(nonatomic, retain) NSString *autosaveName

    Availability

    Available in OS X v10.3 and later.

  • These constants are of the type Selection Behavior and are used by valueSelectionBehavior.

    Declaration

    Swift

    struct ABPeoplePickerSelectionBehavior : RawRepresentable, Equatable { init(_ rawValue: UInt32) init(rawValue rawValue: UInt32) var rawValue: UInt32 }

    Objective-C

    typedef enum { ABNoValueSelection = 0, ABSingleValueSelection = 1, ABMultipleValueSelection = 2 } ABPeoplePickerSelectionBehavior;

    Constants

    • ABNoValueSelection

      ABNoValueSelection

      The user cannot select individual values.

      Available in OS X v10.3 and later.

    • ABSingleValueSelection

      ABSingleValueSelection

      The user can select a single value.

      Available in OS X v10.3 and later.

    • ABMultipleValueSelection

      ABMultipleValueSelection

      The user can select multiple values.

      Available in OS X v10.3 and later.

    Import Statement

    Objective-C

    @import AddressBook;

    Swift

    import AddressBook

    Availability

    Available in OS X v10.3 and later.