An item on a pasteboard.
SDK
- macOS 10.6+
Framework
- App
Kit
Declaration
@interface NSPasteboardItem : NSObject
Overview
There are three main uses for an NSPasteboard
object:
Providing data on the pasteboard.
You can create one or more pasteboard items, set data or data providers for types, and write to them pasteboard.
Customizing data already on the pasteboard.
As a delegate or subclass, you can retrieve the pasteboard items currently on the pasteboard, read the existing types and data and set new data and data providers for types as needed.
Retrieving data from the pasteboard.
You can retrieve pasteboard items from the pasteboard then read the data for types you’re interested in.
A pasteboard item can be associated with a single pasteboard. When you create an item, it can be written to any pasteboard. When you pass an item to a pasteboard in write
, that item becomes bound to the pasteboard it was written to. When you retrieve items from a pasteboard using pasteboard
or read
, the returned items are associated with the messaged pasteboard. Passing an item that is already associated with a pasteboard into write
causes an exception to be raised.
Pasteboard items are intended to be used during a single pasteboard interaction, not held onto and used repeatedly. A pasteboard item is only valid until the owner of the pasteboard changes.
Important
If a pasteboard item is stale because the pasteboard owner has changed, it returns nil
or NO
values from its methods.