TdxDBRatingControl Class
A data-aware rating control editor.
Declaration
TdxDBRatingControl = class(
TdxCustomRatingControl
)Remarks
A rating control editor is designed to rate content. Rating controls support custom element glyphs.
UI Automation/Accessibility Support
The TdxDBRatingControl component is mapped to a node in the UI Automation tree when the global UI Automation flag (dxUIAutomationEnabled) is enabled.
UI Automation Settings
Use Properties.Automation.Name and Properties.Automation.Description properties to specify the editor name and add optional information used to clarify editor purpose for users who rely on third-party assistive tools (such as Microsoft Narrator).
Refer to the TdxAutomationElementSettings class description for detailed information on all available options.
Keyboard Interaction Options
The rating control editor supports the following keystrokes:
- ↑ | ↓ | ← | →
- Increment/decrement the rating value depending on Properties.Orientation and Properties.ReverseDirection property values. The Properties.Step property specifies the increment/decrement value.
Main API Members
The list below outlines key members of the TdxDBRatingControl class.
Appearance Settings
- Style | StyleDisabled | StyleFocused | StyleHot | StyleReadOnly
Allow you to define individual appearance settings for different editor states.
Tip
To apply the same style settings to multiple editors, use a TcxEditStyleController component. If you need to apply the same style settings to all editors in your application, you can use a TcxDefaultEditStyleController component.
- Styles
- Provides access to individual styles applied to the editor in different states.
- Transparent
- Specifies if the editor is transparent in GDI render mode.
Content-Related APIs
- Clear
- Clears the editor.
- EditValue
- Specifies the edit value.
- OnEditing
- Allows you to prevent users from activating the editor.
- Rating
- Specifies the rating value (from
0to Properties.ItemCount).
Data-Related APIs
- DataBinding
- Allows you to bind the editor to data.
- CanPostEditValue
- Identifies if the data-aware editor can post its edit value to the bound data storage. Only data-aware editors publish this property.
- OnPostEditValue
- Executes custom code when the editor posts its value to the bound data storage.
- PostEditValue
- Posts the edit value to the bound data storage.
Editor Settings and Repository Items
- ActiveProperties
- Provides access to the current editor settings regardless of their source. This property set does not allow you to customize editor settings.
- Properties
- Allows you to customize editor settings directly if the editor does not have an assigned repository item.
- RepositoryItem
- Specifies a repository item as an external source of editor settings. A repository item has priority over other editor settings.
General-Purpose API Members
- AutoSize
- Specifies if the editor automatically adjusts its size to fit content.
- Enabled
- Specifies if the editor is enabled.
- CanModify
- Identifies if the editor is in read-only mode.
- IsEditValidating | IsHiding | IsPosting
- Allow you to identify the current operation in the editor.
- ShowHint
- Specifies if the standalone editor can display hints.
- Width | Height
- Allow you to explicitly define editor dimensions.
Repository Item Class
You can create a TcxEditRepositoryRatingControl component in an TcxEditRepository container to store editor settings and share them between multiple rating control editors.
Related Compiled Demo
To see the TdxDBRatingControl component in action, run the Data Editors and Controls demo in the VCL Demo Center installed with compiled DevExpress VCL demos. Click the Rating Control item in the sidebar to run the corresponding demo.
Compiled DevExpress demos ship with source code installed in the Public Documents folder (%PUBLIC%) for all users (default). You can find all project and source code files for the Data Editors and Controls demo in the following folder:
%PUBLIC%\Documents\DevExpress VCL Demos\MegaDemos\Product Demos\ExpressEditors\
Limitations and Considerations
The TdxDBRatingControl component is available only as a standalone editor. You cannot use data-aware editors as in-place editors in container controls (Data Grid, Tree List, etc.).