Back to Devexpress

EditorButton Properties

windowsforms-devexpress-dot-xtraeditors-dot-controls-dot-editorbutton-dot-underscore-properties.md

latest6.3 KB
Original Source

EditorButton Properties

An editor button displayed in a ButtonEdit control or its descendant.

NameDescription
AppearanceProvides access to the button’s appearance settings.
AppearanceDisabledProvides access to the appearance settings applied when the current button is disabled.
AppearanceHoveredProvides access to the appearance settings applied when the mouse pointer passes over the current button.
AppearancePressedProvides access to the appearance settings applied when the current button is clicked.
CaptionGets or sets the caption text of the editor button.
CollectionGets the buttons collection that owns the current button.
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.
DrawBackgroundGets or sets whether a selected EditorButton is highlighted when the mouse interacts with the button.
EnabledGets or sets the Boolean value that determines whether a user can perform actions on the current editor button.
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.
GlyphAlignmentObsolete. Gets or sets the glyph alignment relative to its caption. This property is obsolete. Use the EditorButton.ImageOptions.Location property instead.
ImageGets or sets a custom image to display on the button.
ImageAlignmentObsolete. Gets or sets the alignment of the image displayed within the button. This member is obsolete. Use the EditorButton.ImageOptions.Location property instead.
ImageLocationSpecifies the position of the button’s image relative to the text. This member is obsolete. Use the EditorButton.ImageOptions.Location property instead.
ImageOptionsProvides access to all properties that allow you to assign and customize an icon for this EditorButton.
ImageToTextAlignmentThis member supports the internal infrastructure, and is not intended to be used directly from your code.
ImageToTextIndentThis member supports the internal infrastructure, and is not intended to be used directly from your code.
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).

| | Index | Gets the button’s position within the owning collection. | | IsDefaultButton | Gets or sets whether the button is the default button. | | IsLeft | Gets or sets the location of the button within the current ButtonEdit control. | | Kind | Gets or sets the type of image to display within the button. | | Shortcut | Gets or sets a shortcut used to activate the button’s functionality. | | SuperTip | Gets or sets a SuperToolTip for the current button. | | Tag | Gets or sets a value that identifies the current button. | | ToolTip | Gets or sets the button’s regular tooltip. | | ToolTipAnchor | Gets or sets whether the tooltip is anchored relative to the mouse pointer or the button. | | Visible | Gets or sets the visibility status of the current button. | | Width | Gets or sets the button’s width. |

See Also

EditorButton Class

EditorButton Members

DevExpress.XtraEditors.Controls Namespace