Back to Devexpress

NavBarItem Members

windowsforms-devexpress-dot-xtranavbar-dot-navbaritem-dot-underscore-members.md

latest19.7 KB
Original Source

NavBarItem Members

An item within the NavBarControl control.

Constructors

NameDescription
NavBarItem()Creates an instance of the NavBarItem class.
NavBarItem(String)Initializes a new instance of the NavBarItem class with the specified caption.

Fields

NameDescription
DefaultImageSize staticStores the original size of an image assigned to the LargeImage or SmallImage option accessible in NavElement.ImageOptions. Inherited from NavElement.

Properties

NameDescription
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications.
AccessibleNameGets or sets the object’s name used by accessibility client applications.
AccessibleRoleGets or sets the object’s accessible role.
AllowAutoSelectGets or sets whether auto-selection is enabled for all links of the current NavBarItem. This property is in effect in the LinkSelectionModeType.OneInGroupAndAllowAutoSelect mode.
AllowGlyphSkinningUse the AllowGlyphSkinning option accessible in NavElement.ImageOptions to specify whether the current NavElement‘s icon should be painted in this item’s foreground color. Inherited from NavElement.
AllowHtmlStringGets or sets whether the element’s caption is formatted using HTML tags. Inherited from NavElement.
AppearanceGets the appearance settings used to paint the element. Inherited from NavElement.
AppearanceDisabledGets the appearance settings used to paint the disabled item’s link(s).
AppearanceHotTrackedGets the appearance settings used to paint the current element when it’s hot-tracked. Inherited from NavElement.
AppearancePressedGets the appearance settings used to paint the element when it’s pressed. Inherited from NavElement.
CanDragGets or sets a value specifying whether an item can be dragged.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CaptionGets or sets the element’s caption. Inherited from NavElement.
CollectionGets the collection to which an item belongs.
CommandGets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked.
CommandParameterGets or sets the parameter that is passed to the command specified by the Command property.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EnabledGets or sets a value specifying whether an item responds to user actions.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
HintGets or sets the element’s hint text. Inherited from NavElement.
ImageOptionsProvides access to settings that allow you to set up raster and vector icons for this NavElement. Inherited from NavElement.
ImageUri

Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current NavElement. A specific version of the addressed image is automatically chosen, based on the app context (the current skin and required image size).

Inherited from NavElement. | | LargeImage | Use the LargeImage option accessible in NavElement.ImageOptions to specify the large image displayed within the element. Inherited from NavElement. | | LargeImageIndex | Use the LargeImageIndex option accessible in NavElement.ImageOptions to specify the element’s large image by its index within the source image collection. Inherited from NavElement. | | LargeImages | Gets the source of the large images that can be displayed in the group headers and links. Inherited from NavElement. | | LargeImageSize | Use the LargeImageSize option accessible in NavElement.ImageOptions to get/set the size of the current NavElement‘s large image. Inherited from NavElement. | | Links | Gets the collection of links which refer to the item. | | Name | Gets or sets the item’s name. Inherited from ComponentCollectionItem. | | NavBar | Gets the control to which the element belongs. Inherited from NavElement. | | Site | Gets or sets the ISite of the Component. Inherited from Component. | | SmallImage | Use the SmallImage option accessible in NavElement.ImageOptions to specify the small image displayed within the element. Inherited from NavElement. | | SmallImageIndex | Use the SmallImageIndex option accessible in NavElement.ImageOptions to specify the element’s small image by its index within the source image collection. Inherited from NavElement. | | SmallImages | Gets the source of the small images that can be displayed in the group headers and links. Inherited from NavElement. | | SmallImageSize | Use the SmallImageSize option accessible in NavElement.ImageOptions to get/set the size for the current NavElement‘s small image. Inherited from NavElement. | | StyleDisabledName | Gets or sets the item’s disabled style. | | SuperTip | Gets or sets a super tool-tip for the current NavElement. Inherited from NavElement. | | Tag | Gets or sets data associated with the element. Inherited from NavElement. | | Visible | Gets or sets a value specifying the visibility of the element. Inherited from NavElement. |

Methods

NameDescription
BindCommand(Expression<Action>, Object, Func<Object>)Uses the command selector to find an appropriate parameterized command in the source and bind it to this NavBarItem.
BindCommand(Object, Func<Object>)Binds the specific parameterized command to this NavBarItem.
BindCommand<T>(Expression<Action<T>>, Object, Func<T>)Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this NavBarItem.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose()Releases all resources used by the Component. Inherited from Component.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetPreferredImageSize(Size, Boolean)This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from NavElement.
GetPreferredImageSize(Size)This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from NavElement.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
IsSeparator()Returns a Boolean value that indicates whether the current object is a separator.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ResetSuperTip()Removes the current NavElement‘s super tool-tip. Inherited from NavElement.
ToString()Returns the element’s full name. Inherited from NavElement.

Events

NameDescription
CommandCanExecuteChangedOccurs when the CanExecute(Object) status of the Command has changed.
CommandChangedOccurs after the value of the Command property has changed.
CommandParameterChangedOccurs after the value of the CommandParameter property has changed.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ItemChangedFires when item property values are changed. Inherited from ComponentCollectionItem.
LinkClickedFires immediately after an item has been clicked.
LinkPressedFires immediately after a user pressed the item.

See Also

NavBarItem Class

DevExpress.XtraNavBar Namespace