Skip to main content

TcxEditRepositoryProgressBar Class

Declaration

TcxEditRepositoryProgressBar = class(
    TcxEditRepositoryItem
)

Remarks

A progress bar gradually fills from left to right or from bottom to top depending on its orientation.

VCL Editors Library: A Progress Bar Example

The TcxEditRepositoryProgressBar class overrides the Properties property that allows you to access and customize progress bar 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 Progress Bar Repository Item at Design Time

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

Create a Progress Bar Repository Item in Code

The following code example creates a progress bar repository item, customizes progress bar settings, and assigns the created repository item to two unbound progress bars:

uses cxEdit, cxExtEditRepositoryItems;
// ...
var
  AProgressBarRepositoryItem: TcxEditRepositoryProgressBar;
  ARepositoryItem: TcxEditRepositoryItem;
begin
  ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryProgressBar);
  AProgressBarRepositoryItem := ARepositoryItem as TcxEditRepositoryProgressBar;
  AProgressBarRepositoryItem.Properties.Orientation := cxorVertical; // Arranges the progress bar vertically
  AProgressBarRepositoryItem.Properties.Marquee := True; // Enables the marquee mode
  // Assigns the created repository item to two existing unbound progress bars
  cxProgressBar1.RepositoryItem := AProgressBarRepositoryItem;
  cxProgressBar2.RepositoryItem := AProgressBarRepositoryItem;
end;

Progress Bar Repository Item Deletion

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

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

Inheritance

See Also