Skip to main content
A newer version of this page is available. .

WindowsUIButton(String, Image, String, Int32, ImageLocation, ButtonStyle, String, Boolean, Int32, Boolean, SuperToolTip, Boolean, Boolean, Boolean, Object, Object, Int32, Boolean, Boolean) Constructor

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

Namespace: DevExpress.XtraBars.Docking2010

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

public WindowsUIButton(
    string caption,
    Image image,
    string imageUri,
    int imageIndex,
    ImageLocation imageLocation,
    ButtonStyle style,
    string toolTip,
    bool useCaption,
    int visibleIndex,
    bool enabled,
    SuperToolTip superTip,
    bool useImage,
    bool checked,
    bool visible,
    object glyphs,
    object tag,
    int groupIndex,
    bool isLeft,
    bool enableImageTransparency
)

Parameters

Name Type Description
caption String

A String value that is the button text.

image Image

An Image object that is the button glyph.

imageUri String

A String value that is the Unified Resource Identifier (URI) for the image contained within the Image Gallery and Context-Dependent Images that should be used as the button glyph. Overrides the image parameter.

imageIndex Int32

An Int32 value that is the number of an image within the container’s Images collection (e.g., WindowsUIButtonPanel.Images) that should be used as the button glyph.

imageLocation DevExpress.XtraBars.Docking2010.ImageLocation

An ImageLocation enumerator value that specifies the button glyph’s alignment relative to this button’s text.

style ButtonStyle

A Style enumerator value that specifies whether this button should be a regular push button or check button that supports regular and pressed states.

toolTip String

A String value that is the button hint.

useCaption Boolean

true, if the button should display its caption; otherwise, false.

visibleIndex Int32

An Int32 value that specifies the order for this button within its parent container.

enabled Boolean

true, if the button is enabled; otherwise, false.

superTip SuperToolTip

A SuperTip object assigned to this button.

useImage Boolean

true, if the button should display its glyph; otherwise, false.

checked Boolean

true, if the button is in the pressed state; otherwise, false. This setting is in effect only for buttons whose style argument was set to ButtonStyle.CheckButton.

visible Boolean

true, if the button should be visible to end-users; otherwise, false.

glyphs Object

An Object that contains images applied to this button in all its visual states. See the IButtonProperties.Glyphs property to learn more.

tag Object

An Object that contains any required info related to this button.

groupIndex Int32

An Int32 value that specifies to which group this button belongs.

isLeft Boolean

true, if the button is aligned to the left edge of its parent container; otherwise, false.

enableImageTransparency Boolean

true, if the button should process transparent pixels of its glyph; otherwise, false.

See Also