Interface IRedactionAnnotation

Obscures one or more regions of a page. Redactions are overlays; the underlying content is preserved and is only hidden from users without the right to see through redactions.

interface IRedactionAnnotation {
    accessType?: AnnotationAccessControlType;
    comment?: string;
    createdTime?: Date;
    creator?: string;
    customData?: string;
    entryId?: number;
    isProtected?: boolean;
    isReadOnly?: boolean;
    isWhiteout?: boolean;
    itemId?: number;
    lastModifiedTime?: Date;
    pageNumber?: number;
    reasonId?: number;
    rectangles?: AnnotationRectangle[];
    textEnd?: number;
    textStart?: number;
    visibility?: AnnotationVisibility;
    zOrder?: number;
}

Hierarchy (View Summary)

Implemented by

Properties

accessType? comment? createdTime? creator? customData? entryId? isProtected? isReadOnly? isWhiteout? itemId? lastModifiedTime? pageNumber? reasonId? rectangles? textEnd? textStart? visibility? zOrder?

Properties

OptionalaccessType

accessType?: AnnotationAccessControlType

How the annotation participates in access control.

Optionalcomment

comment?: string

An optional comment on the annotation.

OptionalcreatedTime

createdTime?: Date

The UTC time the annotation was created.

Optionalcreator

creator?: string

The security identifier (SID) of the user that created the annotation.

OptionalcustomData

customData?: string

Optional application-defined custom data stored with the annotation.

OptionalentryId

entryId?: number

The ID of the document entry the annotation belongs to.

OptionalisProtected

isProtected?: boolean

A boolean indicating whether the annotation is protected so that only its creator can modify it.

OptionalisReadOnly

isReadOnly?: boolean

A boolean indicating whether the annotation is read-only (for example, on an archived version).

OptionalisWhiteout

isWhiteout?: boolean

A boolean indicating whether the region is whited out (true) rather than blacked out (false).

OptionalitemId

itemId?: number

The identifier of the annotation, unique within its page.

OptionallastModifiedTime

lastModifiedTime?: Date

The UTC time the annotation was last modified.

OptionalpageNumber

pageNumber?: number

The 1-based page number the annotation is on.

OptionalreasonId

reasonId?: number

The ID of the redaction reason associated with the annotation, if any.

Optionalrectangles

rectangles?: AnnotationRectangle[]

The rectangular regions covered by the redaction.

OptionaltextEnd

textEnd?: number

The end offset of the linked text span, or -1 when not linked to text.

OptionaltextStart

textStart?: number

The start offset of the linked text span, or -1 when not linked to text.

Optionalvisibility

visibility?: AnnotationVisibility

Controls who can see the annotation.

OptionalzOrder

zOrder?: number

The z-order of the annotation; higher values draw on top.

Settings

Member Visibility

On This Page

Properties