TcxPivotGridField.Properties Property

Provides access to active editor settings.

Declaration

delphi

property Properties: TcxCustomEditProperties read; write;

Property Value

Type	Description
TcxCustomEditProperties

Stores settings that correspond to the active editor type.

Cast the property value to the corresponding class of editor settings to access all public API members. Call the Properties.ClassType function to identify the actual class of editor settings.

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

Remarks

A pivot grid field can use any editor shipped with the ExpressEditors Library to display data in cells.

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

Available In-Place Editors

PropertiesClass Value	In-Place Editor	Description
TdxBarCodeProperties	TdxBarCode	A barcode control without user input functionality.
TcxBlobEditProperties	TcxBlobEdit	A Binary Large Object (BLOB) editor.
TcxButtonEditProperties	TcxButtonEdit	A single-line text editor with embedded buttons.
TcxCalcEditProperties	TcxCalcEdit	A single-line editor with a drop-down calculator window.
TcxCheckBoxProperties	TcxCheckBox	A check box editor with support for three states.
TcxCheckComboBoxProperties	TcxCheckComboBox	A combo box editor that can display items with check boxes.
TcxCheckGroupProperties	TcxCheckGroup	An editor designed to display a set of check boxes.
TcxColorComboBoxProperties	TcxColorComboBox	A color combo box editor.
TdxColorEditProperties	TdxColorEdit	An editor designed to select a color in a color gallery embedded into a drop-down window.
TcxComboBoxProperties	TcxComboBox	A general-purpose combo box editor.
TcxCurrencyEditProperties	TcxCurrencyEdit	A numeric editor for currency values.
TcxDateEditProperties	TcxDateEdit	A date editor with a drop-down calendar.
TdxDateTimeWheelPickerProperties	TdxDateTimeWheelPicker	A date/time wheel picker editor.
TcxExtLookupComboBoxProperties	TcxExtLookupComboBox	A lookup editor that displays a Data Grid View in a drop-down window.
TcxFontNameComboBoxProperties	TcxFontNameComboBox	A combo box that allows users to switch between font typefaces.
TdxFormattedLabelProperties	TdxFormattedLabel	A formatted label editor without user input functionality.
TcxHyperlinkEditProperties	TcxHyperLinkEdit	A hyperlink editor that can execute custom commands.
TcxImageProperties	TcxImage	An editor designed to display images.
TcxImageComboBoxProperties	TcxImageComboBox	A combo box whose items can display text and images.
TcxLabelProperties	TcxLabel	An unformatted label editor without user input functionality.
TcxLookupComboBoxProperties	TcxLookupComboBox	A lookup combo box populated with values from a data source.
TdxLookupSparklineProperties	TdxLookupSparklineEdit	A lookup sparkline editor.
TcxMaskEditProperties	TcxMaskEdit	A single-line text editor with support for input masks.
TcxMemoProperties	TcxMemo	A multi-line editor for plain text.
TcxMRUEditProperties	TcxMRUEdit	A single-line text editor that displays a list of most recently used (MRU) items in a drop-down window.
TdxNumericWheelPickerProperties	TdxNumericWheelPicker	A numeric value wheel picker editor.
TdxOfficeSearchBoxProperties	TdxOfficeSearchBox	A search box that suggests Ribbon or Toolbar UI elements based on user input.
TcxPopupEditProperties	TcxPopupEdit	A text editor that can embed a control in a drop-down window.
TcxProgressBarProperties	TcxProgressBar	A progress bar.
TcxRadioGroupProperties	TcxRadioGroup	A container for radio buttons.
TdxRangeTrackBarProperties	TdxRangeTrackBar	A track bar editor with two sliders for value range selection.
TdxRatingControlProperties	TdxRatingControl	A rating control.
TcxRichEditProperties	TcxRichEdit	A multi-line rich text editor.
TcxShellComboBoxProperties	TcxShellComboBox	An editor that combines a combo box and a Shell Tree View control.
TdxSparklineProperties	TdxSparklineEdit	An editor that visualizes data as lightweight charts without axes and labels.
TcxSpinEditProperties	TcxSpinEdit	A general-purpose numeric spin editor.
TcxTextEditProperties	TcxTextEdit	A simple single-line text editor.
TcxTimeEditProperties	TcxTimeEdit	A spin editor for time values.
TdxToggleSwitchProperties	TdxToggleSwitch	A toggle switch editor.
TdxTokenEditProperties	TdxTokenEdit	A token editor.
TcxTrackBarProperties	TcxTrackBar	A track bar editor with one slider.

Tip

To identify the actual class of active editor settings, call the Properties.ClassType function.

Design-Time Functionality

You can select any available editor in a drop-down list of a pivot grid field’s Properties node displayed in the Object Inspector:

Code Example: Display Cell Values as Progress Bars

The following code example assigns a progress bar editor to a pivot grid field that displays percentages:

Delphi
C++

delphi

// ...
uses
  cxProgressBar;
// ...
var
  AProperties: TcxProgressBarProperties;
begin
  pgfQuantityPercent.PropertiesClass := TcxProgressBarProperties;
  AProperties := pgfQuantityPercent.Properties as TcxProgressBarProperties;
  AProperties.BarStyle := cxbsAnimation;
  AProperties.BeginColor := clLime;
end;

cpp

// ...
#pragma link "cxProgressBar"
// ...
  TcxProgressBarProperties *AProperties;
  // ...
  pgfQuantityPercent->PropertiesClass = __classid(TcxProgressBarProperties);
  AProperties = dynamic_cast<TcxProgressBarProperties*>(pfgQuantityPercent->Properties);
  AProperties->BarStyle = cxbsAnimation;
  AProperties->BeginColor = clLime;

Important Limitations

If an editor has unbound and data-aware versions, you can use only its unbound version to display data in cells.
If the RepositoryItem property is specified, Properties, PropertiesClass, and PropertiesClassName property values are ignored.

Important

Do not change PropertiesClass, PropertiesClassName, and Properties property values in an OnGetProperties event handler. Otherwise, drawing errors and access violations may occur.

To change the active editor and modify its settings safely within these event handlers, use the RepositoryItem property and TcxEditRepositoryItem class descendants. Refer to the OnGetProperties event description for detailed information and a code example.

Default Editors

A pivot grid field uses the default editor to display data if Properties, PropertiesClass, and PropertiesClassName properties are unspecified. The pivot grid field uses one of the following editors as default depending on DataBinding.ValueType and DataBinding.ValueTypeClass property values:

ValueType[1]	ValueTypeClass[1]	Default Editor
`Boolean`	TcxBooleanValueType	TcxCheckBox
`Currency`	TcxCurrencyValueType	TcxCurrencyEdit
`DateTime`	TcxDateTimeValueType	TcxDateEdit
`FMTBcd`	TcxFMTBcdValueType	TcxCurrencyEdit
`SQLTimeStamp`	TcxSQLTimeStampValueType	TcxDateEdit
Any other value	Any other value	TcxTextEdit

Footnotes

DataBinding.ValueType and DataBinding.ValueTypeClass property values define the default in-place editor for the pivot grid field regardless of the active data access mode.