TcxEditRepositoryMaskItem Class

A repository item that stores mask editor settings.

Declaration

TcxEditRepositoryMaskItem = class(
    TcxEditRepositoryItem
)

Remarks

A mask editor is a single-line text editor with support for masked user input.

The TcxEditRepositoryMaskItem class overrides the Properties property that allows you to access and customize mask 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.

Create a Mask Editor Repository Item at Design Time

To create a mask editor repository item at design time, double-click a TcxEditRepository 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 the MaskEdit item and click the Ok button to create a mask editor repository item.

Create a Mask Editor Repository Item in Code

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

Delphi

uses cxEdit, cxEditRepositoryItems;
// ...
var
  AMaskEditRepositoryItem: TcxEditRepositoryMaskItem;
  ARepositoryItem: TcxEditRepositoryItem;
begin
  ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryMaskItem);
  AMaskEditRepositoryItem := ARepositoryItem as TcxEditRepositoryMaskItem;
  AMaskEditRepositoryItem.Properties.MaxLength := 10; // Limits the input value length
  AMaskEditRepositoryItem.Properties.AutoSelect := False; // Disables automatic content selection
  // Assigns the created repository item to two existing unbound mask editors
  cxMaskEdit1.RepositoryItem := AMaskEditRepositoryItem;
  cxMaskEdit2.RepositoryItem := AMaskEditRepositoryItem;
end;

C++

#include "cxEdit.hpp"
#include "cxEditRepositoryItems.hpp"
// ...
  TcxEditRepositoryMaskItem *AMaskEditRepositoryItem;
  TcxEditRepositoryItem *ARepositoryItem;
  // ...
  ARepositoryItem = cxEditRepository1->CreateItem(__classid(TcxEditRepositoryMaskItem));
  AMaskEditRepositoryItem = dynamic_cast<TcxEditRepositoryMaskItem*>(ARepositoryItem);
  AMaskEditRepositoryItem->Properties->MaxLength = 10; // Limits the input value length
  AMaskEditRepositoryItem->Properties->AutoSelect = false; // Disables automatic content selection
  // Assigns the created repository item to two existing unbound mask editors
  cxMaskEdit1->RepositoryItem = AMaskEditRepositoryItem;
  cxMaskEdit2->RepositoryItem = AMaskEditRepositoryItem;

Mask Editor Repository Item Deletion

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

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

Inheritance

TObject

TPersistent

TComponent

TcxEditRepositoryItem

TcxEditRepositoryMaskItem