Instance Method

propertyList(forType:)

Returns the property list for the specified type from the first item in the receiver that contains the type.

Declaration

func propertyList(forType dataType: NSPasteboard.PasteboardType) -> Any?

Parameters

dataType

The pasteboard data type containing the property-list data.

Return Value

A property list of objects of the specified type, obtained from the first item in the receiver that contains the type. The returned property list can contain any combination of objects, as long as each object is a valid property-list type (for a list of types, see Property list).

Discussion

This method invokes the data(forType:) method.

Special Considerations

It’s a good idea to check types or call availableType(from:) before invoking propertyList(forType:). Although performing this check isn’t required, doing so can help you determine if a nil result from a reading method is due to something like a pasteboard timeout.

See Also

Reading Data

func readObjects(forClasses: [AnyClass], options: [NSPasteboard.ReadingOptionKey : Any]? = nil) -> [Any]?

Reads from the receiver objects that best match the specified array of classes.

struct NSPasteboard.ReadingOptionKey

These options can be used for both the readObjects(forClasses:options:) and canReadObject(forClasses:options:) methods, unless otherwise specified. The currently available options allow for customization of how URLS are read from the pasteboard.

var pasteboardItems: [NSPasteboardItem]?

An array that contains all the items held by the receiver or nil if there is an error retrieving pasteboard items.

func index(of: NSPasteboardItem) -> Int

Returns the index of the specified pasteboard item.

func data(forType: NSPasteboard.PasteboardType) -> Data?

Returns the data for the specified type from the first item in the receiver that contains the type.

func string(forType: NSPasteboard.PasteboardType) -> String?

Returns a concatenation of the strings for the specified type from all the items in the receiver that contain the type.