2024 April Release

Class FSCPDFANNOTATIONS@1.1001:Layer Permanent link for this heading

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.

Class Hierarchy

Object > BasicObject > Layer

Properties Permanent link for this heading

Type

Property

Name

Content

content

File

Actions Permanent link for this heading

Return Type

Signature

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,
  optional boolean nolocktimeout)

Properties Permanent link for this heading


File (COOSYSTEM@1.1:content) Permanent link for this heading

Defines the multimedia content of the object and information like the size of the content or the date of the last change.

Explanation:
Defines the content.

Content COOSYSTEM@1.1:content

Additional Information

Actions Permanent link for this heading


FSCFOLIO@1.1001:LogHistoryEvent Permanent link for this heading

This action can be called to store important events in the life time of an object.

Note: In batch mode and bulk load mode will no history events be recorded.
To force recording history events in batch and bulk load mode to the transaction variable TV_BATCHMODE_LOG_HISTORY can be used.

Hint: If some history events should not be recorded in the current transaction the transaction variable TV_SUPPRESSEDEVENTCATEGORIES can be used.

void FSCFOLIO@1.1001: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,
  optional boolean nolocktimeout)

Name

Description

type

The type of the event to be logged.

event

An object that is the main data of the event.

description

Obsolete. Multilingual string of the event, this should not be supplied any more.

timestamp

an optional timestamp when the history event occurred. If not set the coonow will be used

user

Optional. The user who initiated the event, if omitted the current user is used.

group

Optional. The group of the initiating user, if omitted the current group is used.

position

Optional. The position of the initiating user, if omitted the current position is used.

substuser

Optional. The user who substitutes the initiating user, if omitted the current substituting user is used.

docstate

Optional. The new docstate if business documents are modified.

args

Optional. Additional arguments for printing the description text of the event. These have to be expression language constants, i.e. 1,"text", 2010-01-30 12:00:00.

nolocktimeout

defines if the default lock timeout should be skipped.