Type alias ReplyToolSettings

ReplyToolSettings: { allowAddNote?: boolean; allowAddReply?: boolean; allowAddReplyOtherUser?: boolean; allowChangeOtherUser?: boolean; allowChangeUserName?: boolean; allowDelete?: boolean; allowDeleteOtherUser?: boolean; allowStatus?: boolean; allowStatusOtherUser?: boolean; annotationFocusColor?: string; autoExpandOnCommentAdd?: boolean; readOnly?: boolean; useColoredIcons?: boolean }

Settings for the Reply Tool.

Type declaration

  • Optional allowAddNote?: boolean

    Allow adding notes.

  • Optional allowAddReply?: boolean

    Allow adding replies.

  • Optional allowAddReplyOtherUser?: boolean

    Allow adding replies to other user notes.

  • Optional allowChangeOtherUser?: boolean

    Allow changing other user notes.

  • Optional allowChangeUserName?: boolean

    Allow changing user name.

  • Optional allowDelete?: boolean

    Allow deleting notes/replies.

  • Optional allowDeleteOtherUser?: boolean

    Allow deleting other user notes.

  • Optional allowStatus?: boolean

    Allow setting status.

  • Optional allowStatusOtherUser?: boolean

    Allow setting status for other user notes.

  • Optional annotationFocusColor?: string

    The color property that determines the color used for temporary highlighting of an annotation on the PDF page when the annotation is selected in the comments list in the ReplyTool.

    Example

    var viewer = new GcPdfViewer("#root", { replyTool: { annotationFocusColor: "blue" } });

    Property

    The color in hex format for the temporary highlight. This setting is also utilized in the showAnnotationFocusOutline method when the color parameter is not explicitly specified.

  • Optional autoExpandOnCommentAdd?: boolean

    Controls whether the Reply Tool automatically expands when a comment is added via the context menu.

    Property

    Set to true to enable automatic expansion, or false to disable it.

    Example

    // Disable automatic expansion of the Reply Tool.
    var viewer = new GcPdfViewer("#root", { replyTool: { autoExpandOnCommentAdd: false } });
  • Optional readOnly?: boolean

    Read-only mode.

  • Optional useColoredIcons?: boolean

    If set to true, comment icons will be filled with the color used in the annotation.

Settings

Member Visibility

Theme