Skip to main content

TcxCheckBoxProperties Class

Stores check box settings.

Declaration

TcxCheckBoxProperties = class(
    TcxCustomCheckBoxProperties
)

Remarks

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

VCL Editors Library: A Check Box Example

Main API Members

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

Appearance Options

Alignment | UseAlignmentWhenInplace
Specify check box alignment within the editor client area.
Glyph | GlyphCount
Specify custom glyphs for individual check box states.
MultiLine
Specifies if word wrap is enabled for the check box caption.
NullStyle
Switches between display modes for the Null Variant edit value.
ShowEndEllipsis
Specifies if the editor displays an ellipsis at the end of the caption if it does not fit into the client area.
AllowGrayed
Specifies 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 | ValueUnchecked
Specify 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.

ReadOnly
Enables 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 | RestoreDefaults
Allow you to track the state of individual editor-specific settings and reset them.
BeginUpdate | EndUpdate | LockUpdate | DoUpdate | Update | Changed | ChangedLocked | DataChanged
Allow 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 TcxCheckBoxProperties Class References

The following public API members reference a TcxCheckBoxProperties object:

Unbound Check Box Editor

TcxCheckBox.ActiveProperties
Provides access to active check box settings.
TcxCheckBox.Properties
Provides access to check box settings.

Data-Aware Check Box Editor

TcxDBCheckBox.ActiveProperties
Provides access to the active check box settings.
TcxDBCheckBox.Properties
Provides access to check box settings.

Image Repository Item

TcxEditRepositoryCheckBoxItem
A repository item that stores check box editor settings.
See Also