TdxRichEditControlInsertFigureCaption Class

An action object that corresponds to the InsertFigureCaption command provided by the Rich Edit control.

Declaration

TdxRichEditControlInsertFigureCaption = class(
    TdxRichEditControlAction
)

Remarks

This class does not introduce any new public members. Executing a TdxRichEditControlInsertFigureCaption action object inserts a SEQ field with the Figure identifier at the caret position within the current document. An end-user can insert a table of figures based on existing figure captions by using the InsertTableOfFigures command provided by a TdxRichEditControlInsertTableOfFigures action object.

UI elements linked to a TdxRichEditControlInsertFigureCaption action object are enabled only if the following conditions are met:

The Rich Edit control’s ReadOnly property is set to False;
The current selection (i.e., the caret or text selection) is not located within the document header or footer.

To localize the caption and hint displayed by UI elements linked to a TdxRichEditControlInsertFigureCaption action object, use the sdxRichEditCommandInsertFigureCaptionMenuCaption and sdxRichEditCommandInsertFigureCaptionDescription resource strings, respectively.