Skip to main content

TdxSpreadSheetShowHideComments Class

An action object that implements the ShowHideComments end-user command in spreadsheet-based applications.

Declaration

TdxSpreadSheetShowHideComments = class(
    TdxSpreadSheetCustomCommentAction
)

Remarks

This class does not introduce any new public members. Its overridden Execute function toggles the visibility of all comment containers anchored to cells in the active worksheet. The ShowHideComments command never raises the OnCommentShow and OnCommentHide events.

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

  • Spreadsheet document edit operations are allowed (that is, the control’s OptionsBehavior.Editing property is set to True).
  • An in-place cell editor is inactive (the active worksheet’s IsEditing property returns False).
  • There is at least one comment container anchored to a cell in the active worksheet.
  • Comment container edit operations are allowed (the command is unavailable if the active worksheet is protected and its OptionsProtection.ActualAllowEditContainers property returns False).
See Also