TcxEditRepositoryRatingControl Class

A repository item that stores rating control settings.

Declaration

TcxEditRepositoryRatingControl = class(
    TcxEditRepositoryItem
)

Remarks

A rating control allows users to rate content. Rating controls support custom element images.

The TcxEditRepositoryRatingControl class overrides the Properties property that allows you to access and customize rating control 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 Rating Control Repository Item at Design Time

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

Create a Rating Control Repository Item in Code

The following code example creates a rating control repository item, customizes rating control settings, and assigns the created repository item to two unbound rating controls:

Delphi

uses cxEdit, cxExtEditRepositoryItems;
// ...
var
  ARatingControlRepositoryItem: TcxEditRepositoryRatingControl;
  ARepositoryItem: TcxEditRepositoryItem;
begin
  ARepositoryItem := cxEditRepository1.CreateItem(TcxEditRepositoryRatingControl);
  ARatingControlRepositoryItem := ARepositoryItem as TcxEditRepositoryRatingControl;
  ARatingControlRepositoryItem.Properties.ItemCount := 10; // Changes the number of elements
  ARatingControlRepositoryItem.Properties.FillPrecision := rcfpExact; // Allows fractional rating
  ARatingControlRepositoryItem.Properties.Step := 0.1; // Changes the element fill step
  // Assigns the created repository item to two existing unbound rating controls
  dxRatingControl1.RepositoryItem := ARatingControlRepositoryItem;
  dxRatingControl2.RepositoryItem := ARatingControlRepositoryItem;
end;

C++

#include "cxEdit.hpp"
#include "cxExtEditRepositoryItems.hpp"
// ...
  TcxEditRepositoryRatingControl *ARatingControlRepositoryItem;
  TcxEditRepositoryItem *ARepositoryItem;
  // ...
  ARepositoryItem = cxEditRepository1->CreateItem(__classid(TcxEditRepositoryRatingControl));
  ARatingControlRepositoryItem = dynamic_cast<TcxEditRepositoryRatingControl*>(ARepositoryItem);
  ARatingControlRepositoryItem->Properties->ItemCount = 10; // Changes the number of elements
  ARatingControlRepositoryItem->Properties->FillPrecision = rcfpExact; // Allows fractional rating
  ARatingControlRepositoryItem->Properties->Step = 0.1; // Changes the element fill step
  // Assigns the created repository item to two existing unbound rating controls
  dxRatingControl1->RepositoryItem = ARatingControlRepositoryItem;
  dxRatingControl2->RepositoryItem = ARatingControlRepositoryItem;

Rating Control Repository Item Deletion

To delete all rating control repository items in a TcxEditRepository component, call its RemoveItems procedure and pass a reference to the TcxEditRepositoryRatingControl 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

TcxEditRepositoryRatingControl