Back to Devexpress

TcxCustomBarEditItem.PropertiesClass Property

vcl-cxbaredititem-dot-tcxcustombaredititem-0fca92e3.md

latest11.4 KB
Original Source

TcxCustomBarEditItem.PropertiesClass Property

Specifies the reference to the editor properties class that corresponds to the active in-place editor type.

Declaration

delphi
property PropertiesClass: TcxCustomEditPropertiesClass read; write;

Property Value

TypeDescription
TcxCustomEditPropertiesClass

The class-reference to the editor properties class that corresponds to the active in-place editor type.

Refer to the Remarks section for the full list of in-place editor types.

|

Remarks

A toolbar edit item can use any editor shipped with the ExpressEditors Library as an in-place editor. An in-place editor instance exists (and, therefore, has its own WinAPI handle) only when a user activates it. Otherwise, a toolbar edit item displays a static editor image for resource usage optimization.

Use the PropertiesClass property to switch between available in-place editors if the RepositoryItem property is unspecified.

To configure the active in-place editor, use the Properties property.

Available In-Place Editors

PropertiesClass ValueIn-Place EditorDescription
TdxBarCodePropertiesTdxBarCodeA barcode control without user input functionality.
TcxBlobEditPropertiesTcxBlobEditA Binary Large Object (BLOB) editor.
TcxButtonEditPropertiesTcxButtonEditA single-line text editor with embedded buttons.
TcxCalcEditPropertiesTcxCalcEditA single-line editor with a drop-down calculator window.
TcxCheckBoxPropertiesTcxCheckBoxA check box editor with support for three states.
TcxCheckComboBoxPropertiesTcxCheckComboBoxA combo box editor that can display items with check boxes.
TcxCheckGroupPropertiesTcxCheckGroupAn editor designed to display a set of check boxes.
TcxColorComboBoxPropertiesTcxColorComboBoxA color combo box editor.
TdxColorEditPropertiesTdxColorEditAn editor designed to select a color in a color gallery embedded into a drop-down window.
TcxComboBoxPropertiesTcxComboBoxA general-purpose combo box editor.
TcxCurrencyEditPropertiesTcxCurrencyEditA numeric editor for currency values.
TcxDateEditPropertiesTcxDateEditA date editor with a drop-down calendar.
TdxDateTimeWheelPickerPropertiesTdxDateTimeWheelPickerA date/time wheel picker editor.
TcxExtLookupComboBoxPropertiesTcxExtLookupComboBoxA lookup editor that displays a Data Grid View in a drop-down window.
TcxFontNameComboBoxPropertiesTcxFontNameComboBoxA combo box that allows users to switch between font typefaces.
TdxFormattedLabelPropertiesTdxFormattedLabelA formatted label editor without user input functionality.
TcxHyperlinkEditPropertiesTcxHyperLinkEditA hyperlink editor that can execute custom commands.
TcxImagePropertiesTcxImageAn editor designed to display images.
TcxImageComboBoxPropertiesTcxImageComboBoxA combo box whose items can display text and images.
TcxLabelPropertiesTcxLabelAn unformatted label editor without user input functionality.
TcxLookupComboBoxPropertiesTcxLookupComboBoxA lookup combo box populated with values from a data source.
TdxLookupSparklinePropertiesTdxLookupSparklineEditA lookup sparkline editor.
TcxMaskEditPropertiesTcxMaskEditA single-line text editor with support for input masks.
TcxMemoPropertiesTcxMemoA multi-line editor for plain text.
TcxMRUEditPropertiesTcxMRUEditA single-line text editor that displays a list of most recently used (MRU) items in a drop-down window.
TdxNumericWheelPickerPropertiesTdxNumericWheelPickerA numeric value wheel picker editor.
TdxOfficeSearchBoxPropertiesTdxOfficeSearchBoxA search box that suggests Ribbon or Toolbar UI elements based on user input.
TcxPopupEditPropertiesTcxPopupEditA text editor that can embed a control in a drop-down window.
TcxProgressBarPropertiesTcxProgressBarA progress bar.
TcxRadioGroupPropertiesTcxRadioGroupA container for radio buttons.
TdxRangeTrackBarPropertiesTdxRangeTrackBarA track bar editor with two sliders for value range selection.
TdxRatingControlPropertiesTdxRatingControlA rating control.
TcxRichEditPropertiesTcxRichEditA multi-line rich text editor.
TcxShellComboBoxPropertiesTcxShellComboBoxAn editor that combines a combo box and a Shell Tree View control.
TdxSparklinePropertiesTdxSparklineEditAn editor that visualizes data as lightweight charts without axes and labels.
TcxSpinEditPropertiesTcxSpinEditA general-purpose numeric spin editor.
TcxTextEditPropertiesTcxTextEditA simple single-line text editor.
TcxTimeEditPropertiesTcxTimeEditA spin editor for time values.
TdxToggleSwitchPropertiesTdxToggleSwitchA toggle switch editor.
TdxTokenEditPropertiesTdxTokenEditA token editor.
TcxTrackBarPropertiesTcxTrackBarA track bar editor with one slider.

Editor Selection at Design Time

At design time, you can use the Object Inspector to select any available in-place editor. Click a toolbar edit item’s Properties node and select the required editor from the invoked drop-down list.

Code Example: Assign and Configure an In-Place Spin Editor

The following code example assigns a spin editor to the bar edit item and limits the editor’s input value range:

delphi
// ...
uses
  cxSpinEdit;
// ...
var
  ASpinEditProperties: TcxSpinEditProperties;
begin
  cxBarEditItem1.PropertiesClass := TcxSpinEditProperties; // Assigns an in-place spin editor
  ASpinEditProperties := cxBarEditItem1.Properties as TcxSpinEditProperties;
  ASpinEditProperties.MinValue := 0; // Sets the minimum edit value
  ASpinEditProperties.MaxValue := 1000; // Sets the maximum edit value
  ASpinEditProperties.Circular := True; // Loops value changes within the defined range
end;
cpp
// ...
#pragma link "cxSpinEdit"
// ...
  TcxSpinEditProperties *ASpinEditProperties;
  // ...
  cxBarEditItem1->PropertiesClass = __classid(TcxSpinEditProperties); // Assigns an in-place spin editor
  ASpinEditProperties = dynamic_cast<TcxSpinEditProperties*>(cxBarEditItem1.Properties);
  ASpinEditProperties->MinValue = 0; // Sets the minimum edit value
  ASpinEditProperties->MaxValue = 1000; // Sets the maximum edit value
  ASpinEditProperties->Circular = true; // Loops value changes within the defined range

Limitations

If an editor has unbound and data-aware versions, you can embed only unbound editors into bar edit items.

Default In-Place Editor Type

The bar edit item embeds a simple single-line text editor (TcxTextEdit) if PropertiesClass, PropertiesClassName, and RepositoryItem properties are unspecified.

See Also

TcxCustomBarEditItem.RepositoryItem Property

TdxBarItemLinks.AddItem Procedure

How to Add a Standalone Editor to a Toolbar

TcxCustomBarEditItem Class

TcxCustomBarEditItem Members

cxBarEditItem Unit