EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, ImageLocation, Image, String, KeyShortcut, AppearanceObject, AppearanceObject, AppearanceObject, AppearanceObject, String, Object, SuperToolTip, Boolean) Constructor

Initializes a new instance of the EditorButton class with the specified settings.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

public EditorButton(
    ButtonPredefines kind,
    string caption,
    int width,
    bool enabled,
    bool visible,
    bool isLeft,
    ImageLocation imageLocation,
    Image image,
    string imageUri,
    KeyShortcut shortcut,
    AppearanceObject appearance,
    AppearanceObject appearanceHovered,
    AppearanceObject appearancePressed,
    AppearanceObject appearanceDisabled,
    string toolTip,
    object tag,
    SuperToolTip superTip,
    bool enableImageTransparency
)
Public Sub New(
    kind As ButtonPredefines,
    caption As String,
    width As Integer,
    enabled As Boolean,
    visible As Boolean,
    isLeft As Boolean,
    imageLocation As ImageLocation,
    image As Image,
    imageUri As String,
    shortcut As KeyShortcut,
    appearance As AppearanceObject,
    appearanceHovered As AppearanceObject,
    appearancePressed As AppearanceObject,
    appearanceDisabled As AppearanceObject,
    toolTip As String,
    tag As Object,
    superTip As SuperToolTip,
    enableImageTransparency As Boolean
)

Parameters

Name Type Description
kind ButtonPredefines

A ButtonPredefines value that specifies the predefined image for the button. This value is assigned to the EditorButton.Kind property.

caption String

A String value which specifies the button's caption. This value is assigned to the EditorButton.Caption property.

width Int32

An integer value specifying the button's width. This value is assigned to the EditorButton.Width property.

enabled Boolean

true, if the editor button is enabled and an end-user can perform actions on it; otherwise, false. This value is assigned to the EditorButton.Enabled property.

visible Boolean

true, if the button is visible; otherwise, false. This value is assigned to the EditorButton.Visible property.

isLeft Boolean

true if the button is aligned to the editor's left edge; false if the button is aligned to the editor's right edge. This value is assigned to the EditorButton.IsLeft property.

imageLocation ImageLocation

An ImageLocation value that specifies the position of the button's image relative to the text. This value is assigned to the EditorButton.ImageLocation property.

image Image

A Image object which represents the image displayed on the button's surface. This value is assigned to the EditorButton.Image property.

imageUri String

A String value that specifies the uniform resource identifier of the image in the DX Image Gallery to be displayed on the button's surface.

shortcut KeyShortcut

A KeyShortcut object which represents the button's shortcut. This value is assigned to the EditorButton.Shortcut property.

appearance AppearanceObject

An AppearanceObject object which provides the appearance settings used to paint the button. This value is assigned to the EditorButton.Appearance property.

appearanceHovered AppearanceObject

An AppearanceObject object which provides the appearance settings used to paint the button in hovered state. This value is assigned to the EditorButton.AppearanceHovered property.

appearancePressed AppearanceObject

An AppearanceObject object which provides the appearance settings used to paint the button in pressed state. This value is assigned to the EditorButton.AppearancePressed property.

appearanceDisabled AppearanceObject

An AppearanceObject object which provides the appearance settings used to paint the button in disabled state. This value is assigned to the EditorButton.AppearanceDisabled property.

toolTip String

A String value which specifies the button's tool tip. This value is assigned to the EditorButton.ToolTip property.

tag Object

An object to be associated with the button. This value is assigned to the EditorButton.Tag property.

superTip SuperToolTip

A SuperToolTip object that represents a tooltip that supports multiple text and image regions. This value is assigned to the EditorButton.SuperTip property.

enableImageTransparency Boolean

A Boolean value that specifies whether specific pixels in the button's image are displayed transparent. This value is assigned to the EditorButton.EnableImageTransparency property.

See Also