Back to Devexpress

TcxCustomCheckBoxProperties Class

vcl-cxcheckbox-86cd1b5f.md

latest5.9 KB
Original Source

TcxCustomCheckBoxProperties Class

The base class for check box settings.

Declaration

delphi
TcxCustomCheckBoxProperties = class(
    TcxCustomEditProperties,
    IdxMultiPartGlyphSupport
)

Remarks

A check box editor allows users to switch between two or three states of an option.

Main API Members

The list below outlines key members of the TcxCustomCheckBoxProperties class. These members allow you to configure check boxes.

Appearance Options

Alignment | UseAlignmentWhenInplaceSpecify check box alignment within the editor client area.Glyph | GlyphCountSpecify custom glyphs for individual check box states.MultiLineSpecifies if word wrap is enabled for the check box caption.NullStyleSwitches between display modes for the Null Variant edit value.ShowEndEllipsisSpecifies if the editor displays an ellipsis at the end of the caption if it does not fit into the client area.

Value and State-Related Options

AllowGrayedSpecifies if the check box has an intermediate state in addition to checked and unchecked.DisplayChecked | DisplayGrayed | DisplayUnchecked

Allow you to associate specific text strings with corresponding check box states.

Tip

These properties may be useful for in-place check box editors. Container controls can use these strings for data export and filter operations.

ValueChecked | ValueGrayed | ValueUncheckedSpecify edit values associated with corresponding check box states.

User Interaction Options

Automation

Provides access to UI Automation and accessibility-related settings.

Tip

Use Automation.Name, Automation.Description, and other API members to specify information visible to third-party assistive tools as UIA node properties.

ReadOnlyEnables or disables read-only mode. You can use the editor’s Style.ReadOnly and StyleReadOnly properties to customize editor appearance options for the read-only state.

General-Purpose API Members

AssignedValues | RestoreDefaultsAllow you to track the state of individual editor-specific settings and reset them.BeginUpdate | EndUpdate | LockUpdate | DoUpdate | Update | Changed | ChangedLocked | DataChangedAllow you to manage editor updates and avoid excessive redraw operations during batch editor setting changes.

Repository Item Class

You can create a TcxEditRepositoryCheckBoxItem component in an edit repository to define an unbound check box editor, store check box settings, and share the same settings between multiple check box editors.

Direct TcxCustomCheckBoxProperties Class References

The following public API members reference a TcxCustomCheckBoxProperties object:

TcxCustomCheckBox.ActivePropertiesProvides access to active check box settings.TcxCustomCheckBox.PropertiesProvides access to check box settings.

Terminal TcxCustomCheckBoxProperties Class Descendant

Do not use the TcxCustomCheckBoxProperties class directly. Use TcxCheckBoxProperties instead.

Implements

IdxMultiPartGlyphSupport

Inheritance

TObject TPersistent TInterfacedPersistent TcxInterfacedPersistent TcxCustomEditProperties TcxCustomCheckBoxProperties

See Also

TcxEditRepositoryCheckBoxItem Class

TcxCustomCheckBoxProperties Members

cxCheckBox Unit