RepositoryItemCheckEdit.Caption Property

Gets or sets the caption of the current CheckEdit.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

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

VB.NET

<DefaultValue("CheckEdit")>
Public Overrides Property Caption As String

Property Value

Type	Default	Description
String	"CheckEdit"	A String value that is the caption of the current CheckEdit.

Remarks

The Caption property specifies the text label associated with the CheckEdit control. You can change the caption position via the BaseRepositoryItemCheckEdit.GlyphAlignment property.

Note

If the BaseRepositoryItemCheckEdit.GlyphAlignment property equals Center, the caption is not displayed.

The Caption property is closely associated with the BaseCheckEdit.Text property. Modifying the Caption property affects the value returned by the Text property and vice versa.

The Caption property overrides the BaseRepositoryItemCheckEdit.Caption property. See this link to learn more.

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#

mruitem-with-pinning-e323/CS/WindowsApplication123/Form1.cs#L50

riCheck = new RepositoryItemCheckEdit();
riCheck.Caption = "";
riCheck.GlyphAlignment = DevExpress.Utils.HorzAlignment.Far;

how-to-display-custom-text-next-to-a-check-box-within-the-same-cell-e888/CS/WindowsApplication6/Form1.cs#L48

        return;
    (tl.ActiveEditor as DevExpress.XtraEditors.CheckEdit).Properties.Caption = "Node ID: " + tl.FocusedNode.Id.ToString();
}

how-to-change-check-box-alignment-within-the-propertygridcontrol-e1594/CS/WindowsApplication2/Form1.cs#L22

RepositoryItemCheckEdit edit = new RepositoryItemCheckEdit();
edit.Caption = "";
edit.GlyphAlignment = DevExpress.Utils.HorzAlignment.Near;

VB.NET

mruitem-with-pinning-e323/VB/WindowsApplication123/Form1.vb#L47

riCheck = New RepositoryItemCheckEdit()
riCheck.Caption = ""
riCheck.GlyphAlignment = DevExpress.Utils.HorzAlignment.Far

how-to-display-custom-text-next-to-a-check-box-within-the-same-cell-e888/VB/WindowsApplication6/Form1.vb#L45

    End If
    TryCast(tl.ActiveEditor, DevExpress.XtraEditors.CheckEdit).Properties.Caption = "Node ID: " & tl.FocusedNode.Id.ToString()
End Sub

how-to-change-check-box-alignment-within-the-propertygridcontrol-e1594/VB/WindowsApplication2/Form1.vb#L20

Dim edit As New RepositoryItemCheckEdit()
edit.Caption = ""
edit.GlyphAlignment = DevExpress.Utils.HorzAlignment.Near