BaseRepositoryItemCheckEdit.Caption Property
Gets or sets the text label associated with a check editor.
Namespace: DevExpress.XtraEditors.Repository
Assembly: DevExpress.XtraEditors.v18.2.dll
Declaration
[DXCategory("Appearance")]
[DefaultValue("BaseCheck")]
public virtual string Caption { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| String | "BaseCheck" | A System.String value representing the text label associated with a check editor. |
Remarks
Use this property to specify the text label associated with your check edit control. The position of the text label within the check editor is specified by the BaseRepositoryItemCheckEdit.GlyphAlignment property. Note: if the GlyphAlignment property is set to Center, the text label is not displayed. Also, no text label is displayed if an empty string or the null (Nothing in Visual Basic) value is assigned to the Caption property.
If a check editor has focus and its BaseRepositoryItemCheckEdit.FullFocusRect property is set to true, the text label specified by the Caption property represents the area where the focus rectangle is drawn. A check editor can be focused only if the RepositoryItem.AllowFocused property value is True.
Assigning a new value to the Caption property raises the RepositoryItem.PropertiesChanged event.
For a standalone CheckEdit control, its BaseCheckEdit.Text property is synchronized with the Caption property.
Note
When a CheckEdit object is used as an in-place editor within XtraBars, by default, the BaseRepositoryItemCheckEdit.GlyphAlignment property is set to Center, and so the Caption is hidden. To make the Caption visible, set the GlyphAlignment property to Far or Near.