Function Reference
AddToPDFPageNumberOffset
Adds to the PDF page number offset.
Syntax:
wwadapter:AddToPDFPageNumberOffset($addToPageNumberOffset)Parameters:
Name | Type | Description |
|---|---|---|
|
| The add to page number offset. |
Example:
<xsl:variable name="VarAddOffset" select="wwadapter:AddToPDFPageNumberOffset($VarDocPageCount)" />GeneratePDF
Generates a PDF.
Syntax:
wwadapter:GeneratePDF($originalDocumentPath, $conversionPDFDocumentPath, $singleFile, $tocStyleNodesIterator, $groupFileNodesIterator, $pdfJobSettings, $pdfFilePath)Parameters:
Name | Type | Description |
|---|---|---|
|
| Full pathname of the original document file. |
|
| Full pathname of the conversion PDF document file. |
|
| True for single file. |
|
| The TOC style node set. |
|
| The group file node set. |
|
| The PDF job settings. |
|
| Full pathname of the PDF file. |
Returns:
bool: True if it succeeds, false if it fails.
Example:
<xsl:variable name="VarSuccess" select="wwadapter:GeneratePDF($VarDocPath, $VarConversionPath, true(), $VarTocStyles, $VarGroupFiles, $VarJobSettings, $VarPdfPath)" />GeneratePDFWithSaveAs
Generates a PDF using FrameMaker save as.
Syntax:
wwadapter:GeneratePDFWithSaveAs($originalDocumentPath, $conversionPDFDocumentPath, $singleFile, $tocStyleNodesIterator, $groupFileNodesIterator, $pdfJobSettings, $pdfFilePath)Parameters:
Name | Type | Description |
|---|---|---|
|
| Full pathname of the original document file. |
|
| Full pathname of the conversion PDF document file. |
|
| True for single file. |
|
| The TOC style node set. |
|
| The group file node set. |
|
| The PDF job settings. |
|
| Full pathname of the PDF file. |
Returns:
bool: True if it succeeds, false if it fails.
Example:
<xsl:variable name="VarSuccess" select="wwadapter:GeneratePDFWithSaveAs($VarDocPath, $VarConversionPath, true(), $VarTocStyles, $VarGroupFiles, $VarJobSettings, $VarPdfPath)" />GeneratePostScriptForImage
Generates postscript for image.
Syntax:
wwadapter:GeneratePostScriptForImage($input, $postScriptPath)
wwadapter:GeneratePostScriptForImage($input, $postScriptPath, $effectiveWidthPx, $effectiveHeightPx)Parameters:
Name | Type | Description |
|---|---|---|
|
| Node set containing content to be converted to postscript. |
|
| Full pathname of the postscript file to create. |
|
|
|
|
|
|
Returns:
bool: True if it succeeds, false if it fails.
Example:
<xsl:variable name="VarPsPath" select="wwfilesystem:Combine($VarDataDir, 'image.ps')" />
<xsl:variable name="VarSuccess" select="wwadapter:GeneratePostScriptForImage($VarFrameNode, $VarPsPath)" />GeneratePostScriptForPDF
Generates a postscript for PDF.
Syntax:
wwadapter:GeneratePostScriptForPDF($originalDocumentPath, $conversionPDFDocumentPath, $singleFile, $tocStyleNodesIterator, $groupFileNodesIterator, $postScriptFilePath)Parameters:
Name | Type | Description |
|---|---|---|
|
| Full pathname of the original document file. |
|
| Full pathname of the conversion PDF document file. |
|
| True for single file. |
|
| The TOC style node set. |
|
| The group file node set. |
|
| Full pathname of the postscript file. |
Returns:
long: Number of pages in the PDF.
Example:
<xsl:variable name="VarPageCount" select="wwadapter:GeneratePostScriptForPDF($VarDocPath, $VarConversionPath, false(), $VarTocStyles, $VarGroupFiles, $VarPsPath)" />SetPDFPageNumberOffset
Sets PDF page number offset.
Syntax:
wwadapter:SetPDFPageNumberOffset($pageNumberOffset)Parameters:
Name | Type | Description |
|---|---|---|
|
| The page number offset. |
Example:
<xsl:variable name="VarSetOffset" select="wwadapter:SetPDFPageNumberOffset(0)" />TemporaryLicense
Checks if user is running a temporary license for specified 'toolAdapterName'.
Syntax:
wwadapter:TemporaryLicense($toolAdapterName)Parameters:
Name | Type | Description |
|---|---|---|
|
| Name of the tool adapter. |
Returns:
bool: True if is temporary, false otherwise.
Example:
<xsl:variable name="VarIsEval" select="wwadapter:TemporaryLicense('Word')" />
<xsl:if test="$VarIsEval">
<div class="eval-notice">Evaluation Version</div>
</xsl:if>