TdxRichEditControlShowTableOfContentsForm Class

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

Declaration

TdxRichEditControlShowTableOfContentsForm = class(
    TdxRichEditControlAction
)

Remarks

This class does not introduce any new public members. Executing a TdxRichEditControlShowTableOfContentsForm action object invokes the Table of Contents dialog allowing an end-user to customize the appearance of the table of contents:

UI elements linked to a TdxRichEditControlShowTableOfContentsForm action object are visible only if the following conditions are met:

The Rich Edit control’s ReadOnly property is set to False;
The Rich Edit control’s Options.DocumentCapabilities.ParagraphStyle property is set to TdxDocumentCapability.Default or TdxDocumentCapability.Enabled;
The current selection is located within a table of contents.

To localize the caption displayed by UI elements linked to a TdxRichEditControlShowTableOfContentsForm action object, use the sdxRichEditCommandEditTOCMenuCaption resource string.

Note

A TdxRichEditControlShowTableOfContentsForm action object is normally used in the Rich Edit control’s context menu. Therefore, the linked UI elements display no hint (i.e., an empty string is assigned to the action’s Hint property).