Interface ITextBoxAnnotation

A bordered text box drawn on a page.

interface ITextBoxAnnotation {
    accessType?: LfRepositoryClientV2.AnnotationAccessControlType;
    borderColor?: string;
    borderStyle?: LfRepositoryClientV2.LineStyle;
    borderThickness?: number;
    comment?: string;
    coordinates?: LfRepositoryClientV2.AnnotationRectangle;
    createdTime?: Date;
    creator?: string;
    customData?: string;
    direction?: LfRepositoryClientV2.TextDirection;
    entryId?: number;
    fillColor?: string;
    isProtected?: boolean;
    isReadOnly?: boolean;
    itemId?: number;
    lastModifiedTime?: Date;
    opacity?: number;
    pageNumber?: number;
    reasonId?: number;
    text?: string;
    textSize?: number;
    visibility?: LfRepositoryClientV2.AnnotationVisibility;
    zOrder?: number;
}

Hierarchy (View Summary)

Implemented by

Properties

accessType? borderColor? borderStyle? borderThickness? comment? coordinates? createdTime? creator? customData? direction? entryId? fillColor? isProtected? isReadOnly? itemId? lastModifiedTime? opacity? pageNumber? reasonId? text? textSize? visibility? zOrder?

Properties

OptionalaccessType

accessType?: LfRepositoryClientV2.AnnotationAccessControlType

How the annotation participates in access control.

OptionalborderColor

borderColor?: string

The border color as an RGB hex string; null if transparent.

OptionalborderStyle

borderStyle?: LfRepositoryClientV2.LineStyle

The border stroke style.

OptionalborderThickness

borderThickness?: number

The border thickness in pixels.

Optionalcomment

comment?: string

An optional comment on the annotation.

Optionalcoordinates

coordinates?: LfRepositoryClientV2.AnnotationRectangle

The bounding rectangle of the text box.

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.

Optionaldirection

direction?: LfRepositoryClientV2.TextDirection

The reading direction of the text.

OptionalentryId

entryId?: number

The ID of the document entry the annotation belongs to.

OptionalfillColor

fillColor?: string

The fill color as an RGB hex string; null if not filled.

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).

OptionalitemId

itemId?: number

The identifier of the annotation, unique within its page.

OptionallastModifiedTime

lastModifiedTime?: Date

The UTC time the annotation was last modified.

Optionalopacity

opacity?: number

The opacity of the text box as a percentage (0-100).

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.

Optionaltext

text?: string

The text displayed in the box.

OptionaltextSize

textSize?: number

The font size of the text in points.

Optionalvisibility

visibility?: LfRepositoryClientV2.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