EditorButton.Caption Property

Gets or sets the caption text of the editor button.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

<DefaultValue("")>
<DXCategory("Appearance")>
Public Overridable Property Caption As String

Property Value

Type	Default	Description
String	String.Empty	A string specifying button caption text.

Remarks

Text is displayed in the button if the EditorButton.Kind property is set to any of the following values:Glyph, Ellipsis, Delete, OK, Plus, Minus, Redo, Undo or DropDown.

To display only the caption without an image, set the EditorButton.Kind property to Glyph and do not assign any image to the button.

If the button displays a custom or predefined image and the EditorButton.ImageOptions.Location property is set to MiddleCenter, the text is not displayed, but the image is centered within the button.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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-custom-button-caption-customrowcelledit-event/CS/WindowsApplication1/Form1.cs#L36

repositoryItem.Assign(defaultRepositoryItemButtonEdit);
repositoryItem.Buttons[0].Caption = String.Format("Find: {0}", value);
repositoryItemsCache[value] = repositoryItem;

winforms-custom-buttonedit-display-editvalue-on-button/CS/TestMyButtonEdit/MyButtonEdit.cs#L53

    string str_value = EditValue as string;
    Properties.Buttons[1].Caption = (str_value == null ? string.Empty : str_value);
}

winforms-layoutcontrol-show-ui-controls-in-tabbed-group-header/CS/Form1.cs#L33

riBE.Buttons[0].Kind = DevExpress.XtraEditors.Controls.ButtonPredefines.Glyph;
riBE.Buttons[0].Caption = "Test";
riBE.AutoHeight = false;

gridview-how-to-add-a-custom-button-to-the-filterpanel-t375271/CS/Form1.cs#L37

    EditorButton b = sender as EditorButton;
    Console.WriteLine(string.Format("{0} is clicked",b.Caption));
}

winforms-grid-toggle-row-visibility/CS/WindowsApplication1/Form1.cs#L46

button.Enabled = !(spinEdit1.EditValue == null);
button.Caption = rowVisibilityHelper1.IsRowInvisible(GetButtonEditValue()) ? "Show" : "Hide";

VB.NET

winforms-grid-custom-button-caption-customrowcelledit-event/VB/WindowsApplication1/Form1.vb#L42

repositoryItem.Assign(defaultRepositoryItemButtonEdit)
repositoryItem.Buttons(0).Caption = String.Format("Find: {0}", value)
repositoryItemsCache(value) = repositoryItem

winforms-grid-toggle-row-visibility/VB/WindowsApplication1/Form1.vb#L44

If rowVisibilityHelper1.IsRowInvisible(GetButtonEditValue()) Then
    button.Caption = "Show"
Else

winforms-custom-buttonedit-display-editvalue-on-button/VB/TestMyButtonEdit/MyButtonEdit.vb#L45

    Dim str_value As String = TryCast(EditValue, String)
    Properties.Buttons(1).Caption = (If(str_value Is Nothing, String.Empty, str_value))
End If

winforms-layoutcontrol-show-ui-controls-in-tabbed-group-header/VB/Form1.vb#L33

riBE.Buttons(0).Kind = DevExpress.XtraEditors.Controls.ButtonPredefines.Glyph
riBE.Buttons(0).Caption = "Test"
riBE.AutoHeight = False

gridview-how-to-add-a-custom-button-to-the-filterpanel-t375271/VB/Form1.vb#L34

    Dim b As EditorButton = TryCast(sender, EditorButton)
    Console.WriteLine(String.Format("{0} is clicked",b.Caption))
End Sub