Skip to main content

TdxSpreadSheetAction Class

The base class for action classes that implements all end-user commands in Spreadsheet and Report Designer-based applications.

Declaration

TdxSpreadSheetAction = class(
    TdxCustomAction
)

Remarks

This class provides the following members that allow you to:

  • Assign the caption for an action object linked to a UI element (Caption and AssignedValues.Caption);

  • Assign the custom help hint for an action object linked to a UI element (Hint and AssignedValues.Hint);

  • Execute a command associated with an action object in response to a certain event occurring in your application (Execute and ExecuteTarget);

  • Identify whether the UI elements associated with an action object can be updated (IsLocked);

  • Manage updating of UI elements associated with an action object (BeginUpdate, CancelUpdate, and EndUpdate);

  • Specify a Spreadsheet or Report Designer control instance to which an action object belongs (Control);

  • Force updating a UI element linked to an action object (UpdateTarget).

All classes that implement custom action objects in the Spreadsheet and Report Designer controls must be derived from the TdxSpreadSheetAction class. You do not need to create instances of this class. Use its descendants instead.

See Also