An object you use to customize the behavior of people-picker views in an app's user interface.
SDK
- macOS 10.3+
Framework
- Address
Book
Declaration
class ABPeoplePickerView : NSView
ClassABPeople
ABPeople
Topics
Working with Properties in the Record List
func addAdds a property to the group of properties whose values are shown in the record list.
func columnReturns the title of a custom property.
var displayedThe property currently displayed in the record list.
func properties() -> [Any]!Returns an array of the properties whose values are shown in the record list.
func removeRemoves a property from the group of properties whose values are shown in the record list.
func setSets the title displayed in the people picker for a property.
Specifying Selection Behavior
var valueThe current selection behavior.
struct ABPeopleConstants indicating the possible value selection behaviors.
Selecting Groups and Records
var allowsA Boolean value that specifies whether the user can select entire groups in the group column.
var allowsA Boolean value that specifies whether multiple groups, records, or values of multivalue properties can be selected at a time.
func deselectDeselects all selected groups, records, and values in multivalue properties.
func deselect(ABGroup!)Deselects a group selected in the group list.
func deselectDeselects a value selected in a multivalue property.
func deselect(ABRecord!)Deselects a record selected in the record list.
var selectedThe groups selected in the group list. (read-only)
func selectedReturns the identifiers of the selected values in a multivalue property.
var selectedThe selection in the records list. (read-only)
func selectedReturns an array of all the values selected in the displayed multivalue property.
func select(ABGroup!, bySelects a group or a set of groups in the group list.
func selectSelects a value or a set of values in a multivalue property.
func select(ABRecord!, bySelects a record or a set of records in the record list.
Specifying the Accessory View
var accessoryThe view that is placed to the left of the search field.
Managing Actions
func clearClears the search field and resets the list of displayed records.
func editLaunches Address Book to edit the item selected in the people picker.
var groupThe action to be invoked when a group is double-clicked.
var nameThe action to be invoked when a name is double-clicked.
func selectLaunches Address Book and selects the item selected in the people picker.
var target: AnyThe target for double-click actions.
Managing Persistent User Settings
var autosaveThe name under which the column positions and the filter selection are saved.
Notifications
static let ABPeoplePosted when the selection in the group list is changed.
static let ABPeoplePosted when the selection in the name list is changed.
static let ABPeoplePosted when the selection in a multivalue property is changed.
static let ABPeoplePosted when the displayed property in the record list is changed.
Relationships
Inherits From
See Also
Pickers
class ABPersonAn object that provides a view for displaying and editing contacts.