UIBarItem Class

Reference

Definition

Namespace:: UIKit

Assembly:: Xamarin.iOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base class for items added to the bars at the bottom of the screen.

[Foundation.Register("UIBarItem", true)]
public abstract class UIBarItem : Foundation.NSObject, Foundation.INSCoding, IDisposable, UIKit.IUIAccessibilityIdentification, UIKit.IUIAppearance

type UIBarItem = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface IUIAccessibilityIdentification
    interface IUIAppearance

Inheritance: Object

NSObject
UIBarItem

Derived: UIKit.UIBarButtonItem

UIKit.UITabBarItem

Attributes: RegisterAttribute

Implements: INSCoding INativeObject IDisposable IUIAccessibilityIdentification IUIAppearance

Remarks

Items that appear in the bar at the bottom of the screen act like UIButtons.

Constructors

UIBarItem()	Default constructor that initializes a new instance of this class with no parameters.
UIBarItem(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
UIBarItem(NSCoder)	A constructor that initializes the object from the data stored in the unarchiver object.
UIBarItem(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AccessibilityActivationPoint	Gets or sets the screen coordinates of the activation point for `this` IUIAccessibilityIdentification element.
AccessibilityAttributedHint
AccessibilityAttributedLabel
AccessibilityAttributedValue
AccessibilityElementsHidden	Gets or sets whether accessibility elements contained in `this` IUIAccessibilityIdentification element are hidden.
AccessibilityFrame	Gets or sets the screen coordinates of the frame of `this` IUIAccessibilityIdentification element.
AccessibilityHint	Gets or sets a localized string that describes the result of an action.
AccessibilityIdentifier	Gets or sets an identifier that identifies `this` IUIAccessibilityIdentification element.
AccessibilityLabel	Gets or sets a localized string to identify `this` IUIAccessibilityIdentification element.
AccessibilityLanguage	Gets or sets the language for the AccessibilityLabel, AccessibilityValue, and AccessibilityHint of `this` IUIAccessibilityIdentification element.
AccessibilityNavigationStyle	Gets or sets the navigation style.
AccessibilityPath	Specifies screen coordinates for the path of an element that is used to highlight the element.
AccessibilityTraits	Gets or sets the accessibility traits that best characterize `this` IUIAccessibilityIdentification element.
AccessibilityValue	Specifies a localized string that contains the value of `this` IUIAccessibilityIdentification element.
AccessibilityViewIsModal	Gets or sets whether VoiceOver ignores elements in sibling views of this image object.
AnnouncementDidFinishNotification	Notification constant for AnnouncementDidFinish
AnnouncementNotification	Gets the notification posted by an application that an announcement requires assistive technology.
Appearance	Strongly-typed property that returns the UIAppearance class for this class.
AssistiveTechnologyKey	The string "UIAccessibilityAssistiveTechnologyKey" which can be used to distinguish accessibility notifications.
AssistiveTouchStatusDidChangeNotification	Notification constant for AssistiveTouchStatusDidChange
BoldTextStatusDidChangeNotification	Notification constant for BoldTextStatusDidChange
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
ClosedCaptioningStatusDidChangeNotification	Notification constant for ClosedCaptioningStatusDidChange
DarkerSystemColorsStatusDidChangeNotification	Notification constant for DarkerSystemColorsStatusDidChange
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)
ElementFocusedNotification	Notification constant for ElementFocused
Enabled	Whether this UIBarItem is enabled.
FocusedElementKey	A string constant used by accessibility APIs (see FocusedElement(String)) to identify the focused element.
GrayscaleStatusDidChangeNotification	Notification constant for GrayscaleStatusDidChange
GuidedAccessStatusDidChangeNotification	Notification constant for GuidedAccessStatusDidChange
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
HearingDevicePairedEarDidChangeNotification	Notification constant for HearingDevicePairedEarDidChange
Image	The image used to represent this UIBarItem.
ImageInsets	The inset (or outset) for each edge.
InvertColorsStatusDidChangeNotification	Notification constant for InvertColorsStatusDidChange
IsAccessibilityElement	Gets or sets whether this item is an accessibility object that an assistive app can access.
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.
LandscapeImagePhoneInsets	The inset (or outset) for each edge in landscape orientation when using the iPhone appearance idiom.
LargeContentSizeImage	Gets or sets the UIImage to be used for visually impaired users.
LargeContentSizeImageInsets	Gets or sets the UIEdgeInsets when displaying the s.
LayoutChangedNotification	Gets the notification posted by an application that the layout of a screen has changed.
MonoAudioStatusDidChangeNotification	Notification constant for MonoAudioStatusDidChange
NotificationSwitchControlIdentifier	Notification constant for NotificationSwitchContr
NotificationVoiceOverIdentifier	Notification constant for NotificationVoiceOv
PageScrolledNotification	Gets the notification posted by an application that a scroll action has finished.
PauseAssistiveTechnologyNotification	Pauses assistive technology notifications.
ReduceMotionStatusDidChangeNotification	Notification constant for ReduceMotionStatusDidChange
ReduceTransparencyStatusDidChangeNotification	Notification constant for ReduceTransparencyStatusDidChange
ResumeAssistiveTechnologyNotification	Resumes assistive technology notifications.
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
ScreenChangedNotification	Gets the notification posted by an application that a new view appears that includes a major portion of the screen.
Self	(Inherited from NSObject)
ShakeToUndoDidChangeNotification	Notification constant for ShakeToUndoDidChange
ShouldGroupAccessibilityChildren	Gets or sets whether VoiceOver groups elements that are children of this object regardless of their positions.
SpeakScreenStatusDidChangeNotification	Notification constant for SpeakScreenStatusDidChange
SpeakSelectionStatusDidChangeNotification	Notification constant for SpeakSelectionStatusDidChange
SpeechAttributeIpaNotation
SpeechAttributeLanguage	Gets a BCP-47 language code.
SpeechAttributePitch	Gets the value from 0.0 to 2.0 that determines the pitch for a spoken string.
SpeechAttributePunctuation	Gets a value to be interpreted as a `bool` that determines whether the punctuation in a string is pronounced.
SpeechAttributeQueueAnnouncement
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
SwitchControlStatusDidChangeNotification	Notification constant for SwitchControlStatusDidChange
Tag	A developer-meaningful integer that can be used to identify specific UIBarItem's within the application.
TextAttributeCustom
TextAttributeHeadingLevel
Title	The title displayed on this UIBarItem.
TraitAdjustable	Gets a trait that allows continuous adjustment of an accessibility element through a range of values.
TraitAllowsDirectInteraction	Gets a trait that allows direct touch interaction for users.
TraitButton	Gets a trait that indicates that `this` IUIAccessibilityIdentification element should be treated as a button.
TraitCausesPageTurn	Gets a trait that indicates that `this` IUIAccessibilityIdentification element should turn the page when VoiceOver finishes that page.
TraitHeader	Gets a trait that indicates that `this` IUIAccessibilityIdentification element is a header that divides content into sections.
TraitImage	Gets a trait that indicates that `this` IUIAccessibilityIdentification element should be treated as an image.
TraitKeyboardKey	Gets a trait that indicates that `this` IUIAccessibilityIdentification element acts like a keyboard key.
TraitLink	Gets a trait that indicates that `this` IUIAccessibilityIdentification element should be considered a link.
TraitNone	Gets a trait that indicates that `this` IUIAccessibilityIdentification element has no traits.
TraitNotEnabled	Gets a trait that indicates that `this` IUIAccessibilityIdentification element is not enabled.
TraitPlaysSound	Gets a trait that indicates that `this` IUIAccessibilityIdentification elements plays its own sound when activated.
TraitSearchField	Gets a trait that indicates that `this` IUIAccessibilityIdentification element should be considered a search field.
TraitSelected	Gets a trait that indicates that `this` IUIAccessibilityIdentification element is selected.
TraitStartsMediaSession	Gets a trait that indicates that `this` IUIAccessibilityIdentification element starts a media session when it is activated.
TraitStaticText	Gets a trait that indicates that `this` IUIAccessibilityIdentification element should be treated as static text.
TraitSummaryElement	Gets a trait that provides summary information when an application starts.
TraitTabBar
TraitUpdatesFrequently	Gets a trait that indicates that `this` IUIAccessibilityIdentification element updates its AccessibilityLabel or AccessibilityValue.
UnfocusedElementKey	A string constant used by accessibility APIs (see FocusedElement(String)) to identify the previously focused element.
VoiceOverStatusChanged	Developers should not use this deprecated property. Developers should use 'VoiceOverStatusDidChangeNotification' instead.
VoiceOverStatusDidChangeNotification	Notification constant for VoiceOverStatusDidChange
Zone	(Inherited from NSObject)

Methods

AccessibilityActivate()	Activates accessibility for this UIView, returning `true` on success.
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)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (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 NSObject object. (Inherited from NSObject)
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, Type[])	Returns an appearance proxy for the specified `traits`.
GetAppearance(UITraitCollection)	Returns an appearance proxy for the specified `traits`.
GetAppearance<T>()	Obtains the appearance proxy UIBarItem.UIBarItemAppearance for the subclass of UIBarItem.
GetAppearance<T>(UITraitCollection, Type[])	Obtains the appearance proxy UIBarItem.UIBarItemAppearance for the subclass of UIBarItem that has the specified trait collection when the view is hosted in the specified hierarchy.
GetAppearance<T>(UITraitCollection)	Obtains the appearance proxy UIBarItem.UIBarItemAppearance for the subclass of UIBarItem.
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)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GetTitleTextAttributes(UIControlState)	The text attributes of the title of the UIBarItem.
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(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, NSObject, Double, NSString[])	(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, 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)
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, NSString)	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)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetTitleTextAttributes(UITextAttributes, UIControlState)	Specifies the text attributes of the title of the 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)	Obsolete. (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)

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

Share via