TcxEditRepositoryFormattedLabel Class

A repository item that stores formatted label settings.

Declaration

TcxEditRepositoryFormattedLabel = class(
    TcxEditRepositoryItem
)

Remarks

A formatted label control is designed to display static text formatted with a set of BBCode-inspired markup tags.

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

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

Create a Formatted Label Repository Item in Code

The following code example creates a formatted label repository item, customizes label settings, and assigns the created repository item to two existing formatted label controls:

Delphi

uses cxEdit, cxEditRepositoryItems;
// ...
var
  AFormattedLabelRepositoryItem: TcxEditRepositoryFormattedLabel;
  ARepositoryItem: TcxEditRepositoryItem;
begin
  ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryFormattedLabel);
  AFormattedLabelRepositoryItem := ARepositoryItem as TcxEditRepositoryFormattedLabel;
  AFormattedLabelRepositoryItem.Properties.WordWrap := True;  // Wraps label text
  AFormattedLabelRepositoryItem.Properties.HyperlinkColor := clMoneyGreen;
  // Assigns the created repository item to two existing unbound formatted labels
  dxFormattedLabel1.RepositoryItem := AFormattedLabelRepositoryItem;
  dxFormattedLabel2.RepositoryItem := AFormattedLabelRepositoryItem;
end;

C++

#include "cxEdit.hpp"
#include "cxEditRepositoryItems.hpp"
// ...
  TcxEditRepositoryFormattedLabel *AFormattedLabelRepositoryItem;
  TcxEditRepositoryItem *ARepositoryItem;
  // ...
  ARepositoryItem = cxEditRepository1->CreateItem(__classid(TcxEditRepositoryFormattedLabel));
  AFormattedLabelRepositoryItem = dynamic_cast<TcxEditRepositoryFormattedLabel*>(ARepositoryItem);
  AFormattedLabelRepositoryItem->Properties->WordWrap = true; // Wraps label text
  AFormattedLabelRepositoryItem->Properties->HyperlinkColor = clMoneyGreen;
  // Assigns the created repository item to two existing unbound formatted labels
  dxFormattedLabel1->RepositoryItem = AFormattedLabelRepositoryItem;
  dxFormattedLabel2->RepositoryItem = AFormattedLabelRepositoryItem;

Formatted Label Repository Item Deletion

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

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

TcxEditRepositoryFormattedLabel