2022 April Release

Class FSCPDFANNOTATIONS@1.1001:Layer Permanent link for this heading

Class Hierarchy

Object > BasicObject > Layer

Layer object that contains annotations raw data represented as a dictionary that is a structural equivalent of a PDF-document's COS-hierarchy. Modify these dictionary contents only using the desired API.

Additional Information

Properties Permanent link for this heading

Type

Property

Name

Annotation[]

allannotations

PDF Annotation Data

Annotation[]

annotations

PDF Annotation Data

Content

content

File

Object[]

ctxobjects

Context Objects

boolean

deleted

Deleted

Object

document

Referenced Document

dictionary

jsonannotations

PDF Annotation Data

LayerType

ltype

Layer Type

boolean

original

Original Comments

string

rawdata

Raw Data

string

refversname

Review Version Name

integer

refversnr

Referenced Version

User

responsible

Responsible User

Actions Permanent link for this heading

Return Type

Signature

void

AddCaretAnnotation(
  integer pagenum,
  float[] rect,
  optional string notetext,
  optional float[] color,
  optional integer flags,
  optional float[] popuprect)

void

AddCircleAnnotation(
  integer pagenum,
  float[] rect,
  optional string notetext,
  optional float[] color,
  optional float[] fillcolor,
  optional integer flags,
  optional float[] popuprect)

void

AddFreeTextAnnotation(
  integer pagenum,
  float[] rect,
  string text,
  optional integer flags)

void

AddHighlightAnnotation(
  integer pagenum,
  float[] rect,
  float[] quadpoints,
  optional string notetext,
  optional float[] color,
  optional integer flags,
  optional float[] popuprect)

void

AddJSONHighlightAnnotation(
  integer pagenum,
  float[] rect,
  float[] quadpoints,
  optional string notetext,
  optional float[] color,
  optional integer flags,
  optional float[] popuprect)

void

AddLineAnnotation(
  integer pagenum,
  float[] line,
  optional string notetext,
  optional float[] color,
  optional integer flags,
  optional float[] popuprect)

void

AddRecentlyUsed(
  object context,
  optional object[] additionalobjects)

void

AddSquareAnnotation(
  integer pagenum,
  float[] rect,
  optional string notetext,
  optional float[] color,
  optional float[] fillcolor,
  optional integer flags,
  optional float[] popuprect)

void

AddStrikeOutAnnotation(
  integer pagenum,
  float[] rect,
  float[] quadpoints,
  optional string notetext,
  optional float[] color,
  optional integer flags,
  optional float[] popuprect)

void

AddUnderlineAnnotation(
  integer pagenum,
  float[] rect,
  float[] quadpoints,
  optional string notetext,
  optional float[] color,
  optional integer flags,
  optional float[] popuprect)

void

AttrAnnotatedContentGetPostWrapper(
  AttributeDefinition attrdef,
  ref any[] value,
  ref optional boolean volatile,
  ref optional boolean volatiletx)

void

AttrAnnotatedContentSetPreWrapper(
  AttributeDefinition attrdef)

void

AttrDocumentSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrLTypeSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

boolean

CheckCollaboratorChange(
  object[] changedattrdefs,
  optional boolean silent,
  out retval boolean allowed)

WatermarkSettings

GetWatermarkSettings(
  boolean checkaccess,
  out retval WatermarkSettings watermarksettings,
  out boolean hassettings)

void

LogHistoryEvent(
  any type,
  optional object event,
  optional LanguageStringList[] description,
  optional datetime timestamp,
  optional object user,
  optional object group,
  optional object position,
  optional object substuser,
  optional DocState docstate,
  optional string[] args)

void

LogReducedHistoryEvent(
  HistoryEventType type,
  object[] changeobjs,
  boolean oncontainer,
  optional object event)

void

UpdateAnnotation(
  ref Annotation annotation,
  optional string title,
  optional string contents)

void

ValidateAnnotation(
  Annotation anno)

void

ValidateAnnotations()