vcl-cxedit-bb25f8fc.md
A collection of repository items that define editors and their settings.
TcxEditRepository = class(
TcxScalableComponent
)
The TcxEditRepository class implements a non-visual component designed to store and manage edit repository items that maintain, share, and manage editor settings.
Edit repository items are useful when you need to share the same settings between multiple editors of the same type. To accomplish this goal, you can assign the same edit repository item to RepositoryItem properties of all target editors.
A container control item (such as a toolbar edit item or a column (or any other data item) in a Data Grid, Vertical Grid, or Tree List control) can embed an in-place editor shipped with the ExpressEditors Library. An in-place editor exists (and, therefore, has its own WinAPI handle) only when the target container control item is being edited. Otherwise, the container control item displays a static editor image for resource usage optimization.
Every repository item type (a TcxEditRepositoryItem class descendant) defines the corresponding in-place editor type and stores its settings accessible through the Properties property. The following table lists all available edit repository items and corresponding in-place editor classes:
|
Repository Item Type
|
In-Place Editor
|
Description
| | --- | --- | --- | |
|
|
A barcode control without user input functionality.
| |
|
|
A Binary Large Object (BLOB) editor.
| |
|
|
A single-line text editor with embedded buttons.
| |
|
|
A single-line editor with a drop-down calculator window.
| |
|
|
A check box editor with support for three states.
| |
TcxEditRepositoryCheckComboBox
|
|
A combo box editor that can display items with check boxes.
| |
TcxEditRepositoryCheckGroupItem
|
|
An editor designed to display a set of check boxes.
| |
TcxEditRepositoryColorComboBox
|
|
A color combo box editor.
| |
|
|
An editor designed to select a color in a color gallery embedded into a drop-down window.
| |
|
|
A general-purpose combo box editor.
| |
|
|
A numeric editor for currency values.
| |
|
|
A date editor with a drop-down calendar.
| |
TcxEditRepositoryDateTimeWheelPickerItem
|
|
A date/time wheel picker editor.
| |
TcxEditRepositoryExtLookupComboBoxItem
|
|
A lookup editor that displays a Data Grid View in a drop-down window.
Warning
Do not use repository items to share settings between multiple lookup editors because these settings include data binding options.
A repository item shared between multiple lookup editors binds them to the same dataset. This scenario may lead to data update and synchronization issues that are difficult to detect and identify.
| |
TcxEditRepositoryExtLookupComboBoxItem
|
|
A lookup editor that displays a Data Grid View in a drop-down window.
Warning
Do not use repository items to share settings between multiple lookup editors because these settings include data binding options.
A repository item shared between multiple lookup editors binds them to the same dataset. This scenario may lead to data update and synchronization issues that are difficult to detect and identify.
| |
TcxEditRepositoryFontNameComboBox
|
|
A combo box that allows users to switch between font typefaces.
| |
TcxEditRepositoryFormattedLabel
|
|
A formatted label editor without user input functionality.
| |
TcxEditRepositoryHyperLinkItem
|
|
A hyperlink editor that can execute custom commands.
| |
TcxEditRepositoryImageComboBoxItem
|
|
A combo box whose items can display text and images.
| |
|
|
An editor designed to display images.
| |
|
|
An unformatted label editor without user input functionality.
| |
TcxEditRepositoryLookupComboBoxItem
|
|
A lookup combo box populated with values from a data source.
Warning
Do not use repository items to share settings between multiple lookup editors because these settings include data binding options.
A repository item shared between multiple lookup editors binds them to the same dataset. This scenario may lead to data update and synchronization issues that are difficult to detect and identify.
| |
TcxEditRepositoryLookupSparklineItem
|
|
A lookup sparkline editor.
| |
|
|
A single-line text editor that displays a list of most recently used (MRU) items in a drop-down window.
| |
|
|
A single-line text editor with support for input masks.
| |
|
|
A multi-line editor for plain text.
| |
TcxEditRepositoryNumericWheelPickerItem
|
|
A numeric value wheel picker editor.
| |
|
|
A text editor that can embed a control in a drop-down window.
| |
|
|
A progress bar without user input functionality.
| |
TcxEditRepositoryRadioGroupItem
|
|
A container for radio buttons.
| |
TcxEditRepositoryRangeTrackBar
|
|
A track bar editor with two sliders that allow users to select a value range.
| |
TcxEditRepositoryRatingControl
|
|
A rating control.
| |
|
|
A multi-line rich text editor.
| |
TcxEditRepositorySparklineItem
|
|
An editor that visualizes data as lightweight charts without axes and labels.
| |
|
|
A general-purpose numeric spin editor.
| |
|
|
A simple single-line text editor.
| |
|
|
A spin editor for time values.
| |
TcxEditRepositoryToggleSwitchItem
|
|
A toggle switch editor.
| |
|
|
A token editor.
| |
|
|
A track bar editor with two sliders for value range selection.
|
The list below outlines key members of the TcxEditRepository class that allow you to manage edit repository items.
ClearDestroys all stored repository items.CountReturns the number of stored repository items accessible through the Items property.CreateItem | CreateItemExCreate new repository items.ItemByName | ItemsProvide access to stored repository items by their names and indexes.RemoveItemsDestroys all stored repository items of the specified type.
To create a repository item at design time, double-click an edit repository component to invoke its collection editor.
The collection editor dialog allows you to manage repository items. Click the Add… button to invoke a repository item creation dialog.
Select any item type and click the Ok button to create a repository item.
The following code example creates two unbound Table View columns in a Data Grid control and uses a memo repository item to assign an in-place memo editor to them:
uses cxEdit, cxEditRepositoryItems;
// ...
var
AColumn1, AColumn2: TcxGridColumn;
ARepositoryItem: TcxEditRepositoryMemoItem;
begin
AColumn1 := cxGrid1TableView1.CreateColumn; // Creates a new unbound column
AColumn2 := cxGrid1TableView1.CreateColumn; // Creates another unbound column
// Creates a repository item that defines a memo editor and stores its settings
ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryMemoItem) as TcxEditRepositoryMemoItem;
ARepositoryItem.Properties.ScrollBars := ssVertical; // Enables a vertical scroll bar
ARepositoryItem.Properties.VisibleLineCount := 8; // Limits the number of simultaneously visible lines
// Assigns the created repository item to both new columns
AColumn1.RepositoryItem := ARepositoryItem;
AColumn2.RepositoryItem := ARepositoryItem;
end;
#include "cxEdit.hpp"
#include "cxEditRepositoryItems.hpp"
// ...
TcxGridColumn *AColumn1, *AColumn2;
TcxEditRepositoryMemoItem *ARepositoryItem;
// ...
AColumn1 = cxGrid1TableView1->CreateColumn(); // Creates a new unbound column
AColumn2 = cxGrid1TableView1->CreateColumn(); // Creates another unbound column
// Creates a repository item that defines a memo editor and stores its settings
ARepositoryItem = dynamic_cast<TcxEditRepositoryMemoItem*>(cxEditRepository->CreateItem(__classid(TcxEditRepositoryMemoItem)));
ARepositoryItem->Properties->ScrollBars = ssVertical; // Enables a vertical scroll bar
ARepositoryItem->Properties->VisibleLineCount = 8; // Limits the number of simultaneously visible lines
// Assigns the created repository item to both new columns
AColumn1->RepositoryItem = ARepositoryItem;
AColumn2->RepositoryItem = ARepositoryItem;
TObject TPersistent TComponent TcxCustomComponent TcxComponent TcxScalableComponent TcxEditRepository
See Also