Skip to main content

TdxRichEditControlAction Class

The base class for all action objects in the Rich Edit control.

Declaration

TdxRichEditControlAction = class abstract(TdxBasicAction)

Remarks

The TdxRichEditControlAction class provides 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 Rich Edit 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 Rich Edit control must be derived from the TdxRichEditControlAction class. You do not need to create instances of this class. At design time, you can manually add its descendants to a TActionList component and link them to UI elements to provide the corresponding commands to end-users. Alternatively, you can use the automatic Ribbon or Toolbar UI generation feature to create fully functional UI sets suitable for modern word processors.

See Also