TcxEditRepositoryItem Class

The base class for all edit repository items.

Declaration

delphi

TcxEditRepositoryItem = class(
    TComponent,
    IdxScaleFactor
)

Remarks

An edit repository item is a non-visual component designed to define an editor and store its settings. All TcxEditRepositoryItem class descendants override the Properties property to store settings specific to corresponding editors.

Edit Repository Items and Standalone Editors

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.

Edit Repository Items and Container Controls

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.

Main API Members

The list below outlines key members of the TcxEditRepositoryItem class that allow you to configure repository items.

GetBaseNameGenerates the base part of the repository item name. You can override this function in custom descendants of the TcxEditRepositoryItem class to define a custom repository item name.GetEditPropertiesClassReturns the type of stored editor settings. Override this method in a TcxEditRepositoryItem class descendant to create and register a repository item component for a custom editor (a TcxCustomEdit class descendant).NameSpecifies the repository item name.PropertiesAllows you to customize stored editor settings. Override this property in a TcxEditRepositoryItem class descendant to implement type-specific settings of a custom editor derived from the TcxCustomEdit class.RepositoryProvides access to the repository component to which the current repository item belongs.

Create a Repository Item at Design Time

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.

Code Example: Shared In-Place Editor Settings

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:

Delphi
C++

delphi

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;

cpp

#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;

Custom Editors and Repository Items

To store, share, and manage settings of custom TcxCustomEdit descendants in a TcxEditRepository component, you need to derive a custom descendant from the TcxEditRepositoryItem class and override the following API members:

GetEditPropertiesClassReturns the type of stored editor settings. Override this method in a TcxEditRepositoryItem class descendant to create and register a repository item component for a custom editor (a TcxCustomEdit class descendant).PropertiesAllows you to customize stored editor settings. Override this property in a TcxEditRepositoryItem class descendant to implement type-specific settings of a custom editor derived from the TcxCustomEdit class.GetBaseNameOptional. Generates the base part of the repository item name. You can override this function in custom descendants of the TcxEditRepositoryItem class to define a custom repository item name.

Terminal TcxEditRepositoryItem Class Descendants

Do not use the TcxEditRepositoryItem class directly. Use the following descendants instead:

Warning

Do not use the TcxEditRepositoryExtLookupComboBoxItem component to share settings between multiple lookup editors. A repository item shared between multiple lookup editors binds them to the same dataset. Data update and synchronization issues may occur if two or more editors are bound to the same dataset and manage the same records.

F

TcxEditRepositoryFontNameComboBoxA repository item that stores font name combo box settings.TcxEditRepositoryFormattedLabelA repository item that stores formatted label settings.

H

TcxEditRepositoryHyperLinkItemA repository item that stores hyperlink editor settings.

I

TcxEditRepositoryImageComboBoxItemAn edit repository item that stores image combo box settings.TcxEditRepositoryImageItemA repository item that stores image editor settings.

L

TcxEditRepositoryLabelA repository item that stores unformatted label settings.TcxEditRepositoryLookupComboBoxItem

A repository item that stores lookup combo box settings.

Warning

Do not use the TcxEditRepositoryLookupComboBoxItem component to share settings between multiple lookup editors. A repository item shared between multiple lookup editors binds them to the same dataset. Data update and synchronization issues may occur if two or more editors are bound to the same dataset and manage the same records.

TcxEditRepositoryLookupSparklineItemA repository item containing settings that are specific to sparkline lookup editors (TdxLookupSparklineEdit and TdxDBLookupSparklineEdit).