Software Component FSCPDFGEN@1.1001

The component FSCPDFGEN provides an integration for the PDF format.

Classes

Component	Reference	Description
FSCPDFGEN@1.1001	DocumentDefinition	Document Definition

Properties

Type	Property	Name
Object	additionaltransformation	Transformation XSLFO to XSLFO
string	bookmarkname	Bookmark Name
Object	certificate	Certificate
DocContents[]	doccontents	Documents
boolean	docdebug	Debug Mode
string[]	docexpression	Expression
boolean	docforceconversion	Force Conversion
FormPage	docformspage	Form Page
DocMergeData[]	docmergedata	Static Content
DocMetaData[]	docmetadata	Metadata
boolean	docnoautopagenumbers	Generate No Page Numbers
string[]	docpageimageexpr	Page Image
string[]	docprecondition	Precondition Expression
string[]	docxml	Expression to Calculate XML
integer	dpiheight	Height
content	dpiimage	Image
integer	dpiposx	Distance to the Bottom Left of the PDF in Pixels (X-Axis)
integer	dpiposy	Distance to the Bottom Left of the PDF in Pixels (Y-Axis)
integer	dpiwidth	Width
boolean	htmltransformationsupport	Inline HTML Transformation
boolean	iscontainer	Is Container
boolean	issignable	PDF Content is signable
Object	mergeobject	Document
Object	originaltransformation	Transformation XML to XSLFO
Alignment	pagenumalignment	Alignment
integer	pagenumfontcolor	Font Color
string(64)	pagenumfontname	Font Name
integer	pagenumfontsize	Font Size
string	pagenumformat	Format String
integer	pagenumstartvalue	Page Numbering Starts with
integer	pagenumxpospercent	Distance From the Left Margin (in Percent)
integer	pagenumypospercent	Distance From the Bottom Margin (in Percent)
Content	pdfcontent	PDF Content (Screen Quality)
Content	pdfcontentcached	PDF Content (Cache)
date	pdfcontentlastretry	Last PDF Content Conversion on/at
date	pdfcontentnextretry	PDF Content Valid Until
Object[]	pdfcontentobjects	Used Objects in PDF View
Content	pdfcontentocr	PDF Content (OCR)
Content	pdfcontentprint	PDF Content (Print Quality)
string	pdferrtext
string	pdfmetaauthor	Author
PDFMetadata	pdfmetadata	PDF Metadata
boolean	pdfmetadisplaydoctitle	Display Document Title
boolean	pdfmetaisencrypted	Encrypted
boolean	pdfmetaispasswordprotected	Password Protected
boolean	pdfmetaispdfa	PDF/A
boolean	pdfmetaissigned	Signed
string	pdfmetakeywords	Keywords
string(1)	pdfmetapdfaconformance	Conformance Level
integer	pdfmetapdfapart	Part
ProtectionFlag[]	pdfmetaprotection	Allowed Operations
string	pdfmetasubject	Subject
string	pdfmetatitle	Title
string	pdfmetaversion	PDF-Version
ObjectClass	pdfovclass	Class
string[]	pdfovconcernedexpr	Concerned Objects
string[]	pdfovconditionexpr	Condition
PDFOverviewConfiguration[]	pdfovconfig	PDF Overview Configuration
DocumentDefinition	pdfovdocdef	Document Definition
Content	pdfphonecontent	PDF Content (Optimized for Smartphones)
boolean	pdfrefreshmodified	Update PDF Content on Metadata Change
float	pdfsaheight	Height
PDFSignatureAreaInfo	pdfsainfo	Additional Information
User	pdfsaiuser	User
integer	pdfsapage	PDF Signature Area Page
float	pdfsaposx	X coordinate of the Signature Area
float	pdfsaposy	Y coordinate of the Signature Area
float	pdfsawidth	Width
PDFSignatureArea[]	pdfsignatureareas	PDF Signature Areas
VisualStamp	pdfstamp
boolean	pdfstampneeded
float	pdftffontsize	Font Size
float	pdftfheight	Height
float	pdftfposx	Distance to the Top Left of the PDF in Pixels (X-Axis)
float	pdftfposy	Distance to the Top Left of the PDF in Pixels (Y-Axis)
string	pdftftext	Text
float	pdftfwidth	Width
date	signdate	Signature date
string	signlocation	Place of signature
string	signname	Signatory
string	signreason	Signature reason
float	siheight	Height
content	siimage	Signature image (content)
ContentObject	siimageobj	Signature image (jpeg or png)
integer	sipage	Page
float	siposx	Distance to the Top Left of the PDF in Pixels (X-Axis)
float	siposy	Distance to the Top Left of the PDF in Pixels (Y-Axis)
PDFTextField[]	sitextfields	Text fields
float	siwidth	Width
Content	staticcontent	Content
AttributeObjectDef[]	tocecchildattrdefs	Attributes With Concerned Objects
ObjectClass	tocecclass	Class
string[]	tocecincludeexpr	Include Objects
TOCElementConfiguration[]	tocelementconfig	Elements in Table of Contents
TOCElements[]	tocelements	Table Of Content Elements
integer	toclevel	Level
string	toclevelformatted	Level (Formatted)
TOCLimits	toclimits	Limits for Table of Contents
integer	tocmaxchilds	Maximum Entries per Container
integer	tocmaxlevels	Maximum Levels
integer	tocmaxtotalentries	Maximum Total Entry Count
string	tocname	Name
string[]	transparameters	Expression for Computing XSL Parameters
Object[]	TV_PDFCONTENT_PROGRESS	In progress PDF content objects
boolean	TV_PREVENTPDFGENERATION	Prevent Generation of the PDF Content

Actions

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)

Types

Component	Reference	Description
FSCPDFGEN@1.1001	Alignment	Defines the possible alignments for text in PDF documents
FSCPDFGEN@1.1001	BookmarkType	Defines the possible bookmark types for merging PDF documents
FSCPDFGEN@1.1001	DocContents	Defines an expression string for determining objects or contents which should be
FSCPDFGEN@1.1001	DocMergeData	Definition of Document Merge Data
FSCPDFGEN@1.1001	DocMetaData	Definition of Document Meta Data
FSCPDFGEN@1.1001	DocPageImage	Structure for defining a Document Page Image and it's properties
FSCPDFGEN@1.1001	PageNumberingDefinition	Defines the layout of the page numbering
FSCPDFGEN@1.1001	PageOrientation	Defines the possible page orientation options
FSCPDFGEN@1.1001	PageSize	Defines the possible page size
FSCPDFGEN@1.1001	PDFMetadata	Contains standardized PDF Metadata fields
FSCPDFGEN@1.1001	pdfoverviewcontent	Structure for PDF Overview content
FSCPDFGEN@1.1001	PDFSignature	Signature information
FSCPDFGEN@1.1001	PDFSignatureArea	PDFSignatureArea describes a rectangular area in a PDF document to put a
FSCPDFGEN@1.1001	PDFSignatureAreaInfo	PDFSignatureAreaInfo is used to store additional information about a
FSCPDFGEN@1.1001	PDFTextField	Embedded text field within a PDF document
FSCPDFGEN@1.1001	ProtectionFlag	Defines the possible flags for PDF protection
FSCPDFGEN@1.1001	SignImage	Contains structured signature image information
FSCPDFGEN@1.1001	TOCElements	One Entry in a Table Of Content List
FSCPDFGEN@1.1001	TOCLimits	Definition for a limitation of a Table Of Content
FSCPDFGEN@1.1001	TransactionVariable
FSCPDFGEN@1.1001	WatermarkOption	Defines the possible watermark options

Customization Points

Component	Reference	Description
FSCPDFGEN@1.1001	PDFOverviewConfiguration	Customization point for defining the structure of the PDF
FSCPDFGEN@1.1001	TOCElementConfiguration	This customization point defines the compound elements and their depending objects that should be displayed in the table of contents of the PDF overview

Applications

Component	Reference	Description
FSCPDFGEN@1.1001	AddPDFSignaturesApp
FSCPDFGEN@1.1001	ViewAsPDFApp

ApplicationViews

Component	Reference	Description
FSCPDFGEN@1.1001	ViewAsPDFAppView	Information

ComponentContentObjects

Component	Reference	Description
FSCPDFGEN@1.1001	ErrorReportXSLFO	Error Report XSL Transformation
FSCPDFGEN@1.1001	MsgReportXSLFO	Message Report XSL Transformation
FSCPDFGEN@1.1001	ParameterToXSLFO	Parameter Report XSL Transformation
FSCPDFGEN@1.1001	TransformTOCToXSLFO	Transform TableOfContent to XSL Transformation
FSCPDFGEN@1.1001	TransformToXSLFO	Transform to XSL Transformation
FSCPDFGEN@1.1001	ZIPReportXSLFO	ZIP Report XSL Transformation

Contexts

Component	Reference	Description
FSCPDFGEN@1.1001	TOCFooterImageURL	URL to Footer Image in Table of Contents
FSCPDFGEN@1.1001	TOCFooterRedirectURL	Redirect URL in Footer of Table of Contents

DocumentDefinitions

Component	Reference	Description
FSCPDFGEN@1.1001	SampleFolderDefinition
FSCPDFGEN@1.1001	SampleParameterDefinition
FSCPDFGEN@1.1001	TOCDocumentDefinition

ErrorMessages

Component	Reference	Description
FSCPDFGEN@1.1001	ConvertPDFA	No PDF/A document could be created.
FSCPDFGEN@1.1001	ExecutionError	Internal Error: %s
FSCPDFGEN@1.1001	FOPConvertFailed	XSL-FO to PDF conversion failed: %1$s
FSCPDFGEN@1.1001	GenerateDocumentError	An error occurred when creating the PDF document.
FSCPDFGEN@1.1001	GenericSigningError	An error occurred while creating the signature.
FSCPDFGEN@1.1001	InvalidPassword	The entered password is invalid.
FSCPDFGEN@1.1001	InvalidWatermarkImage	The selected watermark image cannot be used.
FSCPDFGEN@1.1001	NoFormDefFound	Unable to generate a PDF Overview because no matching formular definition was found.
FSCPDFGEN@1.1001	OverviewLimitReached	These documents are not considered in the overview because the limit of convertable documents within an overview exceeded.
FSCPDFGEN@1.1001	PDFIsDynamicXFA	The PDF document contains dynamic XFA form contents.
FSCPDFGEN@1.1001	PDFIsEmpty	The document is empty.
FSCPDFGEN@1.1001	PDFIsSecured	The PDF document is protected.
FSCPDFGEN@1.1001	PDFIsSigned	The PDF document is digitally signed.
FSCPDFGEN@1.1001	PDFNotProcessable	The PDF document cannot be processed.
FSCPDFGEN@1.1001	PDFViewNotAvailable	Could not create PDF document for object "%s".
FSCPDFGEN@1.1001	PDFViewNotImpl	PDF documents are not available for "%s" files.
FSCPDFGEN@1.1001	WatermarkError	An error occurred when creating the watermark.

FormPages

Component	Reference	Description
FSCPDFGEN@1.1001	PagePDFError
FSCPDFGEN@1.1001	PageTOC

Menus

Component	Reference	Description
FSCPDFGEN@1.1001	MenuViewAsPdf	View as PDF
FSCPDFGEN@1.1001	MenuViewAsPdfDirect	View as PDF

SimpleConfigurationObjects

Component	Reference	Description
FSCPDFGEN@1.1001	PdfgenServices	PDF Generator Service

Strings

Component	Reference	Description
FSCPDFGEN@1.1001	DocRange	Documents %1$ld - %2$ld
FSCPDFGEN@1.1001	errorbookmark	Occurred errors
FSCPDFGEN@1.1001	errortitle	Error generating object %s
FSCPDFGEN@1.1001	mailcc	CC:
FSCPDFGEN@1.1001	maildate	Sent at:
FSCPDFGEN@1.1001	mailsender	From:
FSCPDFGEN@1.1001	mailsubject	Subject:
FSCPDFGEN@1.1001	mailto	To:
FSCPDFGEN@1.1001	rootbookmark	Bookmarks
FSCPDFGEN@1.1001	StrAttachment	Attachment %ld
FSCPDFGEN@1.1001	StrDownloadingPDF	The PDF document is ready to download and will be opened within a short time.
FSCPDFGEN@1.1001	StrGeneratingPdf	Please wait while generating and providing the PDF document ...
FSCPDFGEN@1.1001	StrSeeAttachment	See Attachment %ld
FSCPDFGEN@1.1001	StrZipArchiveEntries	ZIP Archive with %d entries
FSCPDFGEN@1.1001	StrZipArchiveEntry	ZIP Archive with 1 entry