UIBarButtonItem Class

Definition

Namespace:

UIKit

Assembly:

Microsoft.iOS.dll

[Foundation.Register("UIBarButtonItem", true)]
public class UIBarButtonItem : UIKit.UIBarItem, IDisposable, UIKit.IUIPopoverPresentationControllerSourceItem, UIKit.IUISpringLoadedInteractionSupporting

[<Foundation.Register("UIBarButtonItem", true)>]
type UIBarButtonItem = class
    inherit UIBarItem
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface IUIPopoverPresentationControllerSourceItem
    interface IUISpringLoadedInteractionSupporting

Inheritance

Object

NSObject

UIBarItem

UIBarButtonItem

Derived

MapKit.MKUserTrackingBarButtonItem

Attributes

RegisterAttribute

Implements

INSCoding INativeObject IDisposable IUIPopoverPresentationControllerSourceItem IUISpringLoadedInteractionSupporting

Constructors

Name	Description
UIBarButtonItem()	Creates a new UIBarButtonItem with default values.
UIBarButtonItem(NativeHandle)	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)
UIBarButtonItem(String, UIImage, NSObject, Selector, UIMenu)
UIBarButtonItem(String, UIMenu)
UIBarButtonItem(UIAction, UIMenu)
UIBarButtonItem(UIAction)
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)
UIBarButtonItem(UIBarButtonSystemItem, UIAction, UIMenu)
UIBarButtonItem(UIBarButtonSystemItem, UIAction)
UIBarButtonItem(UIBarButtonSystemItem, UIMenu)
UIBarButtonItem(UIBarButtonSystemItem)	Constructor that allows a particular UIBarButtonSystemItem to be specified when the button is created.
UIBarButtonItem(UIImage, UIBarButtonItemStyle, EventHandler)	Constructor that allows a custom image, style and event handler to be specied when the button is created.
UIBarButtonItem(UIImage, UIBarButtonItemStyle, NSObject, Selector)
UIBarButtonItem(UIImage, UIImage, UIBarButtonItemStyle, NSObject, Selector)
UIBarButtonItem(UIImage, UIMenu)
UIBarButtonItem(UIView)

Properties

Name	Description
AccessibilityActivationPoint	(Inherited from UIBarItem)
AccessibilityAttributedHint	(Inherited from UIBarItem)
AccessibilityAttributedLabel	(Inherited from UIBarItem)
AccessibilityAttributedUserInputLabels	(Inherited from UIBarItem)
AccessibilityAttributedValue	(Inherited from UIBarItem)
AccessibilityDirectTouchOptions	(Inherited from UIBarItem)
AccessibilityElementsHidden	(Inherited from UIBarItem)
AccessibilityExpandedStatus	(Inherited from UIBarItem)
AccessibilityFrame	(Inherited from UIBarItem)
AccessibilityHint	(Inherited from UIBarItem)
AccessibilityIdentifier	Uniquely identifies this for the purposes of accessibility. (Inherited from UIBarItem)
AccessibilityLabel	(Inherited from UIBarItem)
AccessibilityLanguage	(Inherited from UIBarItem)
AccessibilityNavigationStyle	(Inherited from UIBarItem)
AccessibilityPath	(Inherited from UIBarItem)
AccessibilityRespondsToUserInteraction	(Inherited from UIBarItem)
AccessibilityTextualContext	(Inherited from UIBarItem)
AccessibilityTraits	(Inherited from UIBarItem)
AccessibilityUserInputLabels	(Inherited from UIBarItem)
AccessibilityValue	(Inherited from UIBarItem)
AccessibilityViewIsModal	(Inherited from UIBarItem)
Action
Appearance	Strongly-typed property that returns the UIAppearance class for this class.
Badge
ButtonGroup
ChangesSelectionAsPrimaryAction
Class	(Inherited from NSObject)
ClassHandle	The Objective-C class handle for this class.
CreatingFixedGroup
CustomView
DebugDescription	(Inherited from NSObject)
Description	(Inherited from NSObject)
Enabled	Allows control over whether a UIBarButtonItem is enabled or disabled.
FlexibleSpaceItem
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
Hidden
HidesSharedBackground
Identifier
Image
ImageInsets
IsAccessibilityElement	(Inherited from UIBarItem)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
LandscapeImagePhone	(Inherited from UIBarItem)
LandscapeImagePhoneInsets	(Inherited from UIBarItem)
LargeContentSizeImage	(Inherited from UIBarItem)
LargeContentSizeImageInsets	(Inherited from UIBarItem)
Menu
MenuRepresentation
PossibleTitles
PreferredMenuElementOrder
PrimaryAction
RetainCount	(Inherited from NSObject)
Selected
Self	(Inherited from NSObject)
SharesBackground
ShouldGroupAccessibilityChildren	(Inherited from UIBarItem)
SpringLoaded	Gets or sets a Boolean value that controls whether the object participates in spring-loaded interactions.
Style
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
SymbolAnimationEnabled
Tag
Target
TintColor	The color used for tinting.
Title
Width
Zone	(Inherited from NSObject)

Methods

Name	Description
AccessibilityActivate()	(Inherited from UIBarItem)
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	(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)
AddSymbolEffect(NSSymbolEffect, NSSymbolEffectOptions, Boolean)
AddSymbolEffect(NSSymbolEffect, NSSymbolEffectOptions)
AddSymbolEffect(NSSymbolEffect)
AppearanceWhenContainedIn(Type[])	Returns a strongly typed UIAppearance for instances of this class when the view is hosted in the specified hierarchy.
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)
ConformsToProtocol(NativeHandle)	(Inherited from NSObject)
Copy()	(Inherited from NSObject)
CreateFixedSpaceItem()
CreatingMovableGroup(String)
CreatingOptionalGroup(String, Boolean)
DangerousAutorelease()	Calls the 'autorelease' selector on this object. (Inherited from NSObject)
DangerousRelease()	Calls the 'release' selector on this object. (Inherited from NSObject)
DangerousRetain()	Calls the 'retain' selector on this object. (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	(Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)
DoesNotRecognizeSelector(Selector)	(Inherited from NSObject)
EncodeTo(NSCoder)	Encodes the state of the object using the provided encoder.
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
GetAppearance(UITraitCollection, Type[])	Obtains the appearance proxy UIBarButtonItem.UIBarButtonItemAppearance for UIBarButtonItem.
GetAppearance(UITraitCollection)	Obtains the appearance proxy UIBarButtonItem.UIBarButtonItemAppearance for UIBarButtonItem.
GetAppearance<T>()	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.
GetAppearance<T>(UITraitCollection)	Obtains the appearance proxy UIBarButtonItem.UIBarButtonItemAppearance for the subclass of UIBarButtonItem.
GetBackButtonBackgroundImage(UIControlState, UIBarMetrics)	The background image used for the back button.
GetBackButtonBackgroundVerticalPositionAdjustment(UIBarMetrics)	The back button's vertical position offset for the specified UIBarMetrics.
GetBackButtonTitlePositionAdjustment(UIBarMetrics)	The back button's title's position adjustment for the specified UIBarMetrics.
GetBackgroundImage(UIControlState, UIBarButtonItemStyle, UIBarMetrics)	The background image for the specified UIControlState, UIBarButtonItemStyle, and UIBarMetrics.
GetBackgroundImage(UIControlState, UIBarMetrics)	The background image for the specified UIControlState and UIBarMetrics.
GetBackgroundVerticalPositionAdjustment(UIBarMetrics)	The background's vertical position adjustment for the specified UIBarMetrics.
GetDictionaryOfValuesFromKeys(NSString[])	(Inherited from NSObject)
GetFixedSpaceItem(NFloat)
GetFrame(UIView)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GetTitlePositionAdjustment(UIBarMetrics)	The title's position adjustment for the specified UIBarMetrics.
GetTitleTextAttributes(UIControlState)	The text attributes of the title of the UIBarItem. (Inherited from UIBarItem)
Init()	(Inherited from NSObject)
InitializeHandle(NativeHandle, String)	(Inherited from NSObject)
InitializeHandle(NativeHandle)	(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()	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveAllSymbolEffects()
RemoveAllSymbolEffects(NSSymbolEffectOptions, Boolean)
RemoveAllSymbolEffects(NSSymbolEffectOptions)
RemoveObserver(NSObject, NSString, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, String)	(Inherited from NSObject)
RemoveSymbolEffect(NSSymbolEffect, NSSymbolEffectOptions, Boolean)
RemoveSymbolEffect(NSSymbolEffect, NSSymbolEffectOptions)
RemoveSymbolEffect(NSSymbolEffect)
RespondsToSelector(Selector)	(Inherited from NSObject)
SetBackButtonBackgroundImage(UIImage, UIControlState, UIBarMetrics)	Specifies the UIImage to be used as a background for the specified UIControlState and UIBarMetrics.
SetBackButtonBackgroundVerticalPositionAdjustment(NFloat, UIBarMetrics)
SetBackButtonTitlePositionAdjustment(UIOffset, UIBarMetrics)	Specifies the back button's title's position adjustment for the specified UIBarMetrics.
SetBackgroundImage(UIImage, UIControlState, UIBarButtonItemStyle, UIBarMetrics)	Specifies the background image to use for the specified UIControlState, UIBarButtonItemStyle, and UIBarMetrics.
SetBackgroundImage(UIImage, UIControlState, UIBarMetrics)	Specifies the background UIImage to use for the specified UIControlState and UIBarMetrics.
SetBackgroundVerticalPositionAdjustment(NFloat, UIBarMetrics)
SetNilValueForKey(NSString)	(Inherited from NSObject)
SetSymbolImage(UIImage, NSSymbolContentTransition, NSSymbolEffectOptions)
SetSymbolImage(UIImage, NSSymbolContentTransition)
SetTitlePositionAdjustment(UIOffset, UIBarMetrics)	Specifies the adjustment of the title's position for the specified UIBarMetrics.
SetTitleTextAttributes(UIStringAttributes, UIControlState)	Specifies the text attributes of the title of the UIBarItem. (Inherited from UIBarItem)
SetValueForKey(NSObject, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NativeHandle, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	(Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
ValueForKey(NSString)	(Inherited from NSObject)
ValueForKeyPath(NSString)	(Inherited from NSObject)
ValueForUndefinedKey(NSString)	(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	(Inherited from NSObject)

Events

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

Extension Methods

Name	Description
BrowserAccessibilityDeleteTextAtCursor(NSObject, IntPtr)
BrowserAccessibilityInsertTextAtCursor(NSObject, String)
GetAccessibilityLineEndPositionFromCurrentSelection(NSObject)
GetAccessibilityLineRangeForPosition(NSObject, IntPtr)
GetAccessibilityLineStartPositionFromCurrentSelection(NSObject)
GetBrowserAccessibilityAttributedValue(NSObject, NSRange)
GetBrowserAccessibilityContainerType(NSObject)
GetBrowserAccessibilityCurrentStatus(NSObject)
GetBrowserAccessibilityHasDomFocus(NSObject)
GetBrowserAccessibilityIsRequired(NSObject)
GetBrowserAccessibilityPressedState(NSObject)
GetBrowserAccessibilityRoleDescription(NSObject)
GetBrowserAccessibilitySelectedTextRange(NSObject)
GetBrowserAccessibilitySortDirection(NSObject)
GetBrowserAccessibilityValue(NSObject, NSRange)
SetBrowserAccessibilityContainerType(NSObject, BEAccessibilityContainerType)
SetBrowserAccessibilityCurrentStatus(NSObject, String)
SetBrowserAccessibilityHasDomFocus(NSObject, Boolean)
SetBrowserAccessibilityIsRequired(NSObject, Boolean)
SetBrowserAccessibilityPressedState(NSObject, BEAccessibilityPressedState)
SetBrowserAccessibilityRoleDescription(NSObject, String)
SetBrowserAccessibilitySelectedTextRange(NSObject, NSRange)
SetBrowserAccessibilitySortDirection(NSObject, String)
ProvideImageData(NSObject, IntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
ProvideImageToMTLTexture(NSObject, IMTLTexture, IMTLCommandBuffer, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
SetSharedObservers(NSObject, NSKeyValueSharedObserversSnapshot)
GetDebugDescription(INSObjectProtocol)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
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.
AccessibilityHitTest(NSObject, CGPoint, UIEvent)
GetAccessibilityNextTextNavigationElement(NSObject)
GetAccessibilityNextTextNavigationElementBlock(NSObject)
GetAccessibilityPreviousTextNavigationElement(NSObject)
GetAccessibilityPreviousTextNavigationElementBlock(NSObject)
SetAccessibilityNextTextNavigationElement(NSObject, NSObject)
SetAccessibilityNextTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
SetAccessibilityPreviousTextNavigationElement(NSObject, NSObject)
SetAccessibilityPreviousTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
GetAccessibilityTextInputResponder(NSObject)
GetAccessibilityTextInputResponderHandler(NSObject)
SetAccessibilityTextInputResponder(NSObject, IUITextInput)
SetAccessibilityTextInputResponderHandler(NSObject, UITextInputReturnHandler)
GetFrame(IUIPopoverPresentationControllerSourceItem, UIView)