XfoInterface::XfoObj Class Reference

#include <xfoifc.h>

List of all members.

Public Member Functions

 XfoObj ()
 Constructor.
virtual ~XfoObj ()
 Destructor.
XfoCppIfObject * getXfoObj () const
 Get instance of XfoObj.
FORMATTERTYPE getFormatterType () const
 Get formatter type.
void setFormatterType (FORMATTERTYPE newVal)
 Set formatter type.
char * getHtmlDefaultCharset (char *pVal, int size) const
 Get html default charset.
wchar_t * getHtmlDefaultCharsetW (wchar_t *pVal, int size) const
 Get html default charset.
void setHtmlDefaultCharset (const char *newVal)
 Set html default charset.
void setHtmlDefaultCharsetW (const wchar_t *newVal)
 Set html default charset.
char * getDocumentURI (char *pVal, int size) const
 Get the URL of XML document you will format.
wchar_t * getDocumentURIW (wchar_t *pVal, int size) const
 Get the URL of XML document you will format.
void setDocumentURI (const char *newVal)
 Specifies the URL of XML document you will format.
void setDocumentURIW (const wchar_t *newVal)
 Specifies the URL of XML document you will format.
char * getStylesheetURI (char *pVal, int size) const
 Get the URI of XSL stylesheet for formatting.
wchar_t * getStylesheetURIW (wchar_t *pVal, int size) const
 Get the URI of XSL stylesheet for formatting.
void setStylesheetURI (const char *newVal)
 Specifies the URI of XSL stylesheet for formatting.
void setStylesheetURIW (const wchar_t *newVal)
 Specifies the URI of XSL stylesheet for formatting.
void addUserStylesheetURI (const char *newVal)
 Append the path name of user stylesheet file which describes AH Formatter options.
void addUserStylesheetURIW (const wchar_t *newVal)
 Append the path name of user stylesheet file which describes AH Formatter options.
char * getStylesheetTitle (char *pVal, int size) const
 Get the prior stylesheet title.
wchar_t * getStylesheetTitleW (wchar_t *pVal, int size) const
 Get the prior stylesheet title.
void setStylesheetTitle (const char *newVal)
 Set the prior stylesheet title.
void setStylesheetTitleW (const wchar_t *newVal)
 Set the prior stylesheet title.
char * getOutputFilePath (char *pVal, int size) const
 Get the path name of the output file.
wchar_t * getOutputFilePathW (wchar_t *pVal, int size) const
 Get the path name of the output file.
void setOutputFilePath (const char *newVal)
 Specifies the path name of the output file.
void setOutputFilePathW (const wchar_t *newVal)
 Specifies the path name of the output file.
char * getOptionFileURI (char *pVal, int size, int n=0) const
 Get the path name of XML-format Option setting file which describes AH Formatter options.
wchar_t * getOptionFileURIW (wchar_t *pVal, int size, int n=0) const
 Get the path name of XML-format Option setting file which describes AH Formatter options.
void setOptionFileURI (const char *newVal)
 Specifies the path name of XML-format Option setting file which describes AH Formatter options.
void setOptionFileURIW (const wchar_t *newVal)
 Specifies the path name of XML-format Option setting file which describes AH Formatter options.
void addOptionFileURI (const char *newVal)
 Append the path name of XML-format Option setting file which describes AH Formatter options.
void addOptionFileURIW (const wchar_t *newVal)
 Append the path name of XML-format Option setting file which describes AH Formatter options.
int getOptionFileCount () const
 Get the number of URIs of XML-format Option setting file which describes AH Formatter options.
char * getOutputFOPath (char *pVal, int size) const
 Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
wchar_t * getOutputFOPathW (wchar_t *pVal, int size) const
 Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
void setOutputFOPath (const char *newVal)
 Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
void setOutputFOPathW (const wchar_t *newVal)
 Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
char * getExternalXSLT (char *pVal, int size) const
 Get the command line of External XSLT Processor.
wchar_t * getExternalXSLTW (wchar_t *pVal, int size) const
 Get the command line of External XSLT Processor.
void setExternalXSLT (const char *newVal)
 Specifies the command line of External XSLT Processor.
void setExternalXSLTW (const wchar_t *newVal)
 Specifies the command line of External XSLT Processor.
char * getBaseURI (char *pVal, int size) const
 Get the default base URI.
wchar_t * getBaseURIW (wchar_t *pVal, int size) const
 Get the default base URI.
void setBaseURI (const char *newVal)
 Specifies the default base URI.
void setBaseURIW (const wchar_t *newVal)
 Specifies the default base URI.
char * getXSLTParamFormat (char *pVal, int size) const
 Get the parameter format of xsl:param when using External XSLT Processor.
wchar_t * getXSLTParamFormatW (wchar_t *pVal, int size)
 Get the parameter format of xsl:param when using External XSLT Processor.
void setXSLTParamFormat (const char *newVal)
 Specifies the parameter format of xsl:param when using External XSLT Processor.
void setXSLTParamFormatW (const wchar_t *newVal)
 Specifies the parameter format of xsl:param when using External XSLT Processor.
long getStartPage () const
 Get the start page number of document to output.
void setStartPage (long newVal)
 Specifies the start page number of document to output.
long getEndPage () const
 Get the end page number of document to output.
void setEndPage (long newVal)
 Specifies the end page number of document to output.
void setPdfMasterPassword (const char *newVal)
void setPdfMasterPasswordW (const wchar_t *newVal)
void setPdfOwnerPassword (const char *newVal)
 Effective when outputting to PDF.
void setPdfOwnerPasswordW (const wchar_t *newVal)
 Effective when outputting to PDF.
void setPdfUserPassword (const char *newVal)
 Effective when outputting to PDF.
void setPdfUserPasswordW (const wchar_t *newVal)
 Effective when outputting to PDF.
void setPdfNoPrinting (long newVal)
 Effective when outputting to PDF.
long getPdfNoPrinting () const
 Effective when outputting to PDF.
void setPdfNoChanging (long newVal)
 Effective when outputting to PDF.
long getPdfNoChanging () const
 Effective when outputting to PDF.
void setPdfNoContentCopying (long newVal)
 Effective when outputting to PDF.
long getPdfNoContentCopying () const
 Effective when outputting to PDF.
void setPdfNoAddingOrChangingCommnets (long newVal)
 Effective when outputting to PDF.
long getPdfNoAddingOrChangingCommnets () const
 Effective when outputting to PDF.
void setPdfNoAddingOrChangingComments (long newVal)
 Effective when outputting to PDF.
long getPdfNoAddingOrChangingComments () const
 Effective when outputting to PDF.
void setPdfVersion (PDFVERSION newVal)
 Effective when outputting to PDF.
PDFVERSION getPdfVersion () const
 Effective when outputting to PDF.
void setPdfNoFillForm (long newVal)
 Effective when outputting to PDF.
long getPdfNoFillForm () const
 Effective when outputting to PDF.
void setPdfNoAccessibility (long newVal)
 Effective when outputting to PDF.
long getPdfNoAccessibility () const
 Effective when outputting to PDF.
void setPdfNoAssembleDoc (long newVal)
 Effective when outputting to PDF.
long getPdfNoAssembleDoc () const
 Effective when outputting to PDF.
void setPdfEncryptLevel (PDFENCRYPTLEVEL newVal)
 Effective when outputting to PDF.
PDFENCRYPTLEVEL getPdfEncryptLevel () const
 Effective when outputting to PDF.
long getPdfEmbedAllFonts () const
 Effective when outputting to PDF.
void setPdfEmbedAllFonts (long newVal)
 Effective when outputting to PDF.
char * getPdfEmbedFonts (char *pVal, int size) const
 Effective when outputting to PDF.
wchar_t * getPdfEmbedFontsW (wchar_t *pVal, int size) const
 Effective when outputting to PDF.
void setPdfEmbedFonts (const char *newVal)
 Effective when outputting to PDF.
void setPdfEmbedFontsW (const wchar_t *newVal)
 Effective when outputting to PDF.
long getPdfErrorOnEmbedFault () const
 Effective when outputting to PDF.
void setPdfErrorOnEmbedFault (long newVal)
 Effective when outputting to PDF.
long getPdfErrorOnMissingGlyph () const
 Effective when outputting to PDF.
void setPdfErrorOnMissingGlyph (long newVal)
 Effective when outputting to PDF.
PDFPRINTALLOW getPdfPrintingAllowed () const
 Effective when outputting to PDF.
void setPdfPrintingAllowed (PDFPRINTALLOW newVal)
 Effective when outputting to PDF.
PDFIMAGECOMPRESSION getPdfImageCompression () const
 Effective when outputting to PDF.
void setPdfImageCompression (PDFIMAGECOMPRESSION newVal)
 Effective when outputting to PDF.
int getPdfJPEGQuality () const
 Gets the value of the quality of JPEG format that is specified by xfo_setPdfImageCompression() stored in PDF.
void setPdfJPEGQuality (int newVal)
 Effective when outputting to PDF.
long getPdfCompressContentStream () const
 Effective when outputting to PDF.
void setPdfCompressContentStream (long newVal)
 Effective when outputting to PDF.
long getPdfUseLaunchForRelativeURI () const
 Effective when outputting to PDF.
void setPdfUseLaunchForRelativeURI (long newVal)
 Effective when outputting to PDF.
PDFRGBCONVERSION getPdfRGBConversion () const
 Effective when outputting to PDF.
void setPdfRGBConversion (PDFRGBCONVERSION newVal)
 Effective when outputting to PDF.
int getPdfRasterizeResolution () const
 Effective when outputting to PDF.
void setPdfRasterizeResolution (int newVal)
 Effective when outputting to PDF.
long getPdfLinearize () const
 Effective when outputting to PDF.
void setPdfLinearize (long newVal)
 Effective when outputting to PDF.
long getPdfSignature () const
 Effective when outputting to PDF.
void setPdfSignature (long newVal)
 Effective when outputting to PDF.
char * getPdfSignatureName (char *pVal, int size) const
 Effective when outputting to PDF.
wchar_t * getPdfSignatureNameW (wchar_t *pVal, int size) const
 Effective when outputting to PDF.
void setPdfSignatureName (const char *newVal)
 Effective when outputting to PDF.
void setPdfSignatureNameW (const wchar_t *newVal)
 Effective when outputting to PDF.
char * getPdfCertificateName (char *pVal, int size) const
 Effective when outputting to PDF.
wchar_t * getPdfCertificateNameW (wchar_t *pVal, int size) const
 Effective when outputting to PDF.
void setPdfCertificateName (const char *newVal)
 Effective when outputting to PDF.
void setPdfCertificateNameW (const wchar_t *newVal)
 Effective when outputting to PDF.
EMBEDALLFONT getPdfEmbedAllFontsEx (void) const
 Effective when outputting to PDF.
void setPdfEmbedAllFontsEx (EMBEDALLFONT newVal)
 Effective when outputting to PDF.
IMAGEDOWNSAMPLING getPdfImageDownSampling (void) const
 Effective when outputting to PDF.
void setPdfImageDownSampling (IMAGEDOWNSAMPLING newVal)
 Effective when outputting to PDF.
int getPdfImageDownSamplingTarget (void) const
 Effective when outputting to PDF.
void setPdfImageDownSamplingTarget (int newVal)
 Effective when outputting to PDF.
int getPdfImageDownSamplingDPI (void) const
 Effective when outputting to PDF.
void setPdfImageDownSamplingDPI (int newVal)
 Effective when outputting to PDF.
long getPdfPutImageColorProfile (void) const
 Effective when outputting to PDF.
void setPdfPutImageColorProfile (long newVal)
 Effective when outputting to PDF.
PDFIMAGECOMPRESSION getPdfGrayscaleImageCompression (void) const
 Effective when outputting to PDF.
void setPdfGrayscaleImageCompression (PDFIMAGECOMPRESSION newVal)
 Effective when outputting to PDF.
int getPdfGrayscaleJPEGQuality (void) const
 Effective when outputting to PDF.
void setPdfGrayscaleJPEGQuality (int newVal)
 Effective when outputting to PDF.
IMAGEDOWNSAMPLING getPdfGrayscaleImageDownSampling (void) const
 Effective when outputting to PDF.
void setPdfGrayscaleImageDownSampling (IMAGEDOWNSAMPLING newVal)
 Effective when outputting to PDF.
int getPdfGrayscaleImageDownSamplingTarget (void) const
 Effective when outputting to PDF.
void setPdfGrayscaleImageDownSamplingTarget (int newVal)
 Effective when outputting to PDF.
int getPdfGrayscaleImageDownSamplingDPI (void) const
 Effective when outputting to PDF.
void setPdfGrayscaleImageDownSamplingDPI (int newVal)
 Effective when outputting to PDF.
MONOCHROMECOMPRESSION getPdfMonochromeImageCompression (void) const
 Effective when outputting to PDF.
void setPdfMonochromeImageCompression (MONOCHROMECOMPRESSION newVal)
 Effective when outputting to PDF.
IMAGEDOWNSAMPLING getPdfMonochromeImageDownSampling (void) const
 Effective when outputting to PDF.
void setPdfMonochromeImageDownSampling (IMAGEDOWNSAMPLING newVal)
 Effective when outputting to PDF.
int getPdfMonochromeImageDownSamplingTarget (void) const
 Effective when outputting to PDF.
void setPdfMonochromeImageDownSamplingTarget (int newVal)
 Effective when outputting to PDF.
int getPdfMonochromeImageDownSamplingDPI (void) const
 Effective when outputting to PDF.
void setPdfMonochromeImageDownSamplingDPI (int newVal)
 Effective when outputting to PDF.
long getTwoPassFormatting () const
 Gets the specification of two pass format.
void setTwoPassFormatting (long newVal)
 Set the specification of two pass format.
long getPdfTag () const
 Effective when outputting to PDF.
void setPdfTag (long newVal)
 Effective when outputting to PDF.
char * getPdfOutputWidth (char *pVal, int size) const
 Effective when outputting to PDF.
wchar_t * getPdfOutputWidthW (wchar_t *pVal, int size) const
 Effective when outputting to PDF.
void setPdfOutputWidth (const char *newVal)
 Effective when outputting to PDF.
void setPdfOutputWidthW (const wchar_t *newVal)
 Effective when outputting to PDF.
char * getPdfOutputHeight (char *pVal, int size) const
 Effective when outputting to PDF.
wchar_t * getPdfOutputHeightW (wchar_t *pVal, int size) const
 Effective when outputting to PDF.
void setPdfOutputHeight (const char *newVal)
 Effective when outputting to PDF.
void setPdfOutputHeightW (const wchar_t *newVal)
 Effective when outputting to PDF.
long getPdfErrorOnPDFXFault ()
 Effective when outputting to PDF.
void setPdfErrorOnPDFXFault (long newVal)
 Effective when outputting to PDF.
SVGVERSION getSvgVersion () const
 Effective when outputting to SVG.
void setSvgVersion (SVGVERSION newVal)
 Effective when outputting to SVG.
long getSvgGzipCompression () const
 Effective when outputting to SVG.
void setSvgGzipCompression (long newVal)
 Effective when outputting to SVG.
long getSvgEmbedAllFonts () const
 Effective when outputting to SVG.
void setSvgEmbedAllFonts (long newVal)
 Effective when outputting to SVG.
char * getSvgFormat (char *pVal, int size) const
 Effective when outputting to SVG.
wchar_t * getSvgFormatW (wchar_t *pVal, int size) const
 Effective when outputting to SVG.
void setSvgFormat (const char *newVal)
 Effective when outputting to SVG.
void setSvgFormatW (const wchar_t *newVal)
 Effective when outputting to SVG.
char * getSvgEmbedFonts (char *pVal, int size) const
 Effective when outputting to SVG.
wchar_t * getSvgEmbedFontsW (wchar_t *pVal, int size) const
 Effective when outputting to SVG.
void setSvgEmbedFonts (const char *newVal)
 Effective when outputting to SVG.
void setSvgEmbedFontsW (const wchar_t *newVal)
 Effective when outputting to SVG.
long getSvgErrorOnEmbedFault () const
 Effective when outputting to SVG.
void setSvgErrorOnEmbedFault (long newVal)
 Effective when outputting to SVG.
IMAGECONVERSION getSvgImageConversion () const
 Effective when outputting to SVG.
void setSvgImageConversion (IMAGECONVERSION newVal)
 Effective when outputting to SVG.
int getSvgJPEGQuality () const
 Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.
void setSvgJPEGQuality (int newVal)
 Effective when outputting to SVG.
IMAGEPROCTYPE getSvgImageProcessingType () const
 Effective when outputting to SVG.
void setSvgImageProcessingType (IMAGEPROCTYPE newVal)
 Effective when outputting to SVG.
char * getSvgImageCopyPath (char *pVal, int size) const
 Effective when outputting to SVG.
void setSvgImageCopyPath (const char *newVal)
 Effective when outputting to SVG.
wchar_t * getSvgImageCopyPathW (wchar_t *pVal, int size) const
 Effective when outputting to SVG.
void setSvgImageCopyPathW (const wchar_t *newVal)
 Effective when outputting to SVG.
long getSvgSingleFile () const
 Effective when outputting to SVG.
void setSvgSingleFile (long newVal)
 Effective when outputting to SVG.
long getSvgImageRename () const
 Effective when outputting to SVG.
void setSvgImageRename (long newVal)
 Effective when outputting to SVG.
char * getSvgImagePrefix (char *pVal, int size) const
 Effective when outputting to SVG.
void setSvgImagePrefix (const char *newVal)
 Effective when outputting to SVG.
wchar_t * getSvgImagePrefixW (wchar_t *pVal, int size) const
 Effective when outputting to SVG.
void setSvgImagePrefixW (const wchar_t *newVal)
 Effective when outputting to SVG.
long getSvgSinglePageNumber () const
 Effective when outputting to SVG.
void setSvgSinglePageNumber (long newVal)
 Effective when outputting to SVG.
int getSvgRasterizeResolution () const
 Effective when outputting to SVG.
void setSvgRasterizeResolution (int newVal)
 Effective when outputting to SVG.
long getStartVolume () const
 Get the start volume of document to output.
void setStartVolume (long newVal)
 Specifies the start volume of document to output.
long getEndVolume () const
 Get the end volume of document to output.
void setEndVolume (long newVal)
 Specifies the end volume of document to output.
long getMultiVolume () const
 Get multiple volume of PDF output.
void setMultiVolume (long newVal)
 Specifies multiple volume of PDF output.
long getTotalVolumeCount () const
 Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.
long getOutputVolumeCount () const
 Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.
XfoIfErrorLevel getExitLevel () const
 Get the error level to abort formatting process.
void setExitLevel (XfoIfErrorLevel newVal)
 Error level to abort formatting process.
XfoIfErrorLevel getErrorLevel () const
 Returns the error level of the error that occurred during the formatting process.
XfoIfErrorCode getErrorCode () const
 Returns the error code of the error that occurred during the formatting process.
char * getErrorMessage (char *pVal, int size) const
 Returns the error message of the error that occurred during the formatting process.
wchar_t * getErrorMessageW (wchar_t *pVal, int size) const
 Returns the error message of the error that occurred during the formatting process.
void setFontAlias (const char *src, const char *dst)
 Sets the substitution of font name.
void setFontAliasW (const wchar_t *src, const wchar_t *dst)
 Sets the substitution of font name.
void clearFontAlias ()
 Clear all substitutions of font name.
void eraseFontAlias (const char *src)
 Erase the substitution of font name 'fontName'.
void eraseFontAliasW (const wchar_t *src)
 Erase the substitution of font name 'fontName'.
XfoIfErrorCode execute (bool bNoThrow=false)
 Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
void render (std::istream &src, std::ostream &out)
 Executes the formatting of XSL-FO document specified for inputStream, and outputs it to outputStream in the output form specified for setPrinterName.
void clear ()
 Initialize formatting engine.
void setXSLTParam (const char *paramName, const char *value)
 Set parameter name and value for xsl:param.
void setXSLTParamW (const wchar_t *paramName, const wchar_t *value)
 Set parameter name and value for xsl:param.
void clearXSLTParam ()
 Clear all parameter name and value for xsl:param.
void setMessageListener (MessageListener *listener)
 Register the MessageListener interface to the instance of implemented class The error that occurred during the formatting process can be received as the event.
void setFormatPageListener (FormatPageListener *listener)
 Register the FormatPageListener interface to the instance of implemented class The page number that formatted during the formatting process can be received as the event.
XfoErrorStreamType getErrorStreamType () const
 Get the error output type.
void setErrorStreamType (XfoErrorStreamType type)
 Set the error output type.
char * getPrinterName (char *pVal, int size) const
 Get the printer name where the formatted result is outputted.
wchar_t * getPrinterNameW (wchar_t *pVal, int size) const
 Get the printer name where the formatted result is outputted.
void setPrinterName (const char *newVal)
 Specifies the output format or the printer name to output.
void setPrinterNameW (const wchar_t *newVal)
 Specifies the output format or the printer name to output.
long getFormattedPages () const
 Get formatted total pages.
char * getPrinterSettingURI (char *pVal, int size) const
 Get the printer setting file URI.
wchar_t * getPrinterSettingURIW (wchar_t *pVal, int size) const
 Get the printer setting file URI.
void setPrinterSettingURI (const char *newVal)
 Specifies the printer setting file URI.
void setPrinterSettingURIW (const wchar_t *newVal)
 Specifies the printer setting file URI.
long getPrnCopies () const
 Get the number of copies.
void setPrnCopies (long newVal)
 Specifies the number of copies.
long getPrnCollate () const
 Get collation of multiple copies.
void setPrnCollate (long newVal)
 Specifies collation of multiple copies.
long getBatchPrint () const
 Get the setting of whether print dialog box is displayed or not when printing.
void setBatchPrint (long newVal)
 When the value 'false' is specified, the print dialog box is displayed when printing.
char * getStylesheetText (char *pVal, int size) const
 Get the text of XSL stylesheet for formatting.
wchar_t * getStylesheetTextW (wchar_t *pVal, int size) const
 Get the text of XSL stylesheet for formatting.
void setStylesheetText (const char *newVal)
 Specifies the text of XSL stylesheet for formatting.
void setStylesheetTextW (const wchar_t *newVal)
 Specifies the text of XSL stylesheet for formatting.
char * getVersion (char *pVal, int size) const
 Get the version string of AH Formatter.
wchar_t * getVersionW (wchar_t *pVal, int size) const
 Get the version string of AH Formatter.

Private Attributes

XfoCppIfObject * m_pXfoObj

Constructor & Destructor Documentation

XfoInterface::XfoObj::XfoObj (  ) 

Constructor.

virtual XfoInterface::XfoObj::~XfoObj (  )  [virtual]

Destructor.

Member Function Documentation

XfoCppIfObject* XfoInterface::XfoObj::getXfoObj (  )  const [inline]

Get instance of XfoObj.

Returns:
pointer to XfoObj instance.

FORMATTERTYPE XfoInterface::XfoObj::getFormatterType (  )  const

Get formatter type.

only after Formatter 5.

Returns:
type of formatter.

void XfoInterface::XfoObj::setFormatterType ( FORMATTERTYPE  newVal  ) 

Set formatter type.

only after Formatter 5.

Parameters:
newVal type of formatter.

char* XfoInterface::XfoObj::getHtmlDefaultCharset ( char *  pVal,
int  size 
) const

Get html default charset.

only after Formatter 5.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getHtmlDefaultCharsetW ( wchar_t *  pVal,
int  size 
) const

Get html default charset.

only after Formatter 5.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setHtmlDefaultCharset ( const char *  newVal  ) 

Set html default charset.

Parameters:
newVal Pointer to a null-terminated string to be used as the html default charset.

void XfoInterface::XfoObj::setHtmlDefaultCharsetW ( const wchar_t *  newVal  ) 

Set html default charset.

Parameters:
newVal Pointer to a null-terminated string to be used as the html default charset.

char* XfoInterface::XfoObj::getDocumentURI ( char *  pVal,
int  size 
) const

Get the URL of XML document you will format.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getDocumentURIW ( wchar_t *  pVal,
int  size 
) const

Get the URL of XML document you will format.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setDocumentURI ( const char *  newVal  ) 

Specifies the URL of XML document you will format.

If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin. The document loaded from stdin are supposed to be FO files.

Parameters:
newVal Pointer to a null-terminated string to be used as the URL of XML document.

void XfoInterface::XfoObj::setDocumentURIW ( const wchar_t *  newVal  ) 

Specifies the URL of XML document you will format.

If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin. The document loaded from stdin are supposed to be FO files.

Parameters:
newVal Pointer to a null-terminated string to be used as the URL of XML document.

char* XfoInterface::XfoObj::getStylesheetURI ( char *  pVal,
int  size 
) const

Get the URI of XSL stylesheet for formatting.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getStylesheetURIW ( wchar_t *  pVal,
int  size 
) const

Get the URI of XSL stylesheet for formatting.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setStylesheetURI ( const char *  newVal  ) 

Specifies the URI of XSL stylesheet for formatting.

If the specified XML document is FO, or the XML file contains the processing instruction <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored. Otherwise if there is no setting of this property, an error occurs.

Parameters:
newVal Pointer to a null-terminated string to be used as the URL of XSL stylesheet.

void XfoInterface::XfoObj::setStylesheetURIW ( const wchar_t *  newVal  ) 

Specifies the URI of XSL stylesheet for formatting.

If the specified XML document is FO, or the XML file contains the processing instruction <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored. Otherwise if there is no setting of this property, an error occurs.

Parameters:
newVal Pointer to a null-terminated string to be used as the URL of XSL stylesheet.

void XfoInterface::XfoObj::addUserStylesheetURI ( const char *  newVal  ) 

Append the path name of user stylesheet file which describes AH Formatter options.

Since:
5.0
Parameters:
newVal Pointer to a null-terminated string to be used as the path name of HTML user stylesheet file.

void XfoInterface::XfoObj::addUserStylesheetURIW ( const wchar_t *  newVal  ) 

Append the path name of user stylesheet file which describes AH Formatter options.

Since:
5.0
Parameters:
newVal Pointer to a null-terminated string to be used as the path name of HTML user stylesheet file.

char* XfoInterface::XfoObj::getStylesheetTitle ( char *  pVal,
int  size 
) const

Get the prior stylesheet title.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getStylesheetTitleW ( wchar_t *  pVal,
int  size 
) const

Get the prior stylesheet title.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setStylesheetTitle ( const char *  newVal  ) 

Set the prior stylesheet title.

Parameters:
newVal Pointer to a null-terminated string to be used as the priority title.

void XfoInterface::XfoObj::setStylesheetTitleW ( const wchar_t *  newVal  ) 

Set the prior stylesheet title.

Parameters:
newVal Pointer to a null-terminated string to be used as the priority title.

char* XfoInterface::XfoObj::getOutputFilePath ( char *  pVal,
int  size 
) const

Get the path name of the output file.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getOutputFilePathW ( wchar_t *  pVal,
int  size 
) const

Get the path name of the output file.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setOutputFilePath ( const char *  newVal  ) 

Specifies the path name of the output file.

When "\@STDOUT" is specified, it is considered as stdout. If both the printer name and this property are specified, the formatted result will be stored in the file by the printer driver. When "\@PDF" is specified as output, the PDF is stored in the file specified by this property. If the property is not specified, it is considered as stdout.

Parameters:
newVal Pointer to a null-terminated string to be used as the path name of the output file.

void XfoInterface::XfoObj::setOutputFilePathW ( const wchar_t *  newVal  ) 

Specifies the path name of the output file.

When "\@STDOUT" is specified, it is considered as stdout. If both the printer name and this property are specified, the formatted result will be stored in the file by the printer driver. When "\@PDF" is specified as output, the PDF is stored in the file specified by this property. If the property is not specified, it is considered as stdout.

Parameters:
newVal Pointer to a null-terminated string to be used as the path name of the output file.

char* XfoInterface::XfoObj::getOptionFileURI ( char *  pVal,
int  size,
int  n = 0 
) const

Get the path name of XML-format Option setting file which describes AH Formatter options.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
n Specifies to get n-th URI. 0 means first URI.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getOptionFileURIW ( wchar_t *  pVal,
int  size,
int  n = 0 
) const

Get the path name of XML-format Option setting file which describes AH Formatter options.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
n Specifies to get n-th URI. 0 means first URI.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setOptionFileURI ( const char *  newVal  ) 

Specifies the path name of XML-format Option setting file which describes AH Formatter options.

The set of former URIs is thrown away.

Parameters:
newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

void XfoInterface::XfoObj::setOptionFileURIW ( const wchar_t *  newVal  ) 

Specifies the path name of XML-format Option setting file which describes AH Formatter options.

The set of former URIs is thrown away.

Parameters:
newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

void XfoInterface::XfoObj::addOptionFileURI ( const char *  newVal  ) 

Append the path name of XML-format Option setting file which describes AH Formatter options.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

void XfoInterface::XfoObj::addOptionFileURIW ( const wchar_t *  newVal  ) 

Append the path name of XML-format Option setting file which describes AH Formatter options.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.

int XfoInterface::XfoObj::getOptionFileCount (  )  const

Get the number of URIs of XML-format Option setting file which describes AH Formatter options.

Since:
3.1
Returns:
Returns the number of URIs.

char* XfoInterface::XfoObj::getOutputFOPath ( char *  pVal,
int  size 
) const

Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getOutputFOPathW ( wchar_t *  pVal,
int  size 
) const

Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setOutputFOPath ( const char *  newVal  ) 

Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout. If the setting is omitted, nothing outputs.

Parameters:
newVal Pointer to a null-terminated string to be used as the path name of output FO file.

void XfoInterface::XfoObj::setOutputFOPathW ( const wchar_t *  newVal  ) 

Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.

If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout. If the setting is omitted, nothing outputs.

Parameters:
newVal Pointer to a null-terminated string to be used as the path name of output FO file.

char* XfoInterface::XfoObj::getExternalXSLT ( char *  pVal,
int  size 
) const

Get the command line of External XSLT Processor.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getExternalXSLTW ( wchar_t *  pVal,
int  size 
) const

Get the command line of External XSLT Processor.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setExternalXSLT ( const char *  newVal  ) 

Specifies the command line of External XSLT Processor.

If this is omitted, default MSXML3 will be used. For example: 

	xslt %param -o %3 %1 %2

These meanings are as follows.

	%1 : XML Document
	%2 : XSL Stylesheet
	%3 : XSLT Output File
	%param : xsl:param
%1 to %3 are used to express only parameter positions. Do not replace them actual file names. In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.

Parameters:
newVal Pointer to a null-terminated string to be used as the command line of External XSLT Processor.

void XfoInterface::XfoObj::setExternalXSLTW ( const wchar_t *  newVal  ) 

Specifies the command line of External XSLT Processor.

If this is omitted, default MSXML3 will be used. For example: 

	xslt %param -o %3 %1 %2

These meanings are as follows.

	%1 : XML Document
	%2 : XSL Stylesheet
	%3 : XSLT Output File
	%param : xsl:param
%1 to %3 are used to express only parameter positions. Do not replace them actual file names. In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.

Parameters:
newVal Pointer to a null-terminated string to be used as the command line of External XSLT Processor.

char* XfoInterface::XfoObj::getBaseURI ( char *  pVal,
int  size 
) const

Get the default base URI.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getBaseURIW ( wchar_t *  pVal,
int  size 
) const

Get the default base URI.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setBaseURI ( const char *  newVal  ) 

Specifies the default base URI.

Parameters:
newVal Pointer to a null-terminated string to be used as the default base URI.

void XfoInterface::XfoObj::setBaseURIW ( const wchar_t *  newVal  ) 

Specifies the default base URI.

Parameters:
newVal Pointer to a null-terminated string to be used as the default base URI.

char* XfoInterface::XfoObj::getXSLTParamFormat ( char *  pVal,
int  size 
) const

Get the parameter format of xsl:param when using External XSLT Processor.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getXSLTParamFormatW ( wchar_t *  pVal,
int  size 
)

Get the parameter format of xsl:param when using External XSLT Processor.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setXSLTParamFormat ( const char *  newVal  ) 

Specifies the parameter format of xsl:param when using External XSLT Processor.

For example: 

	 -p %p %v

These meanings are as follows.

	%p : Parameter Name
	%v : Parameter Value

Parameters:
newVal Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.

void XfoInterface::XfoObj::setXSLTParamFormatW ( const wchar_t *  newVal  ) 

Specifies the parameter format of xsl:param when using External XSLT Processor.

For example: 

	 -p %p %v

These meanings are as follows.

	%p : Parameter Name
	%v : Parameter Value

Parameters:
newVal Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.

long XfoInterface::XfoObj::getStartPage (  )  const

Get the start page number of document to output.

Returns:
start page number of document to output.

void XfoInterface::XfoObj::setStartPage ( long  newVal  ) 

Specifies the start page number of document to output.

If the start page is omitted or the specified value is 0 or less, the start page is considered from the first page. If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.

Parameters:
newVal start page number of output.

long XfoInterface::XfoObj::getEndPage (  )  const

Get the end page number of document to output.

Returns:
end page number of output.

void XfoInterface::XfoObj::setEndPage ( long  newVal  ) 

Specifies the end page number of document to output.

If the end page is omitted or the specified value exceeds the actual page number, the end page is considered as the last page. If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.

Parameters:
newVal end page number of output.

void XfoInterface::XfoObj::setPdfMasterPassword ( const char *  newVal  ) 

Deprecated:
Effective when outputting to PDF. Specifies the master password for PDF. The password must be within 32 bytes.
Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the master password.

void XfoInterface::XfoObj::setPdfMasterPasswordW ( const wchar_t *  newVal  ) 

Deprecated:
Effective when outputting to PDF. Specifies the master password for PDF. The password must be within 32 bytes.
Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the master password.

void XfoInterface::XfoObj::setPdfOwnerPassword ( const char *  newVal  ) 

Effective when outputting to PDF.

Specifies the owner password for PDF. The password must be within 32 bytes.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the owner password.

void XfoInterface::XfoObj::setPdfOwnerPasswordW ( const wchar_t *  newVal  ) 

Effective when outputting to PDF.

Specifies the owner password for PDF. The password must be within 32 bytes.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the owner password.

void XfoInterface::XfoObj::setPdfUserPassword ( const char *  newVal  ) 

Effective when outputting to PDF.

Specifies the user password for PDF. The password must be within 32 bytes.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the user password.

void XfoInterface::XfoObj::setPdfUserPasswordW ( const wchar_t *  newVal  ) 

Effective when outputting to PDF.

Specifies the user password for PDF. The password must be within 32 bytes.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the user password.

void XfoInterface::XfoObj::setPdfNoPrinting ( long  newVal  ) 

Effective when outputting to PDF.

Disables printing the PDF file.

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables printing the PDF file.

long XfoInterface::XfoObj::getPdfNoPrinting (  )  const

Effective when outputting to PDF.

Get disables printing the PDF file.

Since:
3.1
Returns:
If zero is returned, Enables printing the PDF file. If nonezero is returned, Disables printing the PDF file.

void XfoInterface::XfoObj::setPdfNoChanging ( long  newVal  ) 

Effective when outputting to PDF.

Disables making changes of the PDF file.

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables making changes of the PDF file.

long XfoInterface::XfoObj::getPdfNoChanging (  )  const

Effective when outputting to PDF.

Get disables making changes of the PDF file.

Since:
3.1
Returns:
If zero is returned, Enables making changes of the PDF file. If nonezero is returned, Disables making changes of the PDF file.

void XfoInterface::XfoObj::setPdfNoContentCopying ( long  newVal  ) 

Effective when outputting to PDF.

Disables copying the content of the PDF file.

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables copying the content of the PDF file.

long XfoInterface::XfoObj::getPdfNoContentCopying (  )  const

Effective when outputting to PDF.

Get disables copying the content of the PDF file.

Since:
3.1
Returns:
If zero is returned, Enables copying the content of the PDF file. If nonezero is returned, Disables copying the content of the PDF file.

void XfoInterface::XfoObj::setPdfNoAddingOrChangingCommnets ( long  newVal  ) 

Effective when outputting to PDF.

Disables adding comments and form fields to the PDF file.

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.

long XfoInterface::XfoObj::getPdfNoAddingOrChangingCommnets (  )  const

Effective when outputting to PDF.

Get disables adding comments and form fields to the PDF file.

Since:
3.1
Returns:
If zero is returned, Enables adding comments and form fields to the PDF file. If nonezero is returned, Disables adding comments and form fields to the PDF file.

void XfoInterface::XfoObj::setPdfNoAddingOrChangingComments ( long  newVal  ) 

Effective when outputting to PDF.

Disables adding comments and form fields to the PDF file.

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.

long XfoInterface::XfoObj::getPdfNoAddingOrChangingComments (  )  const

Effective when outputting to PDF.

Get disables adding comments and form fields to the PDF file.

Since:
3.1
Returns:
If zero is returned, Enables adding comments and form fields to the PDF file. If nonezero is returned, Disables adding comments and form fields to the PDF file.

void XfoInterface::XfoObj::setPdfVersion ( PDFVERSION  newVal  ) 

Effective when outputting to PDF.

Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5.

Since:
3.1
Parameters:
newVal Specifies the version of PDF.

PDFVERSION XfoInterface::XfoObj::getPdfVersion (  )  const

Effective when outputting to PDF.

Get the version of PDF.

Since:
3.1
Returns:
the version of PDF.

void XfoInterface::XfoObj::setPdfNoFillForm ( long  newVal  ) 

Effective when outputting to PDF.

Disables filling in of form fields and signing of the PDF file. This parameter is effective only when you specify PDF1.4 or later to PDF version.

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables filling in of form fields and signing of the PDF file.

long XfoInterface::XfoObj::getPdfNoFillForm (  )  const

Effective when outputting to PDF.

Get disables filling in of form fields and signing of the PDF file.

Since:
3.1
Returns:
If zero is returned, Enables filling in of form fields and signing of the PDF file. If nonezero is returned, Disables filling in of form fields and signing of the PDF file.

void XfoInterface::XfoObj::setPdfNoAccessibility ( long  newVal  ) 

Effective when outputting to PDF.

Disables text access for screen reader devices of the PDF file. This parameter is effective only when you specify 1.4 or later with PDF version.

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables text access for screen reader devices of the PDF file.

long XfoInterface::XfoObj::getPdfNoAccessibility (  )  const

Effective when outputting to PDF.

Get disables text access for screen reader devices of the PDF file.

Since:
3.1
Returns:
If zero is returned, Enables text access for screen reader devices of the PDF file. If nonezero is returned, Disables text access for screen reader devices of the PDF file.

void XfoInterface::XfoObj::setPdfNoAssembleDoc ( long  newVal  ) 

Effective when outputting to PDF.

Disables inserting, deleting and rotating the PDF pages. This parameter is effective only when you specify 1.4 or later with PDF version

Since:
3.1
Parameters:
newVal If nonezero is specified, Disables inserting, deleting and rotating the PDF pages.

long XfoInterface::XfoObj::getPdfNoAssembleDoc (  )  const

Effective when outputting to PDF.

Get disables inserting, deleting and rotating the PDF pages.

Since:
3.1
Returns:
If zero is returned, Enables inserting, deleting and rotating the PDF pages. If nonezero is returned, Disables inserting, deleting and rotating the PDF pages.

void XfoInterface::XfoObj::setPdfEncryptLevel ( PDFENCRYPTLEVEL  newVal  ) 

Effective when outputting to PDF.

Specifies the key length when encrypting the PDF file during outputting. The key length can be specified as either 40 or 128 (bit). This parameter is effective only when you specify PDF1.4 or later with PDF version

Since:
3.1
Parameters:
newVal Specifies the key length.

PDFENCRYPTLEVEL XfoInterface::XfoObj::getPdfEncryptLevel (  )  const

Effective when outputting to PDF.

Get the key length when encrypting the PDF file during outputting.

Since:
3.1
Returns:
the key length.

long XfoInterface::XfoObj::getPdfEmbedAllFonts (  )  const

Effective when outputting to PDF.

Gets the value of whether to embed all embeddable fonts in PDF.

Since:
3.1
Returns:
the value of whether to embed all embeddable fonts

void XfoInterface::XfoObj::setPdfEmbedAllFonts ( long  newVal  ) 

Effective when outputting to PDF.

Embeds all embeddable fonts in PDF to create.

Since:
3.1
Parameters:
newVal If the value is 'true' is specified, Embeds all embeddable fonts

char* XfoInterface::XfoObj::getPdfEmbedFonts ( char *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the font specified to be embedded in PDF.

Since:
3.1
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
the font specified to be embedded

wchar_t* XfoInterface::XfoObj::getPdfEmbedFontsW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the font specified to be embedded in PDF.

Since:
3.1
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
the font specified to be embedded

void XfoInterface::XfoObj::setPdfEmbedFonts ( const char *  newVal  ) 

Effective when outputting to PDF.

Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.

Since:
3.1
Parameters:
newVal fonts specified to embed

void XfoInterface::XfoObj::setPdfEmbedFontsW ( const wchar_t *  newVal  ) 

Effective when outputting to PDF.

Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.

Since:
3.1
Parameters:
newVal fonts specified to embed

long XfoInterface::XfoObj::getPdfErrorOnEmbedFault (  )  const

Effective when outputting to PDF.

Gets the value of whether to issues the error when failing to embed fonts.

Since:
3.1
Returns:
the value of whether to issues the error

void XfoInterface::XfoObj::setPdfErrorOnEmbedFault ( long  newVal  ) 

Effective when outputting to PDF.

An error is issued in case of failing to embed fonts.

Since:
3.1
Parameters:
newVal If the value is 'true' is specified, an error is issued.

long XfoInterface::XfoObj::getPdfErrorOnMissingGlyph (  )  const

Effective when outputting to PDF.

Gets the value of whether to issues the error when missing glyph.

Since:
3.3
Returns:
the value of whether to issues the error

void XfoInterface::XfoObj::setPdfErrorOnMissingGlyph ( long  newVal  ) 

Effective when outputting to PDF.

An error is issued in case of missing glyph.

Since:
3.3
Parameters:
newVal If the value is 'true' is specified, an error is issued.

PDFPRINTALLOW XfoInterface::XfoObj::getPdfPrintingAllowed (  )  const

Effective when outputting to PDF.

Gets the value of whether to print the resulting PDF file or not.

Since:
3.1
PRALLOW_NONE = 0 Not Allowed
PRALLOW_LOW = 1 Low Resolution Printing
PRALLOW_HIGH = 2 High Resolution Printing

Returns:
the value of printing allowed

void XfoInterface::XfoObj::setPdfPrintingAllowed ( PDFPRINTALLOW  newVal  ) 

Effective when outputting to PDF.

Spesifies whether to permit printing PDF to create with one of the following values. This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).

Since:
3.1
PRALLOW_NONE = 0 Not Allowed
PRALLOW_LOW = 1 Low Resolution Printing
PRALLOW_HIGH = 2 High Resolution Printing

Parameters:
newVal the value of printing allowed

PDFIMAGECOMPRESSION XfoInterface::XfoObj::getPdfImageCompression (  )  const

Effective when outputting to PDF.

Gets the value of how to compress the color images embedded in PDF.

Since:
3.1
IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Returns:
the value of how raster graphics are compressed and stored

void XfoInterface::XfoObj::setPdfImageCompression ( PDFIMAGECOMPRESSION  newVal  ) 

Effective when outputting to PDF.

When the color image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the color image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfMonochromeImageCompression for the monochrome image.

Since:
3.1
IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:
newVal the value of how raster graphics are compressed and stored

int XfoInterface::XfoObj::getPdfJPEGQuality (  )  const

Gets the value of the quality of JPEG format that is specified by xfo_setPdfImageCompression() stored in PDF.

Since:
3.1
Returns:
the value of the quality of JPEG format

void XfoInterface::XfoObj::setPdfJPEGQuality ( int  newVal  ) 

Effective when outputting to PDF.

For the color image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image.

Since:
3.1
Parameters:
newVal the value of the quality of JPEG format

long XfoInterface::XfoObj::getPdfCompressContentStream (  )  const

Effective when outputting to PDF.

Gets the value of whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.

Since:
3.1
Returns:
the value of whether make the size of PDF smaller or not

void XfoInterface::XfoObj::setPdfCompressContentStream ( long  newVal  ) 

Effective when outputting to PDF.

Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.

Since:
3.1
Parameters:
newVal If the value is 'true' is specified, make the PDF compress

long XfoInterface::XfoObj::getPdfUseLaunchForRelativeURI (  )  const

Effective when outputting to PDF.

Gets the value of how to transform external link specified by the relative address in the PDF link.

Since:
3.1
Returns:
the value of how to transform external link

void XfoInterface::XfoObj::setPdfUseLaunchForRelativeURI ( long  newVal  ) 

Effective when outputting to PDF.

Specifies whether the external link specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties.

Since:
3.1
Parameters:
newVal If nonezero is specified, it is transformed to 'Open the file'. If zero is specified, it is transformed to 'World Wide Web link'

PDFRGBCONVERSION XfoInterface::XfoObj::getPdfRGBConversion (  )  const

Effective when outputting to PDF.

Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.

Since:
3.1
RGBCONV_NONE = 0 No Conversion
RGBCONV_BLACK = 1 Black to DeviceGray
RGBCONV_GRAY = 2 Gray to DeviceGray
RGBCONV_ALL = 3 All RGB to DeviceGray

Returns:
the value of how to convert

void XfoInterface::XfoObj::setPdfRGBConversion ( PDFRGBCONVERSION  newVal  ) 

Effective when outputting to PDF.

Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.

Since:
3.1
RGBCONV_NONE = 0 No Conversion
RGBCONV_BLACK = 1 Black to DeviceGray
RGBCONV_GRAY = 2 Gray to DeviceGray
RGBCONV_ALL = 3 All RGB to DeviceGray

Parameters:
newVal the value of how to convert

int XfoInterface::XfoObj::getPdfRasterizeResolution (  )  const

Effective when outputting to PDF.

Gets the value of the rasterised-resolution of the transformed raster images.

Since:
3.1
Returns:
Rasterised-resolution

void XfoInterface::XfoObj::setPdfRasterizeResolution ( int  newVal  ) 

Effective when outputting to PDF.

Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in PDF as vectors without being transformed to raster images. This setting is effective only with Windows version.

Since:
3.1
Parameters:
newVal Rasterised-resolution (70 to 500)

long XfoInterface::XfoObj::getPdfLinearize (  )  const

Effective when outputting to PDF.

Gets the value of whether to output linearize PDF or not.

Since:
3.3
Returns:
the value of whether to output linearize pdf or not.

void XfoInterface::XfoObj::setPdfLinearize ( long  newVal  ) 

Effective when outputting to PDF.

Specifies whether to output linearize PDF or not.

Since:
3.3
Parameters:
newVal If the value is 'true' is specified, output linearlize PDF.

long XfoInterface::XfoObj::getPdfSignature (  )  const

Effective when outputting to PDF.

Gets the value of whether to sign a signature to PDF or not.

Since:
4.2
Returns:
the value of whether to sign a signature to PDF or not.

void XfoInterface::XfoObj::setPdfSignature ( long  newVal  ) 

Effective when outputting to PDF.

Specifies whether to sign a signature to PDF or not.

Since:
4.2
Parameters:
newVal If the value is 'true' is specified, sign a signature to PDF.

char* XfoInterface::XfoObj::getPdfSignatureName ( char *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the value of a signature information name.

Since:
4.2
Returns:
the value of a signature information name.

wchar_t* XfoInterface::XfoObj::getPdfSignatureNameW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the value of a signature information name.

Since:
4.2
Returns:
the value of a signature information name.

void XfoInterface::XfoObj::setPdfSignatureName ( const char *  newVal  ) 

Effective when outputting to PDF.

Sets a signature information name.

Since:
4.2
Parameters:
newVal the value of a signature information name.

void XfoInterface::XfoObj::setPdfSignatureNameW ( const wchar_t *  newVal  ) 

Effective when outputting to PDF.

Sets a signature information name.

Since:
4.2
Parameters:
newVal the value of a signature information name.

char* XfoInterface::XfoObj::getPdfCertificateName ( char *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the value of a certificate information name.

Since:
4.2
Returns:
the value of a certificate information name.

wchar_t* XfoInterface::XfoObj::getPdfCertificateNameW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the value of a certificate information name.

Since:
4.2
Returns:
the value of a certificate information name.

void XfoInterface::XfoObj::setPdfCertificateName ( const char *  newVal  ) 

Effective when outputting to PDF.

Sets a certificate information name.

Since:
4.2
Parameters:
newVal the value of a certificate information name.

void XfoInterface::XfoObj::setPdfCertificateNameW ( const wchar_t *  newVal  ) 

Effective when outputting to PDF.

Sets a certificate information name.

Since:
4.2
Parameters:
newVal the value of a certificate information name.

EMBEDALLFONT XfoInterface::XfoObj::getPdfEmbedAllFontsEx ( void   )  const

Effective when outputting to PDF.

Gets the value of whether to embed all embeddable fonts

Since:
3.3
EMBALLFONT_PART = 0 Specified fonts
EMBALLFONT_ALL = 1 All fonts except Base14 fonts
EMBALLFONT_BASE14 = 2 All fonts

Returns:
the value of whether to embed all embeddable fonts

void XfoInterface::XfoObj::setPdfEmbedAllFontsEx ( EMBEDALLFONT  newVal  ) 

Effective when outputting to PDF.

Specifies whether to embed the all outline data of fonts in PDF or not with one of the following values, which are True type fonts and Type1 Fonts and are embeddable in the formatted result.

Since:
3.3
EMBALLFONT_PART = 0 Specified fonts
EMBALLFONT_ALL = 1 All fonts except Base14 fonts
EMBALLFONT_BASE14 = 2 All fonts

If the value is EMBALLFONT_PART, only fonts specified in setPdfEmbedFonts are embedded. If the value is EMBALLFONT_ALL, all fonts that can be embedded except Base 14 fonts will be embedded. If the value is EMBALLFONT_BASE14, all fonts including Base 14 fonts that can be embedded will be embedded.

Parameters:
newVal the value of whether to embed all embeddable fonts

IMAGEDOWNSAMPLING XfoInterface::XfoObj::getPdfImageDownSampling ( void   )  const

Effective when outputting to PDF.

Gets the value of method to downsample the color image

Since:
3.3
Returns:
the value of method to downsample the color image

void XfoInterface::XfoObj::setPdfImageDownSampling ( IMAGEDOWNSAMPLING  newVal  ) 

Effective when outputting to PDF.

Specifies the following either of method to downsample the color image that is put into PDF.

Since:
3.3
IMGDOWNSAMPLING_NONE = 0 No downsampling
IMGDOWNSAMPLING_AVERAGE = 1 Average downsamplin
IMGDOWNSAMPLING_BICUBIC = 2 Bicubic downsampling
IMGDOWNSAMPLING_SUBSAMPLING = 3 Subsampling

When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfImageDownSamplingDPI will be downsampled into the resolution specified by setPdfImageDownSamplingTarget. This is the setting for the color image. Spesify setPdfGrayscaleImageDownSampling for the grayscale image, and setPdfMonochromeImageDownSampling for the monochrome image.

Parameters:
newVal the value of method to downsample the color image

int XfoInterface::XfoObj::getPdfImageDownSamplingTarget ( void   )  const

Effective when outputting to PDF.

Gets resolution when the color image is downsampled.

Since:
3.3
Returns:
the value of resolution.

void XfoInterface::XfoObj::setPdfImageDownSamplingTarget ( int  newVal  ) 

Effective when outputting to PDF.

Set resolution when the color image is downsampled.

Since:
3.3
Parameters:
newVal the value of resolution.

int XfoInterface::XfoObj::getPdfImageDownSamplingDPI ( void   )  const

Effective when outputting to PDF.

Gets resolution of the color image which performs a downsampling.

Since:
3.3
Returns:
the value of resolution.

void XfoInterface::XfoObj::setPdfImageDownSamplingDPI ( int  newVal  ) 

Effective when outputting to PDF.

Set resolution of the color image which performs a downsampling.

Since:
3.3
Parameters:
newVal the value of resolution.

long XfoInterface::XfoObj::getPdfPutImageColorProfile ( void   )  const

Effective when outputting to PDF.

Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF.

Since:
3.3
Returns:
If nonezero is specified, it is embedded. If zero is specified, it is not embedded.

void XfoInterface::XfoObj::setPdfPutImageColorProfile ( long  newVal  ) 

Effective when outputting to PDF.

Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF.

Since:
3.3
Parameters:
newVal If nonezero is specified, it is embedded. If zero is specified, it is not embedded.

PDFIMAGECOMPRESSION XfoInterface::XfoObj::getPdfGrayscaleImageCompression ( void   )  const

Effective when outputting to PDF.

Gets the value of how to compress the grayscale images embedded in PDF.

Since:
3.3
IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Returns:
the value of how raster graphics are compressed and stored

void XfoInterface::XfoObj::setPdfGrayscaleImageCompression ( PDFIMAGECOMPRESSION  newVal  ) 

Effective when outputting to PDF.

When the grayscale image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfGrayscaleJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected.
This is the setting for the grayscale image. Spesify setPdfImageCompression for the color image, and setPdfMonochromeImageCompression for the monochrome image.

Since:
3.3
IMGCMPR_AUTO = 0 Auto
IMGCMPR_JPEG = 1 JPEG compression
IMGCMPR_ZLIB = 2 ZLIB compression
IMGCMPR_JPEG2K = 3 JPEG2000 compression

Parameters:
newVal the value of how raster graphics are compressed and stored

int XfoInterface::XfoObj::getPdfGrayscaleJPEGQuality ( void   )  const

Effective when outputting to PDF.

Gets the value of the quality of JPEG format that is specified by xfo_setPdfGrayscaleImageCompression stored in PDF.

Since:
3.3
Returns:
the value of the quality of JPEG format

void XfoInterface::XfoObj::setPdfGrayscaleJPEGQuality ( int  newVal  ) 

Effective when outputting to PDF.

For the grayscale image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfGrayscaleImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
CAUTION: It is not for changing the quality of a JPEG format image.
This is the setting for the grayscale image. Spesify setPdfJPEGQuality for the color image.

Since:
3.3
Parameters:
newVal the value of the quality of JPEG format

IMAGEDOWNSAMPLING XfoInterface::XfoObj::getPdfGrayscaleImageDownSampling ( void   )  const

Effective when outputting to PDF.

Gets the value of method to downsample the grayscale image

Since:
3.3
Returns:
the value of method to downsample the grayscale image

void XfoInterface::XfoObj::setPdfGrayscaleImageDownSampling ( IMAGEDOWNSAMPLING  newVal  ) 

Effective when outputting to PDF.

Specifies the following either of method to downsample the grayscale image that is put into PDF.

Since:
3.3
IMGDOWNSAMPLING_NONE = 0 No downsampling
IMGDOWNSAMPLING_AVERAGE = 1 Average downsamplin
IMGDOWNSAMPLING_BICUBIC = 2 Bicubic downsampling
IMGDOWNSAMPLING_SUBSAMPLING = 3 Subsampling

When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by setPdfGrayscaleImageDownSamplingTarget. This is the setting for the grayscale image. Spesify setPdfImageDownSampling for the color image, and setPdfMonochromeImageDownSampling for the monochrome image.

Parameters:
newVal the value of method to downsample the grayscale image

int XfoInterface::XfoObj::getPdfGrayscaleImageDownSamplingTarget ( void   )  const

Effective when outputting to PDF.

Gets resolution when the grayscale image is downsampled.

Since:
3.3
Returns:
the value of resolution.

void XfoInterface::XfoObj::setPdfGrayscaleImageDownSamplingTarget ( int  newVal  ) 

Effective when outputting to PDF.

Set resolution when the grayscale image is downsampled.

Since:
3.3
Parameters:
newVal the value of resolution.

int XfoInterface::XfoObj::getPdfGrayscaleImageDownSamplingDPI ( void   )  const

Effective when outputting to PDF.

Gets resolution of the grayscale image which performs a downsampling.

Since:
3.3
Returns:
the value of resolution.

void XfoInterface::XfoObj::setPdfGrayscaleImageDownSamplingDPI ( int  newVal  ) 

Effective when outputting to PDF.

Set resolution of the grayscale image which performs a downsampling.

Since:
3.3
Parameters:
newVal the value of resolution.

MONOCHROMECOMPRESSION XfoInterface::XfoObj::getPdfMonochromeImageCompression ( void   )  const

Effective when outputting to PDF.

Gets the value of how to compress the monochrome images embedded in PDF.

Since:
3.3
MONOCMPR_CCITT4 = 0 CCITTFaxDecode group 4 filter,default value
MONOCMPR_CCITT3 = 1 CCITTFaxDecode group 3 filter
MONOCMPR_RUNLENGTH = 2 RunLengthDecode filter
MONOCMPR_ZLIB = 3 FlateDecode filter
MONOCMPR_OFF = 4 no filter

Returns:
the value of how raster graphics are compressed and stored

void XfoInterface::XfoObj::setPdfMonochromeImageCompression ( MONOCHROMECOMPRESSION  newVal  ) 

Effective when outputting to PDF.

When the monochrome image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.
This is the setting for the monochrome image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfImageCompression for the color image.

Since:
3.3
MONOCMPR_CCITT4 = 0 CCITTFaxDecode group 4 filter,default value
MONOCMPR_CCITT3 = 1 CCITTFaxDecode group 3 filter
MONOCMPR_RUNLENGTH = 2 RunLengthDecode filter
MONOCMPR_ZLIB = 3 FlateDecode filter
MONOCMPR_OFF = 4 no filter

Parameters:
newVal the value of how raster graphics are compressed and stored

IMAGEDOWNSAMPLING XfoInterface::XfoObj::getPdfMonochromeImageDownSampling ( void   )  const

Effective when outputting to PDF.

Gets the value of method to downsample the monochrome image

Since:
3.3
Returns:
the value of method to downsample the monochrome image

void XfoInterface::XfoObj::setPdfMonochromeImageDownSampling ( IMAGEDOWNSAMPLING  newVal  ) 

Effective when outputting to PDF.

Specifies the following either of method to downsample the monochrome image that is put into PDF.

Since:
3.3
IMGDOWNSAMPLING_NONE = 0 No downsampling
IMGDOWNSAMPLING_AVERAGE = 1 Average downsamplin
IMGDOWNSAMPLING_BICUBIC = 2 Bicubic downsampling
IMGDOWNSAMPLING_SUBSAMPLING = 3 Subsampling

When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by setPdfMonochromeImageDownSamplingTarget. This is the setting for the monochrome image. Spesify setPdfImageDownSampling for the color image, and setPdfGrayscaleImageDownSampling for the grayscale image.

Parameters:
newVal the value of method to downsample the monochrome image

int XfoInterface::XfoObj::getPdfMonochromeImageDownSamplingTarget ( void   )  const

Effective when outputting to PDF.

Gets resolution when the monochrome image is downsampled.

Since:
3.3
Returns:
the value of resolution.

void XfoInterface::XfoObj::setPdfMonochromeImageDownSamplingTarget ( int  newVal  ) 

Effective when outputting to PDF.

Set resolution when the monochrome image is downsampled.

Since:
3.3
Parameters:
newVal the value of resolution.

int XfoInterface::XfoObj::getPdfMonochromeImageDownSamplingDPI ( void   )  const

Effective when outputting to PDF.

Gets resolution of the monochrome image which performs a downsampling.

Since:
3.3
Returns:
the value of resolution.

void XfoInterface::XfoObj::setPdfMonochromeImageDownSamplingDPI ( int  newVal  ) 

Effective when outputting to PDF.

Set resolution of the monochrome image which performs a downsampling.

Since:
3.3
Parameters:
newVal the value of resolution.

long XfoInterface::XfoObj::getTwoPassFormatting (  )  const

Gets the specification of two pass format.

Since:
4.1
Returns:
the specification of two pass format.

void XfoInterface::XfoObj::setTwoPassFormatting ( long  newVal  ) 

Set the specification of two pass format.

Since:
4.1
Parameters:
newVal the specification of two pass format.

long XfoInterface::XfoObj::getPdfTag (  )  const

Effective when outputting to PDF.

Gets the value of whether to output Tagged PDF or not.

Since:
4.0
Returns:
the value of whether to output Tagged pdf or not.

void XfoInterface::XfoObj::setPdfTag ( long  newVal  ) 

Effective when outputting to PDF.

Generates Tagged PDF. Ignored if PDF cannot be tagged depending on the PDF versions.

Since:
4.0
Parameters:
newVal If the value is 'true' is specified, output Tagged PDF.

char* XfoInterface::XfoObj::getPdfOutputWidth ( char *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the width of PDF to output.

Since:
4.0
Parameters:
pVal Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getPdfOutputWidthW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the width of PDF to output.

Since:
4.0
Parameters:
pVal Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setPdfOutputWidth ( const char *  newVal  ) 

Effective when outputting to PDF.

Scales the width of PDF to output. A value with a unit or % value can be specified as length.

Since:
4.0
Parameters:
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

void XfoInterface::XfoObj::setPdfOutputWidthW ( const wchar_t *  newVal  ) 

Effective when outputting to PDF.

Scales the width of PDF to output. A value with a unit or % value can be specified as length.

Since:
4.0
Parameters:
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

char* XfoInterface::XfoObj::getPdfOutputHeight ( char *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the height of PDF to output.

Since:
4.0
Parameters:
pVal Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getPdfOutputHeightW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to PDF.

Gets the height of PDF to output.

Since:
4.0
Parameters:
pVal Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setPdfOutputHeight ( const char *  newVal  ) 

Effective when outputting to PDF.

Scales the height of PDF to output. A value with a unit or % value can be specified as length.

Since:
4.0
Parameters:
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

void XfoInterface::XfoObj::setPdfOutputHeightW ( const wchar_t *  newVal  ) 

Effective when outputting to PDF.

Scales the height of PDF to output. A value with a unit or % value can be specified as length.

Since:
4.0
Parameters:
newVal Pointer to a null-terminated string to be used as the width of PDF to output.

long XfoInterface::XfoObj::getPdfErrorOnPDFXFault (  ) 

Effective when outputting to PDF.

Gets the value of whether to issue error or not when PDF/X is generating.

Since:
4.0
Returns:
the value of whether to issue error.

void XfoInterface::XfoObj::setPdfErrorOnPDFXFault ( long  newVal  ) 

Effective when outputting to PDF.

An error is not issued when PDF/X is generating.

Since:
4.0
Parameters:
newVal If the value is 'true' is specified, no error is issued.

SVGVERSION XfoInterface::XfoObj::getSvgVersion (  )  const

Effective when outputting to SVG.

Get the version of SVG.

Since:
3.3
Returns:
the version of SVG.

void XfoInterface::XfoObj::setSvgVersion ( SVGVERSION  newVal  ) 

Effective when outputting to SVG.

Enables specifying whether the version of SVG is 1.1, Basic or Tiny.

Since:
3.3
Parameters:
newVal Specifies the version of SVG.

long XfoInterface::XfoObj::getSvgGzipCompression (  )  const

Effective when outputting to SVG.

Gets the setting indicating whether to compress the outputted SVG into gzip format or not.

Since:
3.3
Returns:
whether gzip compression or not.

void XfoInterface::XfoObj::setSvgGzipCompression ( long  newVal  ) 

Effective when outputting to SVG.

Specifies whether to compress the outputted SVG into gzip format or not.

Since:
3.3
Parameters:
newVal If the value is 'true' is specified, enables to compress data into gzip format.

long XfoInterface::XfoObj::getSvgEmbedAllFonts (  )  const

Effective when outputting to SVG.

Gets the setting indicating whether to embed fonts in the outputted SVG.

Since:
3.3
Returns:
whether embeds fonts or not.

void XfoInterface::XfoObj::setSvgEmbedAllFonts ( long  newVal  ) 

Effective when outputting to SVG.

Specifies whether to embed fonts in the outputted SVG.

Since:
3.3
Parameters:
newVal If the value is 'true' is specified, embeds fonts.

char* XfoInterface::XfoObj::getSvgFormat ( char *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the format for naming files when the outputted SVG becomes multiple.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getSvgFormatW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the format for naming files when the outputted SVG becomes multiple.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setSvgFormat ( const char *  newVal  ) 

Effective when outputting to SVG.

Specifies the format for naming files when the outputted SVG becomes multiple.

Since:
3.3
Parameters:
newVal Pointer to a null-terminated string to be used as the SVG file name format.

void XfoInterface::XfoObj::setSvgFormatW ( const wchar_t *  newVal  ) 

Effective when outputting to SVG.

Specifies the format for naming files when the outputted SVG becomes multiple.

Since:
3.3
Parameters:
newVal Pointer to a null-terminated string to be used as the SVG file name format.

char* XfoInterface::XfoObj::getSvgEmbedFonts ( char *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the font specified to be embedded in SVG.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getSvgEmbedFontsW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the font specified to be embedded in SVG.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setSvgEmbedFonts ( const char *  newVal  ) 

Effective when outputting to SVG.

Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.

Since:
3.3
Parameters:
newVal fonts specified to embed

void XfoInterface::XfoObj::setSvgEmbedFontsW ( const wchar_t *  newVal  ) 

Effective when outputting to SVG.

Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.

Since:
3.3
Parameters:
newVal fonts specified to embed

long XfoInterface::XfoObj::getSvgErrorOnEmbedFault (  )  const

Effective when outputting to SVG.

Gets the value of whether to issues the error when failing to embed fonts.

Since:
3.3
Returns:
the value of whether to issues the error

void XfoInterface::XfoObj::setSvgErrorOnEmbedFault ( long  newVal  ) 

Effective when outputting to SVG.

An error is issued in case of failing to embed fonts.

Since:
3.3
Parameters:
newVal If the value is 'true' is specified, an error is issued.

IMAGECONVERSION XfoInterface::XfoObj::getSvgImageConversion (  )  const

Effective when outputting to SVG.

Gets the value of how to compress the images embedded in SVG.

Since:
3.3
IMGCMPR_AUTO = 0 Auto conversion
IMGCMPR_JPEG = 1 JPEG conversion
IMGCMPR_PNG = 2 PNG conversion

Returns:
the value of how raster graphics are compressed and stored

void XfoInterface::XfoObj::setSvgImageConversion ( IMAGECONVERSION  newVal  ) 

Effective when outputting to SVG.

Selects how to compress the images embedded in SVG to create from the following.

Since:
3.3
IMGCMPR_AUTO = 0 Auto conversion
IMGCMPR_JPEG = 1 JPEG conversion
IMGCMPR_PNG = 2 PNG conversion

Parameters:
newVal the value of how raster graphics are compressed and stored

int XfoInterface::XfoObj::getSvgJPEGQuality (  )  const

Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.

Since:
3.3
Returns:
the value of the quality

void XfoInterface::XfoObj::setSvgJPEGQuality ( int  newVal  ) 

Effective when outputting to SVG.

Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger. The initial value is 80.

Since:
3.3
Parameters:
newVal JPEG quality (1 to 100)

IMAGEPROCTYPE XfoInterface::XfoObj::getSvgImageProcessingType (  )  const

Effective when outputting to SVG.

Gets specification how to treat the referred image.

Since:
3.3
IMGPT_EMBED_ALL = 0 Embeds all images to SVG.
IMGPT_COPY_ALL = 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.
IMGPT_LINK = 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.
IMGPT_COPY = 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.

Returns:
specification how to treat the referred image.

void XfoInterface::XfoObj::setSvgImageProcessingType ( IMAGEPROCTYPE  newVal  ) 

Effective when outputting to SVG.

Specifies how to treat the referred image.

Since:
3.3
IMGPT_EMBED_ALL = 0 Embeds all images to SVG.
IMGPT_COPY_ALL = 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.
IMGPT_LINK = 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.
IMGPT_COPY = 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.

Parameters:
newVal specification how to treat the referred image.

char* XfoInterface::XfoObj::getSvgImageCopyPath ( char *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setSvgImageCopyPath ( const char *  newVal  ) 

Effective when outputting to SVG.

Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.

Since:
3.3
Parameters:
newVal Pointer to a null-terminated string to be used as image copy path

wchar_t* XfoInterface::XfoObj::getSvgImageCopyPathW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setSvgImageCopyPathW ( const wchar_t *  newVal  ) 

Effective when outputting to SVG.

Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.

Since:
3.3
Parameters:
newVal Pointer to a null-terminated string to be used as image copy path

long XfoInterface::XfoObj::getSvgSingleFile (  )  const

Effective when outputting to SVG.

Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

Since:
3.3
Returns:
specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

void XfoInterface::XfoObj::setSvgSingleFile ( long  newVal  ) 

Effective when outputting to SVG.

Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
If the value is true, outputs one SVG. If the value is false, outputs multiple SVG. When multiple SVG is output, the file name is modified by specifying format.
Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc.

Since:
3.3
Parameters:
newVal specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.

long XfoInterface::XfoObj::getSvgImageRename (  )  const

Effective when outputting to SVG.

Gets specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.

Since:
3.3
Returns:
specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.

void XfoInterface::XfoObj::setSvgImageRename ( long  newVal  ) 

Effective when outputting to SVG.

When images are copied to the directory specified by setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed.

Since:
3.3
Parameters:
newVal specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original nam

char* XfoInterface::XfoObj::getSvgImagePrefix ( char *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setSvgImagePrefix ( const char *  newVal  ) 

Effective when outputting to SVG.

When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.

Since:
3.3
Parameters:
newVal the prefix of the file name.

wchar_t* XfoInterface::XfoObj::getSvgImagePrefixW ( wchar_t *  pVal,
int  size 
) const

Effective when outputting to SVG.

Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.

Since:
3.3
Parameters:
pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setSvgImagePrefixW ( const wchar_t *  newVal  ) 

Effective when outputting to SVG.

When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.

Since:
3.3
Parameters:
newVal the prefix of the file name.

long XfoInterface::XfoObj::getSvgSinglePageNumber (  )  const

Effective when outputting to SVG.

Gets specification whether to add sequential number to the output SVG even if it has only one-page.

Since:
3.3
Returns:
specification whether to add sequential number to the output SVG even if it has only one-page.

void XfoInterface::XfoObj::setSvgSinglePageNumber ( long  newVal  ) 

Effective when outputting to SVG.

When xfo_setSvgSingleFile = 0 is specified, specifies whether to add sequential number to the output SVG even if it has only one-page. It is not added in case of false.

Since:
3.3
Parameters:
newVal specification whether to add sequential number to the output SVG even if it has only one-page.

int XfoInterface::XfoObj::getSvgRasterizeResolution (  )  const

Effective when outputting to SVG.

Gets the value of the rasterised-resolution of the transformed raster images.

Since:
3.3
Returns:
Rasterised-resolution

void XfoInterface::XfoObj::setSvgRasterizeResolution ( int  newVal  ) 

Effective when outputting to SVG.

Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in SVG as vectors without being transformed to raster images. This setting is effective only with Windows version.

Since:
3.3
Parameters:
newVal Rasterised-resolution (70 to 500)

long XfoInterface::XfoObj::getStartVolume (  )  const

Get the start volume of document to output.

Since:
3.2
Returns:
start volume of document to output.

void XfoInterface::XfoObj::setStartVolume ( long  newVal  ) 

Specifies the start volume of document to output.

If the start volume is omitted or the specified value is 0 or less, the start volume is considered from the first volume. If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.

Since:
3.2
Parameters:
newVal start volume of output.

long XfoInterface::XfoObj::getEndVolume (  )  const

Get the end volume of document to output.

Since:
3.2
Returns:
end volume of output.

void XfoInterface::XfoObj::setEndVolume ( long  newVal  ) 

Specifies the end volume of document to output.

If the end volume is omitted or the specified value exceeds the actual volume, the end volume is considered as the last volume. If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.

Since:
3.2
Parameters:
newVal end volume of output.

long XfoInterface::XfoObj::getMultiVolume (  )  const

Get multiple volume of PDF output.

Since:
3.2
Returns:
If zero is returned, multiple volume don't specified. If nonezero is returned, multiple volume specified.

void XfoInterface::XfoObj::setMultiVolume ( long  newVal  ) 

Specifies multiple volume of PDF output.

Since:
3.2
Parameters:
newVal Specifies zero or nonzero.

long XfoInterface::XfoObj::getTotalVolumeCount (  )  const

Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.

Since:
3.2
Returns:
Returns total volume count.

long XfoInterface::XfoObj::getOutputVolumeCount (  )  const

Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.

Since:
3.2
Returns:
Returns output volume count.

XfoIfErrorLevel XfoInterface::XfoObj::getExitLevel (  )  const

Get the error level to abort formatting process.

Returns:
Returns the error level.

void XfoInterface::XfoObj::setExitLevel ( XfoIfErrorLevel  newVal  ) 

Error level to abort formatting process.

AH Formatter will stop formatting when the detected error level is equal to ExitLevel property or higher. The default value is 2 (Warning). Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be aborted unconditionally. BTW : An error is not displayed no matter what value may be specified to be this property.

ELVL_INFORMATION = 1 Information
ELVL_WARNING = 2 Warning
ELVL_RECOVERABLE = 3 Recoveable Error
ELVL_FATAL = 4 Fatal Error

Parameters:
newVal error level to abort formatting process.

XfoIfErrorLevel XfoInterface::XfoObj::getErrorLevel (  )  const

Returns the error level of the error that occurred during the formatting process.

ELVL_INFORMATION = 1 Information
ELVL_WARNING = 2 Warning
ELVL_RECOVERABLE = 3 Recoveable Error
ELVL_FATAL = 4 Fatal Error

Returns:
Returns the error level.

XfoIfErrorCode XfoInterface::XfoObj::getErrorCode (  )  const

Returns the error code of the error that occurred during the formatting process.

Zero means no error. Non-zero indicates any error occurred.

Returns:
Returns the error code.

char* XfoInterface::XfoObj::getErrorMessage ( char *  pVal,
int  size 
) const

Returns the error message of the error that occurred during the formatting process.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getErrorMessageW ( wchar_t *  pVal,
int  size 
) const

Returns the error message of the error that occurred during the formatting process.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setFontAlias ( const char *  src,
const char *  dst 
)

Sets the substitution of font name.

This substitution acts on the font names existing in FO. The font name 'fontName' is replaced to 'aliasName'.

Parameters:
src Specifies the font name which is replaced.
dst Specifies the aliasName.

void XfoInterface::XfoObj::setFontAliasW ( const wchar_t *  src,
const wchar_t *  dst 
)

Sets the substitution of font name.

This substitution acts on the font names existing in FO. The font name 'fontName' is replaced to 'aliasName'.

Parameters:
src Specifies the font name which is replaced.
dst Specifies the aliasName.

void XfoInterface::XfoObj::clearFontAlias (  ) 

Clear all substitutions of font name.

void XfoInterface::XfoObj::eraseFontAlias ( const char *  src  ) 

Erase the substitution of font name 'fontName'.

Parameters:
src Specifies the font name which is replaced.

void XfoInterface::XfoObj::eraseFontAliasW ( const wchar_t *  src  ) 

Erase the substitution of font name 'fontName'.

Parameters:
src Specifies the font name which is replaced.

XfoIfErrorCode XfoInterface::XfoObj::execute ( bool  bNoThrow = false  ) 

Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.

Returns:
Returns the error code. Zero means no error. Non-zero indicates any error occurred.

void XfoInterface::XfoObj::render ( std::istream &  src,
std::ostream &  out 
)

Executes the formatting of XSL-FO document specified for inputStream, and outputs it to outputStream in the output form specified for setPrinterName.

Since:
3.3
Parameters:
src Specifies XSL-FO document.
out the output destination of the formatting result.

void XfoInterface::XfoObj::clear (  ) 

Initialize formatting engine.

void XfoInterface::XfoObj::setXSLTParam ( const char *  paramName,
const char *  value 
)

Set parameter name and value for xsl:param.

Parameters:
paramName name.
value parameter value.

void XfoInterface::XfoObj::setXSLTParamW ( const wchar_t *  paramName,
const wchar_t *  value 
)

Set parameter name and value for xsl:param.

Parameters:
paramName name.
value parameter value.

void XfoInterface::XfoObj::clearXSLTParam (  ) 

Clear all parameter name and value for xsl:param.

void XfoInterface::XfoObj::setMessageListener ( MessageListener *  listener  ) 

Register the MessageListener interface to the instance of implemented class The error that occurred during the formatting process can be received as the event.

Parameters:
listener Pointer of the MessageListener instance.

void XfoInterface::XfoObj::setFormatPageListener ( FormatPageListener *  listener  ) 

Register the FormatPageListener interface to the instance of implemented class The page number that formatted during the formatting process can be received as the event.

Parameters:
listener Pointer of the FormatPageListener instance.

XfoErrorStreamType XfoInterface::XfoObj::getErrorStreamType (  )  const

Get the error output type.

Returns:
Error output type.

void XfoInterface::XfoObj::setErrorStreamType ( XfoErrorStreamType  type  ) 

Set the error output type.

Parameters:
type Error output type.
OST_NONE : No error output
OST_STDOUT : Error output to stdout
OST_STDERR : Error output to stderr

char* XfoInterface::XfoObj::getPrinterName ( char *  pVal,
int  size 
) const

Get the printer name where the formatted result is outputted.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getPrinterNameW ( wchar_t *  pVal,
int  size 
) const

Get the printer name where the formatted result is outputted.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setPrinterName ( const char *  newVal  ) 

Specifies the output format or the printer name to output.

When a printer name is specified, the formatted result is outputted to that printer. When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. When "\@PDF" is specified, the formatted result is outputted to PDF. When "\@SVG" is specified, the formatted result is outputted to SVG. When "\@PS" is specified, the formatted result is outputted to PostScript. When "\@INX" is specified, the formatted result is outputted to INX. When "\@TEXT" is specified, the formatted result is outputted to a text format file. When "\@AreaTree" is specified, the AreaTree will be outputted. When omitted, it is considered as "\@PDF" was specified. It's impossible to output to the printer with any OS's other than Windows.

Parameters:
newVal Pointer to a null-terminated string to be used as the printer name.

void XfoInterface::XfoObj::setPrinterNameW ( const wchar_t *  newVal  ) 

Specifies the output format or the printer name to output.

When a printer name is specified, the formatted result is outputted to that printer. When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. When "\@PDF" is specified, the formatted result is outputted to PDF. When "\@SVG" is specified, the formatted result is outputted to SVG. When "\@PS" is specified, the formatted result is outputted to PostScript. When "\@INX" is specified, the formatted result is outputted to INX. When "\@TEXT" is specified, the formatted result is outputted to a text format file. When "\@AreaTree" is specified, the AreaTree will be outputted. When omitted, it is considered as "\@PDF" was specified. It's impossible to output to the printer with any OS's other than Windows.

Parameters:
newVal Pointer to a null-terminated string to be used as the printer name.

long XfoInterface::XfoObj::getFormattedPages (  )  const

Get formatted total pages.

Since:
3.2
Returns:
the value of formatted total pages.

char* XfoInterface::XfoObj::getPrinterSettingURI ( char *  pVal,
int  size 
) const

Get the printer setting file URI.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getPrinterSettingURIW ( wchar_t *  pVal,
int  size 
) const

Get the printer setting file URI.

Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setPrinterSettingURI ( const char *  newVal  ) 

Specifies the printer setting file URI.

This setting is effective only with Windows version.

Parameters:
newVal Pointer to a null-terminated string to be used as the printer name.

void XfoInterface::XfoObj::setPrinterSettingURIW ( const wchar_t *  newVal  ) 

Specifies the printer setting file URI.

This setting is effective only with Windows version.

Parameters:
newVal Pointer to a null-terminated string to be used as the printer name.

long XfoInterface::XfoObj::getPrnCopies (  )  const

Get the number of copies.

Effective when outputting to printer.

Returns:
Returns the number of copies.

void XfoInterface::XfoObj::setPrnCopies ( long  newVal  ) 

Specifies the number of copies.

Effective when outputting to printer. If nothing is specified, the value is considered as 1. This setting is effective only with Windows version.

Parameters:
newVal the number of copies.

long XfoInterface::XfoObj::getPrnCollate (  )  const

Get collation of multiple copies.

Returns:
If zero is returned, the same page is multi-copied continuously. If nonezero is returned, the pages specified from start to end are printed repeatedly.

void XfoInterface::XfoObj::setPrnCollate ( long  newVal  ) 

Specifies collation of multiple copies.

Effective when outputting to printer and the number of copies is plural. If it is not specified or the value zero is specified, the same page is multi-copied continuously. If nonezero is specified, the pages specified from start to end are printed repeatedly. This setting is effective only with Windows version.

Parameters:
newVal Zpecifies zero or nonzero.

long XfoInterface::XfoObj::getBatchPrint (  )  const

Get the setting of whether print dialog box is displayed or not when printing.

Returns:
If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.

void XfoInterface::XfoObj::setBatchPrint ( long  newVal  ) 

When the value 'false' is specified, the print dialog box is displayed when printing.

If the setting is omitted or the value 'true' is specified, the print dialog is not displayed. This setting is effective only with Windows version.

Parameters:
newVal If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.

char* XfoInterface::XfoObj::getStylesheetText ( char *  pVal,
int  size 
) const

Get the text of XSL stylesheet for formatting.

Since:
3.1
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getStylesheetTextW ( wchar_t *  pVal,
int  size 
) const

Get the text of XSL stylesheet for formatting.

Since:
3.1
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

void XfoInterface::XfoObj::setStylesheetText ( const char *  newVal  ) 

Specifies the text of XSL stylesheet for formatting.

If the specified XML document is FO, or the XML file contains the processing instruction <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored. Otherwise if there is no setting of this property, an error occurs. MSXML3/MSXML4 is required when formatting. This setting is effective only with Windows version.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the text of XSL stylesheet.

void XfoInterface::XfoObj::setStylesheetTextW ( const wchar_t *  newVal  ) 

Specifies the text of XSL stylesheet for formatting.

If the specified XML document is FO, or the XML file contains the processing instruction <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored. Otherwise if there is no setting of this property, an error occurs. MSXML3/MSXML4 is required when formatting. This setting is effective only with Windows version.

Since:
3.1
Parameters:
newVal Pointer to a null-terminated string to be used as the text of XSL stylesheet.

char* XfoInterface::XfoObj::getVersion ( char *  pVal,
int  size 
) const

Get the version string of AH Formatter.

Since:
4.0MR4
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

wchar_t* XfoInterface::XfoObj::getVersionW ( wchar_t *  pVal,
int  size 
) const

Get the version string of AH Formatter.

Since:
4.0MR4
Parameters:
pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
Returns:
Returns the 'pVal'.

Member Data Documentation

XfoCppIfObject* XfoInterface::XfoObj::m_pXfoObj [private]

The documentation for this class was generated from the following file:
Generated on 19 Mar 2009 for AHFormatter C/C++ Interface by Doxygen 1.5.5