TcxEditRepositoryLabel Class

A repository item that stores unformatted label settings.

Declaration

TcxEditRepositoryLabel = class(
    TcxEditRepositoryItem
)

Remarks

An unformatted label is designed to display a static inscription with support for multiple effects.

The TcxEditRepositoryLabel class overrides the Properties property that allows you to access and customize unformatted label 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 Label Repository Item at Design Time

To create a label 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 Label item and click the Ok button to create a label repository item.

Create a Label Repository Item in Code

The following code example creates a label repository item, customizes label settings, and assigns the created repository item to two unbound labels:

Delphi

uses cxEdit, cxExtEditRepositoryItems;
// ...
var
  ALabelRepositoryItem: TcxEditRepositoryLabel;
  ARepositoryItem: TcxEditRepositoryItem;
begin
  ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryLabel);
  ALabelRepositoryItem := ARepositoryItem as TcxEditRepositoryLabel;
  ALabelRepositoryItem.Properties.Angle := 45; // Rotates labels counterclockwise
  ALabelRepositoryItem.Properties.WordWrap := True; // Enables word wrap
  // Assigns the created repository item to two existing unbound labels
  cxLabel1.RepositoryItem := ALabelRepositoryItem;
  cxLabel2.RepositoryItem := ALabelRepositoryItem;
end;

C++

#include "cxEdit.hpp"
#include "cxExtEditRepositoryItems.hpp"
// ...
  TcxEditRepositoryLabel *ALabelRepositoryItem;
  TcxEditRepositoryItem *ARepositoryItem;
  // ...
  ARepositoryItem = cxEditRepository1->CreateItem(__classid(TcxEditRepositoryLabel));
  ALabelRepositoryItem = dynamic_cast<TcxEditRepositoryLabel*>(ARepositoryItem);
  ALabelRepositoryItem->Properties->Angle = 45;  // Rotates labels counterclockwise
  ALabelRepositoryItem->Properties->WordWrap = true; // Enables word wrap
  // Assigns the created repository item to two existing unbound labels
  cxLabel1->RepositoryItem = ALabelRepositoryItem;
  cxLabel2->RepositoryItem = ALabelRepositoryItem;

Label Repository Item Deletion

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

If you need to delete an individual label 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

TcxEditRepositoryLabel