Displays an options menu and anchors it to the specified bar button item.
SDKs
- iOS 3.2+
- Mac Catalyst 13.0+
Framework
- UIKit
Declaration
func presentOptionsMenu(from item: UIBar Button Item, animated: Bool) -> Bool
Parameters
item
The bar button item to which to anchor the menu.
animated
Specify
true
to animate the appearance of the menu orfalse
to display it immediately.
Return Value
true
if the options menu was displayed or false
if it was not. The options menu may not be displayed in cases where there are no appropriate items to include in the menu.
Discussion
The contents of the options menu are built dynamically based on three things:
The type of the document (as specified by the
uti
property)The set of installed apps that have registered support for opening documents
The actions that you have indicated as supported in the document interaction controller delegate’s
document
methodInteraction Controller: can Perform Action:
Options that cannot be performed on the current document are not included in the menu. For example, if the document cannot be opened by any known apps, the menu does not include options for opening it.
This method displays the options menu asynchronously. The document interaction controller dismisses the menu automatically when the user selects an appropriate option. You can also dismiss it programmatically using the dismiss
method.
To instead present a menu that contains only a list of apps capable of opening the current document, the present
method instead.