IButtonProperties.Caption Property

Gets or sets the current IButton object’s caption.

Namespace: DevExpress.XtraEditors.ButtonPanel

Assembly: DevExpress.Utils.v19.2.dll

Declaration

C#

[DXCategory("Appearance")]
string Caption { get; set; }

VB.NET

<DXCategory("Appearance")>
Property Caption As String

Property Value

Type	Description
String	A String value that is the current IButton object’s caption.

Remarks

Header Buttons and WindowUI Custom Buttons can have text, specified via the Caption property, and a glyph (see the IButtonProperties.Imageand IButtonProperties.ImageIndex properties). You can set whether only button’s text, or a glyph, or both of them should be displayed via the IButtonProperties.UseCaption and IButtonProperties.UseImage properties. If both text and glyph are shown, use the IButtonProperties.ImageLocation property to set their relative positions.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Caption property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-grid-copy-paste/CS/Main.cs#L16

private void OnButtonClick(object sender, DevExpress.XtraBars.Docking2010.ButtonEventArgs e) {
    if (e.Button.Properties.Caption == "Copy") {
        gridView1.CopyToClipboard();

VB.NET

winforms-grid-copy-paste/VB/Main.vb#L18

Private Sub OnButtonClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking2010.ButtonEventArgs) Handles windowsUIButtonPanel1.ButtonClick
    If e.Button.Properties.Caption = "Copy" Then
        gridView1.CopyToClipboard()