2022 June Release

Actions of FSCPDFGEN@1.1001 Permanent link for this heading

Return Type

Signature

void

AddPDFSignatures(
  PDFSignature[] signatures,
  optional object signobject)

void

AppendDoc(
  ref optional content doc1,
  content doc2,
  optional string doc2id,
  optional PageNumberingDefinition pagenumbering,
  out optional integer mergestartpage,
  out optional integer mergedpages)

void

AppendDocArray(
  out content pdf,
  content[] pdflist,
  string[] filenames,
  optional BookmarkType bookmarktype,
  optional boolean insertevenpage)

void

AttrPdfContentGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

AttrPdfContentGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

CheckMsg2Pdf(
  string srctype,
  string desttype,
  optional string progid,
  optional string auxparam,
  ref optional dictionary globalscope)

void

ClearPages(
  ref content doc,
  string id,
  out integer clearedpages)

void

ConvertMime2Pdf(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope,
  optional boolean handleerrors)

void

ConvertMime2PdfEx(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

void

ConvertMsg2Pdf(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope,
  optional boolean handleerrors)

void

ConvertMsg2PdfEx(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

void

ConvertPdf2PdfA3b(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

void

ConvertZip2Pdf(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

integer[]

DetermineOCRPageRanges(
  content pdf,
  out retval integer[] pageranges)

string[]

ExtractAnnotationUrls(
  content pdfcont,
  optional integer fromPage,
  optional integer toPage,
  out retval string[] urls)

string[]

ExtractRegex(
  content pdfcont,
  string regex,
  optional integer fromPage,
  optional integer toPage,
  out retval string[] matches)

string

ExtractText(
  content pdfcont,
  optional integer fromPage,
  optional integer toPage,
  out retval string text)

string[]

ExtractTextUrls(
  content pdfcont,
  optional integer fromPage,
  optional integer toPage,
  out retval string[] urls)

void

FinalizeSignPDF(
  out content signedpdfcontent,
  content pdfcontent,
  string hashb64,
  string signatureb64,
  datetime signdate,
  string signname,
  string signreason,
  string signlocation,
  optional SignImage signimage)

void

FOPConvert(
  string type1,
  string type2,
  content xslfo,
  out optional content pdf)

void

GenerateDocument(
  optional object inputobj,
  optional string desttype,
  optional BookmarkType bookmarktype,
  ref optional dictionary globalscope,
  ref optional any destcont,
  ref optional boolean handleerrors,
  optional dictionary additionaldata,
  optional object attrdef)

void

GetDocInfo(
  content pdf,
  out optional integer pagecount,
  out optional boolean encrypted,
  out optional boolean parseable,
  out optional boolean dynamicxfa)

void

GetDocMetadata(
  content pdf,
  out dictionary metadata,
  out dictionary additionalProperties)

void

GetPDFInfo(
  Content document,
  ref optional dictionary properties)

PDFSignatureArea[]

GetSignatureAreasFromHyperlinks(
  content pdfcont,
  out retval PDFSignatureArea[] areas)

string

GetText(
  content pdf,
  out retval string text)

TOCElements[]

GetTOC(
  object tocroot,
  integer maxtotalentries,
  integer maxlevels,
  integer maxchilds,
  ref integer totalentries,
  integer level,
  string containerprefix,
  ref retval TOCElements[] tocelements,
  ref object[] visitedobjs,
  ref dictionary containerdict,
  optional string formatedcontainerprefix)

integer

GetTOCLimitations(
  out retval integer maxtotalentries,
  out integer maxlevels,
  out integer maxchilds)

void

GetViewAsPDFMenu(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

boolean

HasPDFContent(
  AttributeContentDef attrdef,
  out retval boolean haspdfcontent)

boolean

HasPDFRestrictions(
  content pdf,
  out retval boolean hasRestrictions)

PDFSignatureArea

InstantJSON2SignatureArea(
  string json,
  out retval PDFSignatureArea area)

void

MarkPages(
  ref content doc,
  string expr,
  ref optional dictionary globalscope)

void

MergeObjects(
  out content pdf,
  PDFObject[] pdfobjects,
  string[] filenames,
  optional BookmarkType bookmarktype,
  optional boolean insertevenpage,
  out PDFSignatureArea[] mergedsignatureareas)

void

MhtMerge(
  out content doc1,
  content[] doc2)

void

PrepareSignPDF(
  content pdfcontent,
  out string hashb64,
  datetime signdate,
  string signname,
  string signreason,
  string signlocation,
  optional SignImage signimage)

void

RemovePDFRestrictions(
  ref content pdf)

content

RemoveSignatures(
  ref retval content pdfcont,
  optional boolean removesignaturewidgets)

void

SetDocMetadata(
  ref content pdf,
  dictionary metadata)

string

SignatureArea2InstantJSON(
  PDFSignatureArea area,
  out retval string json)

void

SplitPDF(
  content pdf,
  out content[] pages)

void

ViewContentAsPDF(
  optional integer unused1,
  optional integer unused2)

void

ViewContentAsPDFSelectedObjects(
  optional integer unused1,
  optional integer unused2)

void

WritePageNumbers(
  ref optional content doc,
  optional PageNumberingDefinition pagenumbering)

void

WritePDFImage(
  ref content doc,
  DocPageImage pageimage)

void

WriteWatermark(
  ref content doc,
  optional string watermarktext,
  optional content watermarkimage,
  optional ProtectionFlag[] flags,
  optional string ownerpassword,
  optional string userpassword,
  optional string watermarktextfontname,
  optional integer watermarktextfontsize,
  optional integer watermarktextfontcolor,
  optional integer watermarktextfontopacity,
  optional WatermarkOption[] watermarkoptions)


FSCPDFGEN@1.1001:AddPDFSignatures Permanent link for this heading

AddPDFSignatures puts a list of PDFSignatures in a PDF document. It is implemented by FSCCRYPT@1.1001.

void FSCPDFGEN@1.1001:AddPDFSignatures(
  PDFSignature[] signatures,
  optional object signobject)

Name

Description

signatures

is the list of PDFSignatures to put in the document.

signobject

if set the signature is applied to the sign object instead of the current object

Additional Information


FSCPDFGEN@1.1001:AppendDoc Permanent link for this heading

This action is used for merging PDF documents. The optional parameters "doc2id" and "pagenumbering" can be used to embed an identifier for the appended pages and to put a page number stamp onto the resulting document, respectively.

void FSCPDFGEN@1.1001:AppendDoc(
  ref optional content doc1,
  content doc2,
  optional string doc2id,
  optional PageNumberingDefinition pagenumbering,
  out optional integer mergestartpage,
  out optional integer mergedpages)

Name

Description

doc1

Contains the source PDF document. On output this parameter receives the resulting PDF document.

doc2

The document to be appended.

doc2id

Embeds this identifier into each appended page. You may specify this identifier in a subsequent call to FSCPDFGEN::ClearPages in order to clear the content of these pages.

pagenumbering

Applies a page number stamp on each page of the resulting document.

mergestartpage

mergedpages

Additional Information


FSCPDFGEN@1.1001:AppendDocArray Permanent link for this heading

Merges a list of PDF documents to one single PDF document.

void FSCPDFGEN@1.1001:AppendDocArray(
  out content pdf,
  content[] pdflist,
  string[] filenames,
  optional BookmarkType bookmarktype,
  optional boolean insertevenpage)

Name

Description

pdf

The resulting PDF document.

pdflist

A list of PDF documents.

filenames

The file names of the PDF documents used for bookmarking.

bookmarktype

Defines the kind of bookmarking for the new PDF document.

insertevenpage

If set to true, an empty page will be inserted. when the source document has an uneven number of pages.

Additional Information


FSCPDFGEN@1.1001:AttrPdfContentGet Permanent link for this heading

void FSCPDFGEN@1.1001:AttrPdfContentGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCPDFGEN@1.1001:AttrPdfContentGetVersion Permanent link for this heading

void FSCPDFGEN@1.1001:AttrPdfContentGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

versnr

value

volatile

volatiletx

Additional Information


FSCPDFGEN@1.1001:CheckMsg2Pdf Permanent link for this heading

void FSCPDFGEN@1.1001:CheckMsg2Pdf(
  string srctype,
  string desttype,
  optional string progid,
  optional string auxparam,
  ref optional dictionary globalscope)

Name

Description

srctype

desttype

progid

auxparam

globalscope

Additional Information


FSCPDFGEN@1.1001:ClearPages Permanent link for this heading

Removes any content from certain pages of a PDF document, except an existing page number stamp. The pages to be removed are determined by an identifier, which has been embedded into the document using the action FSCPDFGEN::AppendDoc. Consequently, you are only able to remove the contents of pages, which were previously appended.

void FSCPDFGEN@1.1001:ClearPages(
  ref content doc,
  string id,
  out integer clearedpages)

Name

Description

doc

The PDF document to be modified.

id

Identifier of the pages to be cleared (previously set by FSCPDFGEN::AppendDoc).

clearedpages

Returns the number of cleared pages.

Additional Information


FSCPDFGEN@1.1001:ConvertMime2Pdf Permanent link for this heading

void FSCPDFGEN@1.1001:ConvertMime2Pdf(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope,
  optional boolean handleerrors)

Name

Description

srctype

desttype

srccont

destcont

tool

printer

globalscope

handleerrors

Additional Information


FSCPDFGEN@1.1001:ConvertMime2PdfEx Permanent link for this heading

void FSCPDFGEN@1.1001:ConvertMime2PdfEx(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

Name

Description

srctype

desttype

srccont

destcont

tool

printer

globalscope

Additional Information


FSCPDFGEN@1.1001:ConvertMsg2Pdf Permanent link for this heading

void FSCPDFGEN@1.1001:ConvertMsg2Pdf(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope,
  optional boolean handleerrors)

Name

Description

srctype

desttype

srccont

destcont

tool

printer

globalscope

handleerrors

Additional Information


FSCPDFGEN@1.1001:ConvertMsg2PdfEx Permanent link for this heading

void FSCPDFGEN@1.1001:ConvertMsg2PdfEx(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

Name

Description

srctype

desttype

srccont

destcont

tool

printer

globalscope

Additional Information


FSCPDFGEN@1.1001:ConvertPdf2PdfA3b Permanent link for this heading

void FSCPDFGEN@1.1001:ConvertPdf2PdfA3b(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

Name

Description

srctype

desttype

srccont

destcont

tool

printer

globalscope

Additional Information


FSCPDFGEN@1.1001:ConvertZip2Pdf Permanent link for this heading

void FSCPDFGEN@1.1001:ConvertZip2Pdf(
  optional string srctype,
  optional string desttype,
  content srccont,
  ref content destcont,
  optional interface tool,
  optional string printer,
  ref optional dictionary globalscope)

Name

Description

srctype

desttype

srccont

destcont

tool

printer

globalscope

Additional Information


FSCPDFGEN@1.1001:DetermineOCRPageRanges Permanent link for this heading

Analyzes which pages Optical Character Recognition (OCR) should be applied to.

integer[] FSCPDFGEN@1.1001:DetermineOCRPageRanges(
  content pdf,
  out retval integer[] pageranges)

Name

Description

pdf

the PDF document

pageranges

the inclusive zero-based page range pairs that OCR should be applied to, e.g. [0, 2, 4, 4] indicates pages 0, 1, 2 and 4.

Additional Information


FSCPDFGEN@1.1001:ExtractAnnotationUrls Permanent link for this heading

Extracts the Annotation URLs between two Pages (iterating over the pages' annotations)

string[] FSCPDFGEN@1.1001:ExtractAnnotationUrls(
  content pdfcont,
  optional integer fromPage,
  optional integer toPage,
  out retval string[] urls)

Name

Description

pdfcont

is the PDF content.

fromPage

1-based if set

toPage

1-based if set

urls

the found urls

Additional Information


FSCPDFGEN@1.1001:ExtractRegex Permanent link for this heading

Extracts the Text matching a Regex

string[] FSCPDFGEN@1.1001:ExtractRegex(
  content pdfcont,
  string regex,
  optional integer fromPage,
  optional integer toPage,
  out retval string[] matches)

Name

Description

pdfcont

is the PDF content.

regex

fromPage

1-based if set

toPage

1-based if set

matches

the matched strings

Additional Information


FSCPDFGEN@1.1001:ExtractText Permanent link for this heading

Extracts the Text from a PDF

string FSCPDFGEN@1.1001:ExtractText(
  content pdfcont,
  optional integer fromPage,
  optional integer toPage,
  out retval string text)

Name

Description

pdfcont

is the PDF content.

fromPage

1-based if set

toPage

1-based if set

text

the resulting text

Additional Information


FSCPDFGEN@1.1001:ExtractTextUrls Permanent link for this heading

Extracts the Text URLs (using TextExtraction and a Regex)

string[] FSCPDFGEN@1.1001:ExtractTextUrls(
  content pdfcont,
  optional integer fromPage,
  optional integer toPage,
  out retval string[] urls)

Name

Description

pdfcont

is the PDF content.

fromPage

1-based if set

toPage

1-based if set

urls

the found urls

Additional Information


FSCPDFGEN@1.1001:FinalizeSignPDF Permanent link for this heading

void FSCPDFGEN@1.1001:FinalizeSignPDF(
  out content signedpdfcontent,
  content pdfcontent,
  string hashb64,
  string signatureb64,
  datetime signdate,
  string signname,
  string signreason,
  string signlocation,
  optional SignImage signimage)

Name

Description

signedpdfcontent

pdfcontent

hashb64

signatureb64

signdate

signname

signreason

signlocation

signimage

Additional Information


FSCPDFGEN@1.1001:FOPConvert Permanent link for this heading

void FSCPDFGEN@1.1001:FOPConvert(
  string type1,
  string type2,
  content xslfo,
  out optional content pdf)

Name

Description

type1

type2

xslfo

pdf

Additional Information


FSCPDFGEN@1.1001:GenerateDocument Permanent link for this heading

This action is used for generating PDF documents via DocumentDefiniton objects.

void FSCPDFGEN@1.1001:GenerateDocument(
  optional object inputobj,
  optional string desttype,
  optional BookmarkType bookmarktype,
  ref optional dictionary globalscope,
  ref optional any destcont,
  ref optional boolean handleerrors,
  optional dictionary additionaldata,
  optional object attrdef)

Name

Description

inputobj

A DocumentDefinition object that is used to generate the document.

desttype

"pdf", "pdfnative" and "pdfanative" are allowed. Default "pdf" is used.

bookmarktype

Defines which table of contents should be generated.

globalscope

Dictionary containing global transaction scope.

destcont

The generated PDF document.

handleerrors

If set to true, errors while generating will be inserted into the generated document.

additionaldata

Dictionary containing additional data which is used for generating a document.

attrdef

The content attribute definition where the generated document should be saved.

Additional Information


FSCPDFGEN@1.1001:GetDocInfo Permanent link for this heading

Retrieves information from a PDF document

void FSCPDFGEN@1.1001:GetDocInfo(
  content pdf,
  out optional integer pagecount,
  out optional boolean encrypted,
  out optional boolean parseable,
  out optional boolean dynamicxfa)

Name

Description

pdf

The PDF content which should be analyzed.

pagecount

Number of pages of the PDF content.

encrypted

Parameter indicating whether the PDF is encrypted or not.

parseable

Parameter indicating whether the PDF is parseable by Apache PDFBox or not.

dynamicxfa

Additional Information


FSCPDFGEN@1.1001:GetDocMetadata Permanent link for this heading

Retrieves all information from PDF metadata (title, author, subject, ...)

void FSCPDFGEN@1.1001:GetDocMetadata(
  content pdf,
  out dictionary metadata,
  out dictionary additionalProperties)

Name

Description

pdf

The PDF content which should be analyzed.

metadata

Key/Value dictionary from all metadata entries in the document information dictionary (title, author, subject, ...)

additionalProperties

dictionary for additional selected properties that do not belong to the document information dictionary (DisplayDocTitle)

Additional Information


FSCPDFGEN@1.1001:GetPDFInfo Permanent link for this heading

Retrieves the metadata of a PDF document

void FSCPDFGEN@1.1001:GetPDFInfo(
  Content document,
  ref optional dictionary properties)

Name

Description

document

the PDF document

properties

a dictionary containing the PDF metadata

Additional Information


FSCPDFGEN@1.1001:GetSignatureAreasFromHyperlinks Permanent link for this heading

GetSignatureAreasFromHyperlinks looks for hyperlinks ending in "#fscpdfsignatureannotation" and converts their position and size to PDFSignatureAreas. The URL query part of the hyperlink will be used to create the associated PDFSignatureAreaInfo struct.

PDFSignatureArea[] FSCPDFGEN@1.1001:GetSignatureAreasFromHyperlinks(
  content pdfcont,
  out retval PDFSignatureArea[] areas)

Name

Description

pdfcont

is the PDF content.

areas

are the resulting PDFSignatureAreas.

Additional Information


FSCPDFGEN@1.1001:GetText Permanent link for this heading

Retrieves the text of a PDF document

string FSCPDFGEN@1.1001:GetText(
  content pdf,
  out retval string text)

Name

Description

pdf

the PDF document

text

the text content of the PDF document

Additional Information


FSCPDFGEN@1.1001:GetTOC Permanent link for this heading

TOCElements[] FSCPDFGEN@1.1001:GetTOC(
  object tocroot,
  integer maxtotalentries,
  integer maxlevels,
  integer maxchilds,
  ref integer totalentries,
  integer level,
  string containerprefix,
  ref retval TOCElements[] tocelements,
  ref object[] visitedobjs,
  ref dictionary containerdict,
  optional string formatedcontainerprefix)

Name

Description

tocroot

maxtotalentries

maxlevels

maxchilds

totalentries

level

containerprefix

tocelements

visitedobjs

containerdict

formatedcontainerprefix

Additional Information


FSCPDFGEN@1.1001:GetTOCLimitations Permanent link for this heading

integer FSCPDFGEN@1.1001:GetTOCLimitations(
  out retval integer maxtotalentries,
  out integer maxlevels,
  out integer maxchilds)

Name

Description

maxtotalentries

maxlevels

maxchilds

Additional Information


FSCPDFGEN@1.1001:GetViewAsPDFMenu Permanent link for this heading

void FSCPDFGEN@1.1001:GetViewAsPDFMenu(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

Name

Description

unused1

unused2

menuentries

menu

selobjects

addchildren

Additional Information


FSCPDFGEN@1.1001:HasPDFContent Permanent link for this heading

Checks if the supplied object has an pdf content. The content is not parsed just the extension is checked

boolean FSCPDFGEN@1.1001:HasPDFContent(
  AttributeContentDef attrdef,
  out retval boolean haspdfcontent)

Name

Description

attrdef

the attribute definition. If no attribute definition is supplied the property content is used

haspdfcontent

the result

Additional Information


FSCPDFGEN@1.1001:HasPDFRestrictions Permanent link for this heading

Checks if a PDF document has restrictive flags set

boolean FSCPDFGEN@1.1001:HasPDFRestrictions(
  content pdf,
  out retval boolean hasRestrictions)

Name

Description

pdf

The PDF document

hasRestrictions

Additional Information


FSCPDFGEN@1.1001:InstantJSON2SignatureArea Permanent link for this heading

InstantJSON2SignatureArea converts a PSPDFKit Instant JSON rectangle annotation to a PDFSignatureArea.

PDFSignatureArea FSCPDFGEN@1.1001:InstantJSON2SignatureArea(
  string json,
  out retval PDFSignatureArea area)

Name

Description

json

is the annotation.

area

is the PDFSignatureArea.

Additional Information


FSCPDFGEN@1.1001:MarkPages Permanent link for this heading

This action is similar to "WritePageNumbers" but offers a more generic functionality. It applies arbitrary marks to all pages of a PDF document. The expression (parameter "expr") is evaluated for each page and provides the PDF stream fragments to be inserted into the pages. You may use this action to insert water marks, vector graphics, etc.

void FSCPDFGEN@1.1001:MarkPages(
  ref content doc,
  string expr,
  ref optional dictionary globalscope)

Name

Description

doc

The document to be modified.

expr

The expression that returns a PDF stream fragment. The type of the result must be "STRING".

globalscope

The global scope dictionary contains the parameters for evaluating the expression (parameter "expr").

Additional Information


FSCPDFGEN@1.1001:MergeObjects Permanent link for this heading

Merges a list of PDFObjects to one single PDF document.

void FSCPDFGEN@1.1001:MergeObjects(
  out content pdf,
  PDFObject[] pdfobjects,
  string[] filenames,
  optional BookmarkType bookmarktype,
  optional boolean insertevenpage,
  out PDFSignatureArea[] mergedsignatureareas)

Name

Description

pdf

The resulting PDF document.

pdfobjects

A list of PDFObjects.

filenames

The file names of the PDFObjects used for bookmarking.

bookmarktype

Defines the kind of bookmarking for the new PDF document.

insertevenpage

If set to true, an empty page will be inserted. when the source document has an uneven number of pages.

mergedsignatureareas

The resulting new signature areas of the given PDFObjects.

Additional Information


FSCPDFGEN@1.1001:MhtMerge Permanent link for this heading

void FSCPDFGEN@1.1001:MhtMerge(
  out content doc1,
  content[] doc2)

Name

Description

doc1

doc2

Additional Information


FSCPDFGEN@1.1001:PrepareSignPDF Permanent link for this heading

void FSCPDFGEN@1.1001:PrepareSignPDF(
  content pdfcontent,
  out string hashb64,
  datetime signdate,
  string signname,
  string signreason,
  string signlocation,
  optional SignImage signimage)

Name

Description

pdfcontent

hashb64

signdate

signname

signreason

signlocation

signimage

Additional Information


FSCPDFGEN@1.1001:RemovePDFRestrictions Permanent link for this heading

Removes PDF document restrictions from the document to make it editable (Does not remove user passwords, only owner passwords).

void FSCPDFGEN@1.1001:RemovePDFRestrictions(
  ref content pdf)

Name

Description

pdf

The PDF document

Additional Information


FSCPDFGEN@1.1001:RemoveSignatures Permanent link for this heading

RemoveSignatures looks for existing signatures and removes all of them.

content FSCPDFGEN@1.1001:RemoveSignatures(
  ref retval content pdfcont,
  optional boolean removesignaturewidgets)

Name

Description

pdfcont

is the PDF content.

removesignaturewidgets

If set to true, existing signature widgets will also be removed , otherwise they will be replaced with stamp annotations.

Additional Information


FSCPDFGEN@1.1001:SetDocMetadata Permanent link for this heading

Sets PDF metadata (title, author, subject, ...) New metadata, will be set from dictionary keys. Already existing metadata, will be overwritten by dictionary keys. If dictionary keys are null, metadata will be deleted.

void FSCPDFGEN@1.1001:SetDocMetadata(
  ref content pdf,
  dictionary metadata)

Name

Description

pdf

The PDF content which should be changed.

metadata

Key/Value dictionary with metadata entries (title, author, subject, ...)

Additional Information


FSCPDFGEN@1.1001:SignatureArea2InstantJSON Permanent link for this heading

SignatureArea2InstantJSON converts a PDFSignatureArea to a PSPDFKit Instant JSON rectangle annotation.

string FSCPDFGEN@1.1001:SignatureArea2InstantJSON(
  PDFSignatureArea area,
  out retval string json)

Name

Description

area

is the PDFSignatureArea.

json

is the annotation.

Additional Information


FSCPDFGEN@1.1001:SplitPDF Permanent link for this heading

Splits a PDF document into its pages

void FSCPDFGEN@1.1001:SplitPDF(
  content pdf,
  out content[] pages)

Name

Description

pdf

The PDF document.

pages

A list of PDF documents, each containing a page of the original PDF document.

Additional Information


FSCPDFGEN@1.1001:ViewContentAsPDF Permanent link for this heading

Usecase for viewing a content as PDF

void FSCPDFGEN@1.1001:ViewContentAsPDF(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCPDFGEN@1.1001:ViewContentAsPDFSelectedObjects Permanent link for this heading

void FSCPDFGEN@1.1001:ViewContentAsPDFSelectedObjects(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCPDFGEN@1.1001:WritePageNumbers Permanent link for this heading

Marks all pages of the PDF document with a page number stamp. Note: any existing page numbers will be replaced when you call FSCPDFGEN::WritePageNumbers.

void FSCPDFGEN@1.1001:WritePageNumbers(
  ref optional content doc,
  optional PageNumberingDefinition pagenumbering)

Name

Description

doc

The PDF document to be modified.

pagenumbering

Layout definition of the page number stamp.

Additional Information


FSCPDFGEN@1.1001:WritePDFImage Permanent link for this heading

Add an image to every page of an PDF document.

void FSCPDFGEN@1.1001:WritePDFImage(
  ref content doc,
  DocPageImage pageimage)

Name

Description

doc

The PDF document to be modified.

pageimage

Additional Information


FSCPDFGEN@1.1001:WriteWatermark Permanent link for this heading

Add a watermark to a PDF document. The watermark can be a text or an image.

void FSCPDFGEN@1.1001:WriteWatermark(
  ref content doc,
  optional string watermarktext,
  optional content watermarkimage,
  optional ProtectionFlag[] flags,
  optional string ownerpassword,
  optional string userpassword,
  optional string watermarktextfontname,
  optional integer watermarktextfontsize,
  optional integer watermarktextfontcolor,
  optional integer watermarktextfontopacity,
  optional WatermarkOption[] watermarkoptions)

Name

Description

doc

The PDF document to be modified.

watermarktext

The text which should be added as watermark.

watermarkimage

The image which should be added as watermark.

flags

The protection modes which should be allowed in the PDF document.

ownerpassword

The owner password which should be applied to the PDF document.

userpassword

The user password which should be applied to the PDF document.

watermarktextfontname

watermarktextfontsize

watermarktextfontcolor

watermarktextfontopacity

watermarkoptions

Additional Information