TdxSpreadSheetToggleFontUnderline Class

An action object that corresponds to the ToggleFontUnderline command provided by the Spreadsheet and Report Designer controls.

Declaration

TdxSpreadSheetToggleFontUnderline = class(
    TdxSpreadSheetCustomToggleFontStyleAction
)

Remarks

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

The values in all selected cells.
The text selection within an in-place cell editor (only if the rich content formatting functionality is enabled in the Spreadsheet/Report Designer control).

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

Spreadsheet document editing is allowed (i.e., the control’s OptionsBehavior.Editing property is set to True).
Cell formatting is allowed in the active worksheet (i.e., its OptionsProtection.ActualAllowFormatCells property returns True).
The in-place cell editor is inactive (the active worksheet‘s IsEditing property returns False). This condition is applicable only if the dxSpreadSheetTextService.IsRTFSupported function returns False.

If cell selection is disallowed in the protected worksheet (that is, its OptionsProtection.ActualAllowSelectUnlockedCells property returns False), executing the TdxSpreadSheetToggleFontUnderline action object has no effect.