Skip to main content

TcxEditRepositoryImageItem Class

Declaration

TcxEditRepositoryImageItem = class(
    TcxEditRepositoryItem
)

Remarks

An image editor can store and display an image. Image editors support clipboard operations and allow users to manage the displayed image.

VCL Editors Library: An Image Editor Example

The TcxEditRepositoryImageItem class overrides the Properties property that allows you to access and customize image 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 an Image Editor Repository Item at Design Time

To create an image editor repository item at design time, double-click an edit repository 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 Image item and click the Ok button to create an image editor repository item.

Create an Image Editor Repository Item in Code

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

uses cxEdit, cxEditRepositoryItems;
// ...
var
  AImageRepositoryItem: TcxEditRepositoryImageItem;
  ARepositoryItem: TcxEditRepositoryItem;
begin
  ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryImageItem);
  AImageRepositoryItem := ARepositoryItem as TcxEditRepositoryImageItem;
  AImageRepositoryItem.FitMode := ifmFill; // Fills an editor with an image
  AImageRepositoryItem.ShowFocusRect := False; // Hides the focus rectangle
  // Assigns the created repository item to two existing unbound image editors
  cxImage1.RepositoryItem := AImageRepositoryItem;
  cxImage2.RepositoryItem := AImageRepositoryItem;
end;

Image Editor Repository Item Deletion

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

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