Software Component FSCPDFANNOTATIONS@1.1001

Classes

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	Configuration
FSCPDFANNOTATIONS@1.1001	Layer	PDF Annotation Layer

Properties

Type	Property	Name
Annotation[]	allannotations	PDF Annotation Data
LayerType[]	annoallowedlayertypes	Allowed Types for Comments
boolean	annoallowreadmemberpublicannotations	Allow Read Member Public Annotations
Content	annocontent	Annotation Content
dictionary	annodata	Annotation Data
boolean	annoenable	Annotations Enabled
boolean	annofeatureenabled	Annotation Feature Enabled
string	annoid	ID
date	annolastlayerlinkedat	Last Annotation Added on/at
Layer[]	annolayers	All Layers
LayerType	annopreferredlayertype	Preferred Type for Comments
Annotation[]	annotations	PDF Annotation Data
string[]	annotexts	Comment Texts
AnnotationType	annotype	Annotation Type
Configuration	clientdomconf	PDF Annotation Handling
CPAnnotationFeatureEnabled[]	cpannotationfeatureenabled	Annotation Feature Enabled per Object
CPAnnotationFeatureEnabledClasses[]	cpannotationfeatureenabledclasses	Annotation Feature Enabled (Object Class List)
string[]	cpcpannotationfeatureenabledclassesclasslist	Expression
ObjectClass	cpcpannotationfeatureenabledclassesobjclass	Object Class
string[]	cpcpannotationfeatureenabledexpr	Expression
ObjectClass	cpcpannotationfeatureenabledobjclass	Object Class
Object[]	ctxobjects	Context Objects
Layer[]	currentannolayers	Layers
boolean	customname	Custom Description
boolean	deleted	Deleted
Object	document	Referenced Document
boolean	hasannotations	Annotations Available
dictionary	jsonannotations	PDF Annotation Data
LayerType	ltype	Layer Type
boolean	original	Original Comments
OriginalAnnotation[]	originalannotations	Original annotations
integer	pagenum	Page Number
string	parentid	Parent Annotation
string	rawdata	Raw Data
string	refversname	Review Version Name
integer	refversnr	Referenced Version
User	responsible	Responsible User
Content	reviewcont	Review Content
ReviewVersion[]	reviewversions	Review Versions
boolean	TV_INSTANTJSONCLIENT	Instant JSON Client
boolean	TV_NOANNOTATIONS	Suppress Annotations
LayerType	usrenvpreferredlayertype	Preferred Type for Comments

Actions

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	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	AnnotatePDF( ContentObject venv_pdfobject, integer venv_versionnumber, integer venv_layertype)
void	AttrAnnoAllowedLayerTypesGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrAnnoAllowReadMemberPublicAnnotationsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrAnnoEnableSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrAnnoFeatureEnabledGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrAnnoPreferredLayerTypeGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrAnnotatedContentGetPostWrapper( AttributeDefinition attrdef, ref any[] value, ref optional boolean volatile, ref optional boolean volatiletx)
void	AttrAnnotatedContentGetVersionPostWrapper( AttributeDefinition attrdef, integer versnr, ref any[] value, ref optional boolean volatile, ref optional boolean volatiletx)
void	AttrAnnotatedContentSetPreWrapper( AttributeDefinition attrdef)
void	AttrAnnoTextsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrAnnoTextsGetFts( AttributeDefinition attrdef, ref any value)
void	AttrCurrentAnnoLayersGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrDocumentSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrHasAnnotationsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrLTypeSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrReviewVersionsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrReviewVersionsSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	BakeInAnnotationData( ref content pdfcontent, dictionary annotdata)
Content	ConvertContentToFinalFormPreWrapper( ref optional object context, ref optional string format, out retval Content contentfinalform)
Layer	CreateClassificationLayer( optional string objname, out retval Layer layer)
void	DeleteAnnotationData( ref content pdfcontent, optional dictionary annodata)
void	ExtractAnnotationData( ref content pdfcontent, out dictionary annotdata)
dictionary[]	ExtractHighlightedText( Layer layer, optional integer version, out retval dictionary[] annotationtext)
dictionary[]	ExtractHighlightedTextUsingAnnots( Annotation[] annots, optional integer version, out retval dictionary[] annotationtext)
dictionary[]	ExtractHighlightedTextUsingDict( dictionary annodict, optional integer version, out retval dictionary[] annotationtext)
void	GenerateDefaultAppearance( ref dictionary annotdata, optional integer pagenum)
string	GetInstantJSONAnnotations( optional LayerType[] ltypes, optional integer reviewversion, optional string[] layeraddresses, out retval string instantjson)
Layer[]	GetInstantJSONLayers( optional LayerType[] ltypes, optional integer reviewversion, optional string[] layeraddresses, out retval Layer[] layers)
integer[]	GetSupportedAnnotationAPIVersions( out retval integer[] versions)
boolean	IsFeatureContextuallyDisabled( out retval boolean disabled)
boolean	IsPDFEncrypted( out retval boolean encrypted)
void	MergeAnnotationsToContent( optional AttributeContentDef dstattrdef)
void	MergeLayersToContent( ref content pdfcont, Layer[] layers, optional LayerMergeType mergetype, optional boolean excludeinstantjsonannotations, optional boolean generatedocumenttag)
void	ObjectCreateReviewVersion( optional integer unused1, optional integer unused2)
void	ObjectCreateReviewVersionSelected( optional integer unused1, optional integer unused2)
void	ObjectDelVersionPreWrapper()
void	ObjectSendCommentedPdf( optional integer unused1, optional integer unused2)
void	PreparePDFForAnnotating( ref content pdfcontent)
void	PrepareReviewContent( optional boolean initialize)
void	ReadAnnotationData( content pdfcontent, out dictionary annotdata)
void	SaveAnnotationData( dictionary annodata, LayerType defaultlayertype, Layer appendlayer, integer version, boolean isedit)
void	SaveInstantJSONAnnotations( LayerType ltype, string instantjson, optional integer reviewversion)
void	SaveOriginalAnnotations( dictionary annodata)
boolean	TryPreparePDFForAnnotating( ref content pdfcontent, out retval boolean success)
void	UpdateAnnotation( ref Annotation annotation, optional string title, optional string contents)
void	ValidateAnnotation( Annotation anno)
void	ValidateAnnotations()

Types

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	Annotation	Represents an annotation's COS-dictionary it's id
FSCPDFANNOTATIONS@1.1001	AnnotationType	Enumeration of all specified PDF annotation types
FSCPDFANNOTATIONS@1.1001	LayerMergeType	A layer merge type defines which layer types are merged into the review content
FSCPDFANNOTATIONS@1.1001	LayerType	A layer type defines if a layer contains public annotations or
FSCPDFANNOTATIONS@1.1001	OriginalAnnotation	Represents all original annotation id's and the pagenumber where it was placed on
FSCPDFANNOTATIONS@1.1001	ReviewVersion	A list of object versions that are "tagged" as "review-version"
FSCPDFANNOTATIONS@1.1001	TransactionVariable

Customization Points

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	CPAnnotationFeatureEnabled	If current object's class was configured in CPAnnotationFeatureEnabledClasses
FSCPDFANNOTATIONS@1.1001	CPAnnotationFeatureEnabledClasses	Is used to decide for which object classes the annotation-feature is already enabled

AccessControlLists

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	LayerPrivateACL	ACL for Private Annotation Layers.

Applications

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	ContentObjectAnnotatePDF
FSCPDFANNOTATIONS@1.1001	ContentObjectObjectCreateReviewVersion
FSCPDFANNOTATIONS@1.1001	ObjectObjectSendCommentedPdf

Contexts

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	LayerTypePrivate	Layer-Type Private

ErrorMessages

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	ERR_ANNOTATION_NOT_ALLOWED	Annotation is not permitted for password-protected content.
FSCPDFANNOTATIONS@1.1001	ERR_ANNOTATIONFEATURENOTENABLED	Annotations for class "%s" are not available.
FSCPDFANNOTATIONS@1.1001	ERR_ANNOTATIONSNOTENABLED	Annotations are not enabled.
FSCPDFANNOTATIONS@1.1001	ERR_EXPECTEDENTRYVALUE	Annotations of type "%1$s" require "%2$s" attribute.
FSCPDFANNOTATIONS@1.1001	ERR_INVALID_PARAMETER	The parameter "%s" is invalid.
FSCPDFANNOTATIONS@1.1001	ERR_LAYERNOTEXISTS	Layer %s does not exist.
FSCPDFANNOTATIONS@1.1001	ERR_LIMIT_EXCEEDED	"%1$s" exceeds the defined limit of %2$s %3$s.
FSCPDFANNOTATIONS@1.1001	ERR_MANDATORY_PARAMETER_WITH_TYPE	Parameter "%1$s" is mandatory and of type "%2$s".
FSCPDFANNOTATIONS@1.1001	ERR_MISSINGMANDATORYENTRY	Mandatory Annotation Dictionary Entry "%s" is missing.
FSCPDFANNOTATIONS@1.1001	ERR_NO_VERSION_OR_CONTENTDATE	Version or content date must be specified.
FSCPDFANNOTATIONS@1.1001	ERR_ONLY_MARKUP_ANNOTATIONS_SUPPORTED	This call only supports markup annotations.
FSCPDFANNOTATIONS@1.1001	ERR_PARAMETER_WITH_TYPE	Parameter "%1$s" must be of type "%2$s".
FSCPDFANNOTATIONS@1.1001	ERR_VERSIONNOTEXISTS	Version %s does not exist.

Expressions

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	COSKEY_AP
FSCPDFANNOTATIONS@1.1001	COSKEY_AUTHOR
FSCPDFANNOTATIONS@1.1001	COSKEY_CDATE
FSCPDFANNOTATIONS@1.1001	COSKEY_COLOR
FSCPDFANNOTATIONS@1.1001	COSKEY_DA
FSCPDFANNOTATIONS@1.1001	COSKEY_FLAGS
FSCPDFANNOTATIONS@1.1001	COSKEY_FS
FSCPDFANNOTATIONS@1.1001	COSKEY_FSCPAGE
FSCPDFANNOTATIONS@1.1001	COSKEY_INKLIST
FSCPDFANNOTATIONS@1.1001	COSKEY_L
FSCPDFANNOTATIONS@1.1001	COSKEY_MDATE
FSCPDFANNOTATIONS@1.1001	COSKEY_MOVIE
FSCPDFANNOTATIONS@1.1001	COSKEY_NM
FSCPDFANNOTATIONS@1.1001	COSKEY_PAGE
FSCPDFANNOTATIONS@1.1001	COSKEY_PARENT
FSCPDFANNOTATIONS@1.1001	COSKEY_POPUP
FSCPDFANNOTATIONS@1.1001	COSKEY_QUADPOINTS
FSCPDFANNOTATIONS@1.1001	COSKEY_RECT
FSCPDFANNOTATIONS@1.1001	COSKEY_SOUND
FSCPDFANNOTATIONS@1.1001	COSKEY_SUBJECT
FSCPDFANNOTATIONS@1.1001	COSKEY_SUBTYPE
FSCPDFANNOTATIONS@1.1001	COSKEY_TYPE
FSCPDFANNOTATIONS@1.1001	COSKEY_VERTICES
FSCPDFANNOTATIONS@1.1001	COSVAL_ANNOT
FSCPDFANNOTATIONS@1.1001	COSVAL_CARET
FSCPDFANNOTATIONS@1.1001	COSVAL_CIRCLE
FSCPDFANNOTATIONS@1.1001	COSVAL_FILEATTACHMENT
FSCPDFANNOTATIONS@1.1001	COSVAL_FREETEXT
FSCPDFANNOTATIONS@1.1001	COSVAL_HIGHLIGHT
FSCPDFANNOTATIONS@1.1001	COSVAL_INK
FSCPDFANNOTATIONS@1.1001	COSVAL_LINE
FSCPDFANNOTATIONS@1.1001	COSVAL_LINK
FSCPDFANNOTATIONS@1.1001	COSVAL_MARKUP3D
FSCPDFANNOTATIONS@1.1001	COSVAL_MOVIE
FSCPDFANNOTATIONS@1.1001	COSVAL_POLYGON
FSCPDFANNOTATIONS@1.1001	COSVAL_POLYLINE
FSCPDFANNOTATIONS@1.1001	COSVAL_POPUP
FSCPDFANNOTATIONS@1.1001	COSVAL_REDACT
FSCPDFANNOTATIONS@1.1001	COSVAL_RUBBERSTAMP
FSCPDFANNOTATIONS@1.1001	COSVAL_SCREEN
FSCPDFANNOTATIONS@1.1001	COSVAL_SOUND
FSCPDFANNOTATIONS@1.1001	COSVAL_SQUARE
FSCPDFANNOTATIONS@1.1001	COSVAL_SQUIGGLY
FSCPDFANNOTATIONS@1.1001	COSVAL_STRIKEOUT
FSCPDFANNOTATIONS@1.1001	COSVAL_TEXT
FSCPDFANNOTATIONS@1.1001	COSVAL_TRAPNET
FSCPDFANNOTATIONS@1.1001	COSVAL_UNDERLINE
FSCPDFANNOTATIONS@1.1001	COSVAL_WATERMARK
FSCPDFANNOTATIONS@1.1001	COSVAL_WIDGET

FormPages

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	PageLayer

LicenseItems

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	AppAnnotatePDF	Commenting With Integrated PDF Editor

Menus

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	MenuObjectCreateReviewVersion	Create Review Version
FSCPDFANNOTATIONS@1.1001	MenuObjectSendCommentedPdf	Send Commented PDF

ObjectEditForms

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	FormLayer

SimpleConfigurationObjects

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	DefaultConfig

Strings

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	STR_ANNOTS	Annotations
FSCPDFANNOTATIONS@1.1001	STR_ANNOTSPERLAYER	Annotations per Layer
FSCPDFANNOTATIONS@1.1001	STR_CONTAINSCOMMENTS	Contains Comments
FSCPDFANNOTATIONS@1.1001	STR_CURRENTVERSION	Current Version
FSCPDFANNOTATIONS@1.1001	STR_REQUESTSIZE	Request Size
FSCPDFANNOTATIONS@1.1001	STR_TITLEREVIEWVERSION	Version %s

WebServiceDefinitions

Component	Reference	Description
FSCPDFANNOTATIONS@1.1001	AnnotationWebservice	Webservice for Annotations