CustomHeaderButton Members
A custom header button for tab controls.Constructors
| Name | Description |
|---|---|
| CustomHeaderButton() | Initializes a new CustomHeaderButton instance. |
| CustomHeaderButton(ButtonPredefines, String, Int32, Boolean, Boolean, EditorButtonImageOptions, AppearanceObject, AppearanceObject, AppearanceObject, AppearanceObject, String, Object, SuperToolTip) | Initializes a new CustomHeaderButton instance. |
| CustomHeaderButton(ButtonPredefines, String, Int32, Boolean, Boolean, EditorButtonImageOptions, AppearanceObject, String, Object, SuperToolTip) | Initializes a new instance of the CustomHeaderButton class with the specified settings. |
| CustomHeaderButton(ButtonPredefines, String, Int32, Boolean, Boolean, ImageLocation, Image, AppearanceObject, String, Object, SuperToolTip, Boolean) | Initializes a new CustomHeaderButton instance with the specified settings. |
| CustomHeaderButton(ButtonPredefines) | Initializes a new CustomHeaderButton class instance with the specified kind. |
Properties
| Name | Description |
|---|---|
| Appearance | Provides access to the button’s appearance settings. Inherited from EditorButton. |
| AppearanceDisabled | Provides access to the appearance settings applied when the current button is disabled. Inherited from EditorButton. |
| AppearanceHovered | Provides access to the appearance settings applied when the mouse pointer passes over the current button. Inherited from EditorButton. |
| AppearancePressed | Provides access to the appearance settings applied when the current button is clicked. Inherited from EditorButton. |
| Caption | Gets or sets the caption text of the editor button. Inherited from EditorButton. |
| Collection | Gets a collection that owns the custom header button. |
| Command |
Gets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked.
Inherited from EditorButton. |
| CommandParameter |
Gets or sets the parameter that is passed to the command specified by the Command property.
Inherited from EditorButton. |
| DrawBackground | Gets or sets whether a selected EditorButton is highlighted when the mouse interacts with the button. Inherited from EditorButton. |
| Enabled | Gets or sets the Boolean value that determines whether a user can perform actions on the current editor button. Inherited from EditorButton. |
| EnableImageTransparency | Gets or sets whether specific colors in the button’s image are transparent, when displayed. Inherited from EditorButton. |
| GlyphAlignment | Obsolete. Gets or sets the glyph alignment relative to its caption. Inherited from EditorButton. |
| Image | Gets or sets a custom image to display on the button. Inherited from EditorButton. |
| ImageAlignment | Obsolete. Gets or sets the alignment of the image displayed within the button. Inherited from EditorButton. |
| ImageLocation | Specifies the position of the button’s image relative to the text. Inherited from EditorButton. |
| ImageOptions | Provides access to all properties that allow you to assign and customize an icon for this EditorButton. Inherited from EditorButton. |
| ImageToTextAlignment | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorButton. |
| ImageToTextIndent | This 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. |
Methods
| Name | Description |
|---|---|
| Assign(EditorButton) | Copies all properties of the specified button to the current EditorButton object. Inherited from EditorButton. |
| 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. Inherited from EditorButton. |
| BindCommand(Object, Func<Object>) | Binds the specific parameterized command to this EditorButton. Inherited from 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. Inherited from EditorButton. |
| Dispose() | Releases all unmanaged resources used by an EditorButton. Inherited from EditorButton. |
| Equals(Object, Object) static | Determines 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. |
| 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. Inherited from EditorButton. |
| RaiseClick() | Raises the EditorButton.Click event. Inherited from EditorButton. |
| 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. Inherited from EditorButton. |
| ResetSuperTip() | Removes the SuperToolTip object that has been assigned to the editor button. Inherited from EditorButton. |
| ToString() | Returns the text representation of the current object. Inherited from EditorButton. |
Events
| Name | Description |
|---|---|
| Changed | Occurs when the properties defining the button’s look and feel are changed. Inherited from EditorButton. |
| Click | Occurs when the current editor button is clicked. Inherited from EditorButton. |
| CommandCanExecuteChanged | Occurs when the CanExecute(Object) status of the Command has changed. Inherited from EditorButton. |
| CommandChanged | Occurs after the value of the Command property has changed. Inherited from EditorButton. |
| CommandParameterChanged | Occurs after the value of the CommandParameter property has changed. Inherited from EditorButton. |
See Also