Skip to main content

TcxEditRepositoryTextItem Class

Declaration

TcxEditRepositoryTextItem = class(
    TcxEditRepositoryItem
)

Remarks

A single-line text editor allows users to edit a non-formatted string value.

VCL Editors Library: A Single-Line Text Editor Example

The TcxEditRepositoryTextItem class overrides the Properties property that allows you to access and customize single-line text editor settings.

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.

VCL Tree List: An In-Place Date Editor

Create a Text Editor Repository Item at Design Time

To create a text editor repository item at design time, double-click a TcxEditRepository component to invoke its collection editor.

VCL Editors Library: An Edit Repository Collection Editor

The collection editor dialog allows you to manage repository items. Click the Add… button to invoke a repository item creation dialog.

VCL Editors Library: An Edit Repository Item Creation Dialog

Select the TextEdit item and click the Ok button to create a text editor repository item.

Create a Text Editor Repository Item in Code

The following code example creates a text editor repository item, customizes editor settings, and assigns the created repository item to two existing unbound single-line text editors:

uses cxEdit, cxEditRepositoryItems;
// ...
var
  ATextEditRepositoryItem: TcxEditRepositoryTextItem;
  ARepositoryItem: TcxEditRepositoryItem;
begin
  ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryTextItem);
  ATextEditRepositoryItem := ARepositoryItem as TcxEditRepositoryTextItem;
  ATextEditRepositoryItem.Properties.MaxLength := 10; // Limits the maximum length of user input
  ATextEditRepositoryItem.Properties.AutoSelect := False; // Disables automatic content selection
  // Assigns the created repository item to two existing unbound single-line text editors
  cxTextEdit1.RepositoryItem := ATextEditRepositoryItem;
  cxTextEdit2.RepositoryItem := ATextEditRepositoryItem;
end;

Text Editor Repository Item Deletion

To delete all text editor repository items in a TcxEditRepository component, call its RemoveItems procedure and pass a reference to the TcxEditRepositoryTextItem class as a parameter.

If you need to delete an individual text editor repository item, release it directly in code (call the Free procedure in Delphi or use the delete keyword in C++Builder).

Inheritance

See Also