TcxCustomEditorRowProperties.EditPropertiesClass Property

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

Declaration

property EditPropertiesClass: TcxCustomEditPropertiesClass read; write;

Property Value

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 available in-place editor types.

|

Remarks

A vertical grid row can use any editor shipped with the ExpressEditors Library as an in-place editor for cell edit operations. An in-place editor instance exists (and, therefore, has its own WinAPI handle) only when a data cell is being edited. Otherwise, the vertical grid row displays a static editor image for resource usage optimization.

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

Available In-Place Editors

Editor Selection at Design Time

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

Property Setter Behavior

The EditPropertiesClass property setter updates EditProperties and EditPropertiesClassName property values according to the selected in-place editor type.

Code Example: Create an Unbound Row and Configure Its In-Place Editor

The following code example creates an unbound vertical grid row, assigns an in-place spin editor, and customizes its settings:

• Delphi
• C++

// ...
uses
  cxSpinEdit;
// ...
var
  AEditorRow: TcxEditorRow;
  ASpinEditProperties: TcxSpinEditProperties;
begin
  AEditorRow := TcxEditorRow(cxVerticalGrid1.Add(TcxEditorRow)); // Creates an unbound vertical grid row
  AEditorRow.Properties.DataBinding.ValueType := 'Float'; // Changes the row value type to "Float"
  AEditorRow.EditPropertiesClass := TcxSpinEditProperties; // Assigns an in-place spin editor
  ASpinEditProperties := AEditorRow.Properties.EditProperties as TcxSpinEditProperties;
  ASpinEditProperties.MinValue := 0; // Sets the minimum edit value
  ASpinEditProperties.MaxValue := 100; // Sets the maximum edit value
  ASpinEditProperties.DisplayFormat := '0.00 %'; // Defines a formatting pattern for display text
  ASpinEditProperties.Circular := True; // Loops value changes within the defined range
end;

// ...
#pragma link "cxSpinEdit"
// ...
  TcxEditorRow *AEditorRow;
  TcxSpinEditProperties *ASpinEditProperties;
  // ...
  // Creates an unbound vertical grid row
  AEditorRow = dynamic_cast<TcxEditorRow*>(cxVerticalGrid1->Add(__classid(TcxEditorRow)));
  AEditorRow->Properties->DataBinding->ValueType = "Float"; // Changes the row value type to "Float"
  AEditorRow->EditPropertiesClass = __classid(TcxSpinEditProperties); // Assigns an in-place spin editor
  ASpinEditProperties = dynamic_cast<TcxSpinEditProperties*>(AEditorRow->Properties->EditProperties);
  ASpinEditProperties->MinValue = 0; // Sets the minimum edit value
  ASpinEditProperties->MaxValue = 100; // Sets the maximum edit value
  ASpinEditProperties->DisplayFormat = "0.00 %"; // Defines a formatting pattern for display text
  ASpinEditProperties->Circular = true; // Loops value changes within the defined range

Important Limitations

• If an editor has unbound and data-aware versions, you can use only its unbound version as an in-place editor.
• If the RepositoryItem property is specified, EditProperties, EditPropertiesClassName, and EditPropertiesClass property values are ignored.

Important

Do not change EditPropertiesClass, EditPropertiesClassName, and EditProperties property values in OnGetEditProperties and OnGetEditingProperties event handlers. Otherwise, drawing error 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 OnGetEditProperties and OnGetEditingProperties event descriptions for detailed information and code examples.

Default In-Place Editors

A vertical grid row uses the default in-place editor if EditProperties, EditPropertiesClass, EditPropertiesClassName, and RepositoryItem properties are unspecified. The vertical grid row uses one of the following in-place editors as default depending on DataBinding.ValueType and DataBinding.ValueTypeClass property values:

Footnotes

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

See Also

TcxCustomGridTableItem.PropertiesClass Property

TcxFilterItem.PropertiesClass Property

TcxCustomInplaceEditContainer.PropertiesClass Property

TcxCustomBarEditItem.PropertiesClass Property

TcxPivotGridField.PropertiesClass Property

TcxCustomEditorRowProperties Class

TcxCustomEditorRowProperties Members

cxVGrid Unit