EditorButton.Caption Property

Gets or sets the caption text of the editor button.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

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

VB.NET

<DefaultValue("")>
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.ImageLocation 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#

how-to-show-a-panel-with-buttons-under-a-focused-row-e1957/CS/WindowsApplication1/ButtonPanelHelper.cs#L73

EditorButton button = new EditorButton(ButtonPredefines.Glyph);
button.Caption = "Test1";
Buttons.Add(button);

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/CS/CS/WindowsApplication1/CustomEditor/GetButtonCaptionEventArgs.cs#L35

    _View = view;
    _ButtonText = button.Caption;
}

how-to-change-an-in-place-buttonedit-button-caption-in-different-rows-of-xtragrid-e903/CS/Form1.cs#L39

{
    MessageBox.Show(e.Button.Caption);
}

how-to-create-a-custom-buttonedit-descendant-that-displays-its-value-in-the-first-button-e1954/CS/WindowsApplication1/CustomEditor/MySkinEditorButtonPainter.cs#L24

EditorButtonObjectInfoArgs ee = e as EditorButtonObjectInfoArgs;
string caption = OwnerEditInfo == null? ee.Button.Caption : OwnerEditInfo.DisplayText;
ButtonPainter.DrawCaption(ee, caption, ee.Appearance.Font, GetForeBrush(ee), e.Bounds, ee.Appearance.GetStringFormat());

how-to-create-a-control-that-shows-a-list-of-tags-e4542/CS/tagsList/Taglist/Taglist.cs#L42

foreach(EditorButton t in ViewInfo.Item.Buttons) {
    if((res != null) && (t.Caption.Length > 1)) res = String.Format("{0},{1}", t.Caption, res);
    else if((res == null) && (t.Caption.Length > 1)) res = t.Caption;

VB.NET

how-to-show-a-panel-with-buttons-under-a-focused-row-e1957/VB/WindowsApplication1/ButtonPanelHelper.vb#L82

Dim button As New EditorButton(ButtonPredefines.Glyph)
button.Caption = "Test1"
Buttons.Add(button)

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/VB/WindowsApplication1/CustomEditor/GetButtonCaptionEventArgs.vb#L34

    _View = view
    _ButtonText = button.Caption
End Sub

how-to-change-an-in-place-buttonedit-button-caption-in-different-rows-of-xtragrid-e903/VB/Form1.vb#L37

Private Sub repositoryItemButtonEdit1_ButtonClick(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.ButtonPressedEventArgs)
    MessageBox.Show(e.Button.Caption)
End Sub

how-to-create-a-custom-buttonedit-descendant-that-displays-its-value-in-the-first-button-e1954/VB/WindowsApplication1/CustomEditor/RepositoryItemMyButtonEdit.vb#L28

    Buttons(0).Kind = DevExpress.XtraEditors.Controls.ButtonPredefines.Glyph
    Buttons(0).Caption = "Test"
End Sub

how-to-create-a-control-that-shows-a-list-of-tags-e4542/VB/tagsList/Taglist/Taglist.vb#L46

If (res IsNot Nothing) AndAlso (t.Caption.Length > 1) Then
    res = String.Format("{0},{1}", t.Caption, res)
ElseIf (res Is Nothing) AndAlso (t.Caption.Length > 1) Then