UIBarButtonItem Class

Definition

A button item hosted in either a UIToolbar or a UINavigationBar.

[Foundation.Register("UIBarButtonItem", true)]
public class UIBarButtonItem : UIKit.UIBarItem, IDisposable, UIKit.IUISpringLoadedInteractionSupporting
type UIBarButtonItem = class
    inherit UIBarItem
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface IUISpringLoadedInteractionSupporting
Inheritance
UIBarButtonItem
Derived
Attributes
Implements

Remarks

UIBarButtonItems are special buttons designed to be placed in either a UIToolbar or a UINavigationBar. They show either a title or an image and change their appearance when pressed. UIBarButtonItems can also be set to a number of system provided button styles available in the UIBarButtonSystemItem enumeration.

In iOS 11, the layout strategy for UIBarButtonItem objects changed from autoresizing to constraints. Developers who embed other elements in their UIBarButtonItem objects (such as an embedded UIButton) should explicitly set constraints, as shown in the following example:

var btn = new UIButton();
btn.TranslatesAutoresizingMaskIntoConstraints = false;
btn.WidthAnchor.ConstraintEqualTo(32.0f).Active = true;
btn.HeightAnchor.ConstraintEqualTo(32.0f).Active = true;

var barButtonItem = new UIBarButtonItem(btn);

Constructors

UIBarButtonItem()

Default constructor that initializes a new instance of this class with no parameters.

UIBarButtonItem(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

UIBarButtonItem(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

UIBarButtonItem(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

UIBarButtonItem(String, UIBarButtonItemStyle, EventHandler)

Constructor that allows a title to be specified for display on the button depending on the style used. Also allows an event handler to be specified that will be called when the button is pressed.

UIBarButtonItem(String, UIBarButtonItemStyle, NSObject, Selector)

Constructor that allows specifying a title and style for a UIBarButtonItem along with an Objective-C style target-action pair.

UIBarButtonItem(UIBarButtonSystemItem)

Constructor that allows a particular UIBarButtonSystemItem to be specified when the button is created.

UIBarButtonItem(UIBarButtonSystemItem, EventHandler)

Constructor that allows a particular UIBarButtonSystemItem to be specified when the button is created along with an event handler.

UIBarButtonItem(UIBarButtonSystemItem, NSObject, Selector)

Constructor that allows a system item along with a target-action pair to be specified.

UIBarButtonItem(UIImage, UIBarButtonItemStyle, EventHandler)

Constructor that allows a custom image, style and evnet handler to be specied when the button is created.

UIBarButtonItem(UIImage, UIBarButtonItemStyle, NSObject, Selector)

Constructor that allows an image and style to be specified, along with a target-action pair.

UIBarButtonItem(UIImage, UIImage, UIBarButtonItemStyle, NSObject, Selector)

Constructor that allows specifying separate images for landscape and portrait.

UIBarButtonItem(UIView)

Constructor that allows a custom view to be specified for a UIBarButtonItem.

Properties

AccessibilityActivationPoint

Gets or sets the screen coordinates of the activation point for this IUIAccessibilityIdentification element.

(Inherited from UIBarItem)
AccessibilityAttributedHint (Inherited from UIBarItem)
AccessibilityAttributedLabel (Inherited from UIBarItem)
AccessibilityAttributedValue (Inherited from UIBarItem)
AccessibilityElementsHidden

Gets or sets whether accessibility elements contained in this IUIAccessibilityIdentification element are hidden.

(Inherited from UIBarItem)
AccessibilityFrame

Gets or sets the screen coordinates of the frame of this IUIAccessibilityIdentification element.

(Inherited from UIBarItem)
AccessibilityHint

Gets or sets a localized string that describes the result of an action.

(Inherited from UIBarItem)
AccessibilityIdentifier

Gets or sets an identifier that identifies this IUIAccessibilityIdentification element.

(Inherited from UIBarItem)
AccessibilityLabel

Gets or sets a localized string to identify this IUIAccessibilityIdentification element.

(Inherited from UIBarItem)
AccessibilityLanguage

Gets or sets the language for the AccessibilityLabel, AccessibilityValue, and AccessibilityHint of this IUIAccessibilityIdentification element.

(Inherited from UIBarItem)
AccessibilityNavigationStyle

Gets or sets the navigation style.

(Inherited from UIBarItem)
AccessibilityPath

Specifies screen coordinates for the path of an element that is used to highlight the element.

(Inherited from UIBarItem)
AccessibilityTraits

Gets or sets the accessibility traits that best characterize this IUIAccessibilityIdentification element.

(Inherited from UIBarItem)
AccessibilityValue

Specifies a localized string that contains the value of this IUIAccessibilityIdentification element.

(Inherited from UIBarItem)
AccessibilityViewIsModal

Gets or sets whether VoiceOver ignores elements in sibling views of this image object.

(Inherited from UIBarItem)
Action

The action sent to the object specified as the target.

Appearance

Strongly-typed property that returns the UIAppearance class for this class.

ButtonGroup

The UIBarButtonItemGroup, if any, to which this UIBarButtonItem belongs.

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

CustomView

A custom view used to represent the UIBarButtonItem

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Enabled

Allows control over whether a UIBarButtonItem is enabled or disabled.

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
Image

The button's image.

ImageInsets

Insets the button image.

IsAccessibilityElement

Gets or sets whether this item is an accessibility object that an assistive app can access.

(Inherited from UIBarItem)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
LandscapeImagePhone

The image to use to represent the item in landscape when using the iPhone appearance idiom.

(Inherited from UIBarItem)
LandscapeImagePhoneInsets

The inset (or outset) for each edge in landscape orientation when using the iPhone appearance idiom.

(Inherited from UIBarItem)
LargeContentSizeImage

Gets or sets the UIImage to be used for visually impaired users.

(Inherited from UIBarItem)
LargeContentSizeImageInsets

Gets or sets the UIEdgeInsets when displaying the s.

(Inherited from UIBarItem)
PossibleTitles

The set of all possible titles (used as a hint for system sizing).

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self (Inherited from NSObject)
ShouldGroupAccessibilityChildren

Gets or sets whether VoiceOver groups elements that are children of this object regardless of their positions.

(Inherited from UIBarItem)
SpringLoaded

Gets or sets a Boolean value that controls whether the object participates in spring-loaded interactions.

Style

The system style to use for the button.

Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Tag

An integer that can be used to indentify the UIBarButtonItem.

Target

The object that will receive the selector specified in the Action property.

TintColor

The tint color to be used for the button.

Title

The title that is displayed in the button

Width

The width of the button.

Zone (Inherited from NSObject)

Methods

AccessibilityActivate()

Activates accessibility for this UIView, returning true on success.

(Inherited from UIBarItem)
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AppearanceWhenContainedIn(Type[])

Returns a strongly typed UIAppearance for instances of this class when the view is hosted in the specified hierarchy.

AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)
(Inherited from NSObject)
BindingInfo(String)
(Inherited from NSObject)
BindingOptionDescriptions(String)
(Inherited from NSObject)
BindingValueClass(String)
(Inherited from NSObject)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the UIBarButtonItem object.

DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
GetAppearance(UITraitCollection)

Returns an appearance proxy for the specified traits.

GetAppearance(UITraitCollection, Type[])

Returns an appearance proxy for the specified traits when found in the containers containment hierarchy.

GetAppearance<T>()

Obtains the appearance proxy UIBarButtonItem.UIBarButtonItemAppearance for the subclass of UIBarButtonItem.

GetAppearance<T>(UITraitCollection)

Obtains the appearance proxy UIBarButtonItem.UIBarButtonItemAppearance for the subclass of UIBarButtonItem.

GetAppearance<T>(UITraitCollection, Type[])

Obtains the appearance proxy UIBarButtonItem.UIBarButtonItemAppearance for the subclass of UIBarButtonItem that has the specified trait collection when the view is hosted in the specified hierarchy.

GetBackButtonBackgroundImage(UIControlState, UIBarMetrics)

Back button background image for a given control state. Only used for a UINavigationBar back button.

GetBackButtonBackgroundVerticalPositionAdjustment(UIBarMetrics)

The back button vertical position offset.

GetBackButtonTitlePositionAdjustment(UIBarMetrics)

The back button title offset.

GetBackgroundImage(UIControlState, UIBarButtonItemStyle, UIBarMetrics)

The UIImage used as a background by the UIBarButtonItem.

GetBackgroundImage(UIControlState, UIBarMetrics)

The background image for the button.

GetBackgroundVerticalPositionAdjustment(UIBarMetrics)

The vertical offset of the background image.

GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String)
(Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetTitlePositionAdjustment(UIBarMetrics)

Title offset for specified bar metrics..

GetTitleTextAttributes(UIControlState)

The text attributes of the title of the UIBarItem.

(Inherited from UIBarItem)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetBackButtonBackgroundImage(UIImage, UIControlState, UIBarMetrics)

Allows the button's background image to be set.

SetBackButtonBackgroundVerticalPositionAdjustment(nfloat, UIBarMetrics)
SetBackButtonTitlePositionAdjustment(UIOffset, UIBarMetrics)

Allows the offset of the back button title to be specified for a given control state and bar metrics.

SetBackgroundImage(UIImage, UIControlState, UIBarButtonItemStyle, UIBarMetrics)

Specifies the UIImage used as a background.

SetBackgroundImage(UIImage, UIControlState, UIBarMetrics)

Allows the background image to be set for the button for a given control state and bar metrics.

SetBackgroundVerticalPositionAdjustment(nfloat, UIBarMetrics)
SetNativeField(String, NSObject)
(Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetTitlePositionAdjustment(UIOffset, UIBarMetrics)

Allows the title to be offset for a specified bar metrics.

SetTitleTextAttributes(UITextAttributes, UIControlState)

Specifies the text attributes of the title of the UIBarItem.

(Inherited from UIBarItem)
SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String)
(Inherited from NSObject)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Events

Clicked

This event is raised when the user clicks/taps on this UIBarButtonItem.

Extension Methods

GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also