Return Type |
Signature |
AddPDFSignatures( |
|
AppendDoc( |
|
AppendDocArray( |
|
AttrPdfContentGet( |
|
AttrPdfContentGetVersion( |
|
CheckMsg2Pdf( |
|
ClearPages( |
|
ConvertMime2Pdf( |
|
ConvertMime2PdfEx( |
|
ConvertMsg2Pdf( |
|
ConvertMsg2PdfEx( |
|
ConvertPdf2PdfA3b( |
|
ConvertZip2Pdf( |
|
DetermineOCRPageRanges( |
|
ExtractAnnotationUrls( |
|
ExtractRegex( |
|
ExtractText( |
|
ExtractTextUrls( |
|
FinalizeSignPDF( |
|
FOPConvert( |
|
GenerateDocument( |
|
GetDocInfo( |
|
GetDocMetadata( |
|
GetPDFInfo( |
|
GetSignatureAreasFromHyperlinks( |
|
GetTOC( |
|
GetTOCLimitations( |
|
GetViewAsPDFMenu( |
|
HasPDFContent( |
|
HasPDFRestrictions( |
|
InstantJSON2SignatureArea( |
|
MarkPages( |
|
MergeObjects( |
|
PrepareSignPDF( |
|
RemovePDFRestrictions( |
|
RemoveSignatures( |
|
SetDocMetadata( |
|
SignatureArea2InstantJSON( |
|
ViewContentAsPDF( |
|
ViewContentAsPDFSelectedObjects( |
|
WritePageNumbers( |
|
WritePDFImage( |
|
WriteWatermark( |
FSCPDFGEN@1.1001:AddPDFSignatures
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
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
void
FSCPDFGEN@1.1001:AppendDocArray(
out content
pdf,
content[]
pdflist,
string[]
filenames,
optional BookmarkType
bookmarktype,
optional boolean
insertevenpage)
Name |
Description |
|
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
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
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
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
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
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
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
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
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
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
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
integer[]
FSCPDFGEN@1.1001:DetermineOCRPageRanges(
content
pdf,
out retval integer[]
pageranges)
Name |
Description |
|
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
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
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
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
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
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
void
FSCPDFGEN@1.1001:FOPConvert(
string
type1,
string
type2,
content
xslfo,
out optional content
pdf)
Name |
Description |
type1 |
|
type2 |
|
xslfo |
|
|
Additional Information
FSCPDFGEN@1.1001:GenerateDocument
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
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 |
|
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
void
FSCPDFGEN@1.1001:GetDocMetadata(
content
pdf,
out dictionary
metadata,
out dictionary
additionalProperties)
Name |
Description |
|
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
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
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
string
FSCPDFGEN@1.1001:GetText(
content
pdf,
out retval string
text)
Name |
Description |
|
the PDF document
|
text |
the text content of the PDF document
|
Additional Information
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
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
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
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
boolean
FSCPDFGEN@1.1001:HasPDFRestrictions(
content
pdf,
out retval boolean
hasRestrictions)
Name |
Description |
|
The PDF document
|
hasRestrictions |
Additional Information
FSCPDFGEN@1.1001:InstantJSON2SignatureArea
PDFSignatureArea
FSCPDFGEN@1.1001:InstantJSON2SignatureArea(
string
json,
out retval PDFSignatureArea
area)
Name |
Description |
json |
is the annotation.
|
area |
is the PDFSignatureArea.
|
Additional Information
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
void
FSCPDFGEN@1.1001:MergeObjects(
out content
pdf,
PDFObject[]
pdfobjects,
string[]
filenames,
optional BookmarkType
bookmarktype,
optional boolean
insertevenpage,
out PDFSignatureArea[]
mergedsignatureareas)
Name |
Description |
|
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
void
FSCPDFGEN@1.1001:MhtMerge(
out content
doc1,
content[]
doc2)
Name |
Description |
doc1 |
|
doc2 |
Additional Information
FSCPDFGEN@1.1001:PrepareSignPDF
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
void
FSCPDFGEN@1.1001:RemovePDFRestrictions(
ref content
pdf)
Name |
Description |
|
The PDF document
|
Additional Information
FSCPDFGEN@1.1001:RemoveSignatures
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
void
FSCPDFGEN@1.1001:SetDocMetadata(
ref content
pdf,
dictionary
metadata)
Name |
Description |
|
The PDF content which should be changed.
|
metadata |
Key/Value dictionary with metadata entries (title, author, subject, ...)
|
Additional Information
FSCPDFGEN@1.1001:SignatureArea2InstantJSON
string
FSCPDFGEN@1.1001:SignatureArea2InstantJSON(
PDFSignatureArea
area,
out retval string
json)
Name |
Description |
area |
is the PDFSignatureArea.
|
json |
is the annotation.
|
Additional Information
void
FSCPDFGEN@1.1001:SplitPDF(
content
pdf,
out content[]
pages)
Name |
Description |
|
The PDF document.
|
pages |
A list of PDF documents, each containing a page of the original PDF document.
|
Additional Information
FSCPDFGEN@1.1001:ViewContentAsPDF
void
FSCPDFGEN@1.1001:ViewContentAsPDF(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
FSCPDFGEN@1.1001:ViewContentAsPDFSelectedObjects
void
FSCPDFGEN@1.1001:ViewContentAsPDFSelectedObjects(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
FSCPDFGEN@1.1001: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
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
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