Skip to main content
A newer version of this page is available. .

TdxRichEditControlToggleFontUnderline Class

An action object that corresponds to the ToggleFontUnderline command in the Rich Edit control.

Declaration

TdxRichEditControlToggleFontUnderline = class(
    TdxRichEditControlAction
)

Remarks

This class does not introduce any new public members. Executing a TdxRichEditControlToggleFontUnderline action object applies/removes the Underline font attribute to/from:

  • The text selection(s) in a document (including text selected within a text box or table);

  • The edited word (i.e., the word in which the caret is currently located);

  • The currently used font (if no text is selected, and the caret is not located within a word).

The state of UI elements linked to a TdxRichEditControlToggleFontUnderline action object is determined by the Rich Edit control’s Options.DocumentCapabilities.CharacterFormatting property value. Refer to the TdxDocumentCapability type description for the full list of available command states.

To localize the caption and hint displayed by UI elements linked to a TdxRichEditControlToggleFontUnderline action object, use the sdxRichEditCommandToggleFontUnderlineMenuCaption and sdxRichEditCommandToggleFontUnderlineDescription resource strings, respectively.

Note

Applying the Underline font attribute automatically removes the Double Underline font attribute (if set).

See Also