TdxSpreadSheetCommentContainer Class

A floating cell comment container.

Declaration

delphi

TdxSpreadSheetCommentContainer = class(
    TdxSpreadSheetCustomTextBoxContainer
)

Remarks

A comment container is a floating text box linked to an initialized cell. Each cell can have no more than a single floating comment. Comment containers are designed for use as reminders, clarifications, document feedback notes, etc.

The TdxSpreadSheetCommentContainer class extends a simple text box’s functionality with the following members that allow you to:

Move the comment container between initialized cells within the same worksheet (Cell);
Identify the comment author (Author);
Change the comment’s content and its appearance (TextBox).

To create a comment container, you can:

Call the Containers.Add procedure or the Containers.Add function of the target worksheet and pass the comment container’s class-reference ( TdxSpreadSheetCommentContainer ) as the AClass parameter;
Call the Containers.AddCommentContainer procedure or the Containers.AddCommentContainer function of the target worksheet and pass an initialized cell in it as the ACell parameter;
Call the Create constructor and pass the target worksheet as the AView parameter;
Execute the NewComment end-user command.

A worksheet’s Containers property provides indexed access to all floating containers. To expose a comment container’s type-specific members, cast the comment instance to the TdxSpreadSheetCommentContainer class.

Note

Comment containers support only a simple linear gradient as a background fill with only two key points and a single gradient area. Refer to the Shape.Brush property description for detailed information on limitations imposed on gradient fill support.

Inheritance

TObject TPersistent TInterfacedPersistent TdxSpreadSheetPersistentObject TdxSpreadSheetContainer TdxSpreadSheetShapeContainer TdxSpreadSheetCustomTextBoxContainer TdxSpreadSheetCommentContainer