Back to Devexpress

CustomHeaderButton Properties

windowsforms-devexpress-dot-xtratab-dot-buttons-dot-customheaderbutton-dot-underscore-properties.md

latest8.4 KB
Original Source

CustomHeaderButton Properties

A custom header button for tab controls.

NameDescription
AppearanceProvides access to the button’s appearance settings. Inherited from EditorButton.
AppearanceDisabledProvides access to the appearance settings applied when the current button is disabled. Inherited from EditorButton.
AppearanceHoveredProvides access to the appearance settings applied when the mouse pointer passes over the current button. Inherited from EditorButton.
AppearancePressedProvides access to the appearance settings applied when the current button is clicked. Inherited from EditorButton.
CaptionGets or sets the caption text of the editor button. Inherited from EditorButton.
CollectionGets a collection that owns the custom header button.
CommandGets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. Inherited from EditorButton.
CommandParameterGets or sets the parameter that is passed to the command specified by the Command property. Inherited from EditorButton.
DrawBackgroundGets or sets whether a selected EditorButton is highlighted when the mouse interacts with the button. Inherited from EditorButton.
EnabledGets or sets the Boolean value that determines whether a user can perform actions on the current editor button. Inherited from EditorButton.
EnableImageTransparencyGets or sets whether specific colors in the button’s image are transparent, when displayed. This property is obsolete. Use the EditorButton.ImageOptions.EnableTransparency property instead. Inherited from EditorButton.
GlyphAlignmentObsolete. Gets or sets the glyph alignment relative to its caption. This property is obsolete. Use the EditorButton.ImageOptions.Location property instead. Inherited from EditorButton.
ImageGets or sets a custom image to display on the button. Inherited from EditorButton.
ImageAlignmentObsolete. Gets or sets the alignment of the image displayed within the button. This member is obsolete. Use the EditorButton.ImageOptions.Location property instead. Inherited from EditorButton.
ImageLocationSpecifies the position of the button’s image relative to the text. This member is obsolete. Use the EditorButton.ImageOptions.Location property instead. Inherited from EditorButton.
ImageOptionsProvides access to all properties that allow you to assign and customize an icon for this EditorButton. Inherited from EditorButton.
ImageToTextAlignmentThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorButton.
ImageToTextIndentThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorButton.
ImageUri

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

Inherited from EditorButton. | | Index | Gets a custom header button’s index within the collection. | | IsDefaultButton | Gets or sets whether the button is the default button. Inherited from EditorButton. | | IsLeft | The property is not supported. | | Kind | Gets or sets the type of image to display within the button. Inherited from EditorButton. | | Shortcut | The property is not supported. | | SuperTip | Gets or sets a SuperToolTip for the current button. Inherited from EditorButton. | | Tag | Gets or sets a value that identifies the current button. Inherited from EditorButton. | | ToolTip | Gets or sets the button’s regular tooltip. Inherited from EditorButton. | | ToolTipAnchor | Gets or sets whether the tooltip is anchored relative to the mouse pointer or the button. Inherited from EditorButton. | | Visible | Gets or sets the visibility status of the current button. Inherited from EditorButton. | | Width | Gets or sets the button’s width. Inherited from EditorButton. |

See Also

CustomHeaderButton Class

CustomHeaderButton Members

DevExpress.XtraTab.Buttons Namespace