EditorButton Members

Represent an individual editor button displayed in a ButtonEdit control or descendant.

Constructors

Name Description
EditorButton() Initializes a new instance of the EditorButton class with default settings.
EditorButton(ButtonPredefines) Initializes a new instance of the ButtonPredefines class with a ButtonPredefines button type.
EditorButton(ButtonPredefines, Image, SuperToolTip) Initializes a new instance of the EditorButton class
EditorButton(ButtonPredefines, String) Initializes a new EditorButton instance with the specified property values.
EditorButton(ButtonPredefines, String, SuperToolTip) Initializes a new instance of the EditorButton class.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image) Initializes a new EditorButton instance with the specified property values.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut) Initializes a new EditorButton instance with the specified property values.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut, AppearanceObject) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut, AppearanceObject, String) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut, AppearanceObject, String, Object) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut, AppearanceObject, String, Object, SuperToolTip) Initializes a new instance of the EditorButton class.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut, AppearanceObject, String, Object, SuperToolTip, Boolean) Initializes a new instance of the EditorButton class.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut, String) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut, String, Object) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, String, KeyShortcut, AppearanceObject, String, Object, SuperToolTip, Boolean) Initializes a new instance of the EditorButton class.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, AppearanceObject) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, AppearanceObject, AppearanceObject, AppearanceObject, AppearanceObject, String, Object, SuperToolTip) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, AppearanceObject, AppearanceObject, AppearanceObject, AppearanceObject, String, Object, SuperToolTip, ToolTipAnchor) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, AppearanceObject, String) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, AppearanceObject, String, Object) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, AppearanceObject, String, Object, SuperToolTip) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, String) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, EditorButtonImageOptions, KeyShortcut, String, Object) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, AppearanceObject) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, AppearanceObject, AppearanceObject, AppearanceObject, AppearanceObject, String, Object, SuperToolTip, Boolean) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, AppearanceObject, String) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, AppearanceObject, String, Object) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, AppearanceObject, String, Object, SuperToolTip) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, AppearanceObject, String, Object, SuperToolTip, Boolean) Initializes a new instance of the EditorButton class.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, String) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, KeyShortcut, String, Object) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, String, KeyShortcut, AppearanceObject, AppearanceObject, AppearanceObject, AppearanceObject, String, Object, SuperToolTip, Boolean) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(EditorButtonImageOptions, ButtonPredefines, SuperToolTip) Initializes a new instance of the EditorButton class with the specified settings.
EditorButton(Object, ButtonPredefines) Initializes a new instance of the EditorButton class with the specified property values.

Properties

Name Description
Appearance Provides access to the button's appearance settings.
AppearanceDisabled Provides access to the appearance settings applied when the current button is disabled.
AppearanceHovered Provides access to the appearance settings applied when the mouse pointer passes over the current button.
AppearancePressed Provides access to the appearance settings applied when the current button is clicked.
Caption Gets or sets the caption text of the editor button.
Collection Gets the buttons collection that owns the current button.
DrawBackground Gets or sets whether a selected EditorButton is highlighted when the mouse interacts with the button.
Enabled Gets or sets the Boolean value that determines whether a user can perform actions on the current editor button.
EnableImageTransparency Gets or sets whether specific colors in the button's image are transparent, when displayed.
GlyphAlignment Obsolete. Gets or sets the glyph alignment relative to its caption.
Image Gets or sets a custom image to display on the button.
ImageAlignment Obsolete. Gets or sets the alignment of the image displayed within the button.
ImageLocation Specifies the position of the button's image relative to the text.
ImageOptions Provides access to all properties that allow you to assign and customize an icon for this EditorButton.
ImageToTextAlignment This member supports the internal infrastructure, and is not intended to be used directly from your code.
ImageToTextIndent This 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.

Methods

Name Description
Assign(EditorButton) Copies all properties of the specified button to the current EditorButton object.
BindCommand(Expression<Action>, Object, Func<Object>) Uses the command selector to find an appropriate parameterized command in the source and bind it to this EditorButton.
BindCommand(Object, Func<Object>) Binds the specific parameterized command to this EditorButton.
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 EditorButton.
Dispose() Releases all unmanaged resources used by an EditorButton.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
PerformClick() Raises the EditorButton.Click event.
RaiseClick() Raises the EditorButton.Click event.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reset() Reverts the button's properties to its default values.
ResetSuperTip() Removes the SuperToolTip object that has been assigned to the editor button.
ToString() Returns the text representation of the current object.

Events

Name Description
Changed Occurs when the properties defining the button's look and feel are changed.
Click Occurs when the current editor button is clicked.
See Also