#include <dfvifc.h>
Public Member Functions | |
| DfvObj () | |
| Constructor. | |
| virtual | ~DfvObj () |
| Destructor. | |
| DfvCppIfObject * | getDfvObj () const |
| Get instance of DfvObj. | |
| 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 * | 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 Server Based Converter 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 Server Based Converter options. | |
| void | setOptionFileURI (const char *newVal) |
| Specifies the path name of XML-format Option setting file which describes Server Based Converter options. | |
| void | setOptionFileURIW (const wchar_t *newVal) |
| Specifies the path name of XML-format Option setting file which describes Server Based Converter options. | |
| void | addOptionFileURI (const char *newVal) |
| Append the path name of XML-format Option setting file which describes Server Based Converter options. | |
| void | addOptionFileURIW (const wchar_t *newVal) |
| Append the path name of XML-format Option setting file which describes Server Based Converter options. | |
| int | getOptionFileCount () const |
| Get the number of URIs of XML-format Option setting file which describes Server Based Converter options. | |
| 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 | 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 (DfvPDFVERSION newVal) |
| Effective when outputting to PDF. | |
| DfvPDFVERSION | 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 (DfvPDFENCRYPTLEVEL newVal) |
| Effective when outputting to PDF. | |
| DfvPDFENCRYPTLEVEL | 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. | |
| DfvPDFPRINTALLOW | getPdfPrintingAllowed () const |
| Effective when outputting to PDF. | |
| void | setPdfPrintingAllowed (DfvPDFPRINTALLOW newVal) |
| Effective when outputting to PDF. | |
| DfvPDFIMAGECOMPRESSION | getPdfImageCompression () const |
| Effective when outputting to PDF. | |
| void | setPdfImageCompression (DfvPDFIMAGECOMPRESSION 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. | |
| DfvPDFRGBCONVERSION | getPdfRGBConversion () const |
| Effective when outputting to PDF. | |
| void | setPdfRGBConversion (DfvPDFRGBCONVERSION 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. | |
| DfvEMBEDALLFONT | getPdfEmbedAllFontsEx (void) const |
| Effective when outputting to PDF. | |
| void | setPdfEmbedAllFontsEx (DfvEMBEDALLFONT newVal) |
| Effective when outputting to PDF. | |
| DfvIMAGEDOWNSAMPLING | getPdfImageDownSampling (void) const |
| Effective when outputting to PDF. | |
| void | setPdfImageDownSampling (DfvIMAGEDOWNSAMPLING 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. | |
| DfvPDFIMAGECOMPRESSION | getPdfGrayscaleImageCompression (void) const |
| Effective when outputting to PDF. | |
| void | setPdfGrayscaleImageCompression (DfvPDFIMAGECOMPRESSION newVal) |
| Effective when outputting to PDF. | |
| int | getPdfGrayscaleJPEGQuality (void) const |
| Effective when outputting to PDF. | |
| void | setPdfGrayscaleJPEGQuality (int newVal) |
| Effective when outputting to PDF. | |
| DfvIMAGEDOWNSAMPLING | getPdfGrayscaleImageDownSampling (void) const |
| Effective when outputting to PDF. | |
| void | setPdfGrayscaleImageDownSampling (DfvIMAGEDOWNSAMPLING 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. | |
| DfvMONOCHROMECOMPRESSION | getPdfMonochromeImageCompression (void) const |
| Effective when outputting to PDF. | |
| void | setPdfMonochromeImageCompression (DfvMONOCHROMECOMPRESSION newVal) |
| Effective when outputting to PDF. | |
| DfvIMAGEDOWNSAMPLING | getPdfMonochromeImageDownSampling (void) const |
| Effective when outputting to PDF. | |
| void | setPdfMonochromeImageDownSampling (DfvIMAGEDOWNSAMPLING 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. | |
| 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. | |
| DfvSVGVERSION | getSvgVersion () const |
| Effective when outputting to SVG. | |
| void | setSvgVersion (DfvSVGVERSION 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. | |
| DfvIMAGECONVERSION | getSvgImageConversion () const |
| Effective when outputting to SVG. | |
| void | setSvgImageConversion (DfvIMAGECONVERSION 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. | |
| DfvIMAGEPROCTYPE | getSvgImageProcessingType () const |
| Effective when outputting to SVG. | |
| void | setSvgImageProcessingType (DfvIMAGEPROCTYPE 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. | |
| DfvIfErrorLevel | getExitLevel () const |
| Get the error level to abort formatting process. | |
| void | setExitLevel (DfvIfErrorLevel newVal) |
| Error level to abort formatting process. | |
| DfvIfErrorLevel | getErrorLevel () const |
| Returns the error level of the error that occurred during the formatting process. | |
| DfvIfErrorCode | 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'. | |
| DfvIfErrorCode | execute (bool bNoThrow=false) |
| Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName. | |
| void | clear () |
| Initialize formatting engine. | |
| 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 (DfvFormatPageListener *listener) |
| Register the DfvFormatPageListener interface to the instance of implemented class The page number that formatted during the formatting process can be received as the event. | |
| 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 | 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 * | getVersion (char *pVal, int size) const |
| Get the version string of Server Based Converter. | |
| wchar_t * | getVersionW (wchar_t *pVal, int size) const |
| Get the version string of Server Based Converter. | |
| DfvINXOUTPUTMODE | getInxOutputMode () const |
| Get INX output mode. | |
| void | setInxOutputMode (DfvINXOUTPUTMODE newVal) |
| Set INX output mode. | |
| bool | getOmitBlankPages () |
| Get the specification that omit blank pages. | |
| void | setOmitBlankPages (bool newVal) |
| Disregard any empty pages. | |
| long | getFlashPartiallyOutput () const |
| Get specifies of the FlashPartiallyOutput. | |
| void | setFlashPartiallyOutput (long newVal) |
| When an error occurs within the document, the flash file in process will be outputted. | |
| long | getFlashHidePageButton () const |
| Get specifies of the FlashHidePageButton. | |
| void | setFlashHidePageButton (long newVal) |
| Output a no page button. | |
| void | setTextPaperHeight (const char *newVal) |
| Specifies the height of the paper when inputting text. | |
| void | setTextPaperHeightW (const wchar_t *newVal) |
| void | setTextPaperWidth (const char *newVal) |
| Specifies the width of the paper when inputting text. | |
| void | setTextPaperWidthW (const wchar_t *newVal) |
| void | setTextMarginLeft (const char *newVal) |
| Specifies the left margin of the paper when inputting text. | |
| void | setTextMarginLeftW (const wchar_t *newVal) |
| void | setTextMarginTop (const char *newVal) |
| Specifies the right margin of the paper when inputting text. | |
| void | setTextMarginTopW (const wchar_t *newVal) |
| void | setTextMarginRight (const char *newVal) |
| Specifies the right margin of the paper when inputting text. | |
| void | setTextMarginRightW (const wchar_t *newVal) |
| void | setTextMarginBottom (const char *newVal) |
| Specifies the right margin of the paper when inputting text. | |
| void | setTextMarginBottomW (const wchar_t *newVal) |
| void | setTextFontFamily (const char *newVal) |
| Specifies the font family name when inputting text. | |
| void | setTextFontFamilyW (const wchar_t *newVal) |
| void | setTextFontSize (const char *newVal) |
| Specifies the font size when inputting text. | |
| void | setTextFontSizeW (const wchar_t *newVal) |
| void | setTextShowPageNumber (bool newVal) |
| Specifies the value of whether show page number or not when inputting text. | |
| void | setTextShowLineNumber (bool newVal) |
| Specifies the value of whether show page number or not when inputting text. | |
| void | setTextLineNumberOffset (const char *newVal) |
| Specifies the offset value of range from body area when showing line number and inputting text. | |
| void | setTextLineNumberOffsetW (const wchar_t *newVal) |
| void | setTextLineNumberFormat (const char *newVal) |
| Specifies the line number format when showing line number and inputting text. | |
| void | setTextLineNumberFormatW (const wchar_t *newVal) |
Private Attributes | |
| DfvCppIfObject * | m_pDfvObj |
| DfvInterface::DfvObj::DfvObj | ( | ) |
Constructor.
| virtual DfvInterface::DfvObj::~DfvObj | ( | ) | [virtual] |
Destructor.
| DfvCppIfObject* DfvInterface::DfvObj::getDfvObj | ( | ) | const [inline] |
| char* DfvInterface::DfvObj::getDocumentURI | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Get the URL of XML document you will format.
| 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. |
| wchar_t* DfvInterface::DfvObj::getDocumentURIW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Get the URL of XML document you will format.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the URL of XML document. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the URL of XML document. |
| char* DfvInterface::DfvObj::getOutputFilePath | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Get the path name of the output file.
| 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. |
| wchar_t* DfvInterface::DfvObj::getOutputFilePathW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Get the path name of the output file.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the path name of the output file. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the path name of the output file. |
| char* DfvInterface::DfvObj::getOptionFileURI | ( | char * | pVal, | |
| int | size, | |||
| int | n = 0 | |||
| ) | const |
Get the path name of XML-format Option setting file which describes Server Based Converter options.
| 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. |
| wchar_t* DfvInterface::DfvObj::getOptionFileURIW | ( | wchar_t * | pVal, | |
| int | size, | |||
| int | n = 0 | |||
| ) | const |
Get the path name of XML-format Option setting file which describes Server Based Converter options.
| 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. |
| void DfvInterface::DfvObj::setOptionFileURI | ( | const char * | newVal | ) |
Specifies the path name of XML-format Option setting file which describes Server Based Converter options.
The set of former URIs is thrown away.
| newVal | Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. |
| void DfvInterface::DfvObj::setOptionFileURIW | ( | const wchar_t * | newVal | ) |
Specifies the path name of XML-format Option setting file which describes Server Based Converter options.
The set of former URIs is thrown away.
| newVal | Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. |
| void DfvInterface::DfvObj::addOptionFileURI | ( | const char * | newVal | ) |
Append the path name of XML-format Option setting file which describes Server Based Converter options.
| newVal | Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. |
| void DfvInterface::DfvObj::addOptionFileURIW | ( | const wchar_t * | newVal | ) |
Append the path name of XML-format Option setting file which describes Server Based Converter options.
| newVal | Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. |
| int DfvInterface::DfvObj::getOptionFileCount | ( | ) | const |
Get the number of URIs of XML-format Option setting file which describes Server Based Converter options.
| long DfvInterface::DfvObj::getStartPage | ( | ) | const |
Get the start page number of document to output.
| void DfvInterface::DfvObj::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.
| newVal | start page number of output. |
| long DfvInterface::DfvObj::getEndPage | ( | ) | const |
Get the end page number of document to output.
| void DfvInterface::DfvObj::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.
| newVal | end page number of output. |
| void DfvInterface::DfvObj::setPdfOwnerPassword | ( | const char * | newVal | ) |
Effective when outputting to PDF.
Specifies the owner password for PDF. The password must be within 32 bytes.
| newVal | Pointer to a null-terminated string to be used as the owner password. |
| void DfvInterface::DfvObj::setPdfOwnerPasswordW | ( | const wchar_t * | newVal | ) |
Effective when outputting to PDF.
Specifies the owner password for PDF. The password must be within 32 bytes.
| newVal | Pointer to a null-terminated string to be used as the owner password. |
| void DfvInterface::DfvObj::setPdfUserPassword | ( | const char * | newVal | ) |
Effective when outputting to PDF.
Specifies the user password for PDF. The password must be within 32 bytes.
| newVal | Pointer to a null-terminated string to be used as the user password. |
| void DfvInterface::DfvObj::setPdfUserPasswordW | ( | const wchar_t * | newVal | ) |
Effective when outputting to PDF.
Specifies the user password for PDF. The password must be within 32 bytes.
| newVal | Pointer to a null-terminated string to be used as the user password. |
| void DfvInterface::DfvObj::setPdfNoPrinting | ( | long | newVal | ) |
Effective when outputting to PDF.
Disables printing the PDF file.
| newVal | If nonezero is specified, Disables printing the PDF file. |
| long DfvInterface::DfvObj::getPdfNoPrinting | ( | ) | const |
Effective when outputting to PDF.
Get disables printing the PDF file.
| void DfvInterface::DfvObj::setPdfNoChanging | ( | long | newVal | ) |
Effective when outputting to PDF.
Disables making changes of the PDF file.
| newVal | If nonezero is specified, Disables making changes of the PDF file. |
| long DfvInterface::DfvObj::getPdfNoChanging | ( | ) | const |
Effective when outputting to PDF.
Get disables making changes of the PDF file.
| void DfvInterface::DfvObj::setPdfNoContentCopying | ( | long | newVal | ) |
Effective when outputting to PDF.
Disables copying the content of the PDF file.
| newVal | If nonezero is specified, Disables copying the content of the PDF file. |
| long DfvInterface::DfvObj::getPdfNoContentCopying | ( | ) | const |
Effective when outputting to PDF.
Get disables copying the content of the PDF file.
| void DfvInterface::DfvObj::setPdfNoAddingOrChangingCommnets | ( | long | newVal | ) |
Effective when outputting to PDF.
Disables adding comments and form fields to the PDF file.
| newVal | If nonezero is specified, Disables adding comments and form fields to the PDF file. |
| long DfvInterface::DfvObj::getPdfNoAddingOrChangingCommnets | ( | ) | const |
Effective when outputting to PDF.
Get disables adding comments and form fields to the PDF file.
| void DfvInterface::DfvObj::setPdfNoAddingOrChangingComments | ( | long | newVal | ) |
Effective when outputting to PDF.
Disables adding comments and form fields to the PDF file.
| newVal | If nonezero is specified, Disables adding comments and form fields to the PDF file. |
| long DfvInterface::DfvObj::getPdfNoAddingOrChangingComments | ( | ) | const |
Effective when outputting to PDF.
Get disables adding comments and form fields to the PDF file.
| void DfvInterface::DfvObj::setPdfVersion | ( | DfvPDFVERSION | newVal | ) |
Effective when outputting to PDF.
Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5.
| newVal | Specifies the version of PDF. |
| DfvPDFVERSION DfvInterface::DfvObj::getPdfVersion | ( | ) | const |
Effective when outputting to PDF.
Get the version of PDF.
| void DfvInterface::DfvObj::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.
| newVal | If nonezero is specified, Disables filling in of form fields and signing of the PDF file. |
| long DfvInterface::DfvObj::getPdfNoFillForm | ( | ) | const |
Effective when outputting to PDF.
Get disables filling in of form fields and signing of the PDF file.
| void DfvInterface::DfvObj::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.
| newVal | If nonezero is specified, Disables text access for screen reader devices of the PDF file. |
| long DfvInterface::DfvObj::getPdfNoAccessibility | ( | ) | const |
Effective when outputting to PDF.
Get disables text access for screen reader devices of the PDF file.
| void DfvInterface::DfvObj::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
| newVal | If nonezero is specified, Disables inserting, deleting and rotating the PDF pages. |
| long DfvInterface::DfvObj::getPdfNoAssembleDoc | ( | ) | const |
Effective when outputting to PDF.
Get disables inserting, deleting and rotating the PDF pages.
| void DfvInterface::DfvObj::setPdfEncryptLevel | ( | DfvPDFENCRYPTLEVEL | 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
| newVal | Specifies the key length. |
| DfvPDFENCRYPTLEVEL DfvInterface::DfvObj::getPdfEncryptLevel | ( | ) | const |
Effective when outputting to PDF.
Get the key length when encrypting the PDF file during outputting.
| long DfvInterface::DfvObj::getPdfEmbedAllFonts | ( | ) | const |
Effective when outputting to PDF.
Gets the value of whether to embed all embeddable fonts in PDF.
| void DfvInterface::DfvObj::setPdfEmbedAllFonts | ( | long | newVal | ) |
Effective when outputting to PDF.
Embeds all embeddable fonts in PDF to create.
| newVal | If the value is 'true' is specified, Embeds all embeddable fonts |
| char* DfvInterface::DfvObj::getPdfEmbedFonts | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the font specified to be embedded in PDF.
| 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. |
| wchar_t* DfvInterface::DfvObj::getPdfEmbedFontsW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the font specified to be embedded in PDF.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | fonts specified to embed |
| void DfvInterface::DfvObj::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.
| newVal | fonts specified to embed |
| long DfvInterface::DfvObj::getPdfErrorOnEmbedFault | ( | ) | const |
Effective when outputting to PDF.
Gets the value of whether to issues the error when failing to embed fonts.
| void DfvInterface::DfvObj::setPdfErrorOnEmbedFault | ( | long | newVal | ) |
Effective when outputting to PDF.
An error is issued in case of failing to embed fonts.
| newVal | If the value is 'true' is specified, an error is issued. |
| long DfvInterface::DfvObj::getPdfErrorOnMissingGlyph | ( | ) | const |
Effective when outputting to PDF.
Gets the value of whether to issues the error when missing glyph.
| void DfvInterface::DfvObj::setPdfErrorOnMissingGlyph | ( | long | newVal | ) |
Effective when outputting to PDF.
An error is issued in case of missing glyph.
| newVal | If the value is 'true' is specified, an error is issued. |
| DfvPDFPRINTALLOW DfvInterface::DfvObj::getPdfPrintingAllowed | ( | ) | const |
Effective when outputting to PDF.
Gets the value of whether to print the resulting PDF file or not.
| PRALLOW_NONE | = 0 Not Allowed |
| PRALLOW_LOW | = 1 Low Resolution Printing |
| PRALLOW_HIGH | = 2 High Resolution Printing |
| void DfvInterface::DfvObj::setPdfPrintingAllowed | ( | DfvPDFPRINTALLOW | 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).
| PRALLOW_NONE | = 0 Not Allowed |
| PRALLOW_LOW | = 1 Low Resolution Printing |
| PRALLOW_HIGH | = 2 High Resolution Printing |
| newVal | the value of printing allowed |
| DfvPDFIMAGECOMPRESSION DfvInterface::DfvObj::getPdfImageCompression | ( | ) | const |
Effective when outputting to PDF.
Gets the value of how to compress the color images embedded in PDF.
| IMGCMPR_AUTO | = 0 Auto |
| IMGCMPR_JPEG | = 1 JPEG compression |
| IMGCMPR_ZLIB | = 2 ZLIB compression |
| IMGCMPR_JPEG2K | = 3 JPEG2000 compression |
| void DfvInterface::DfvObj::setPdfImageCompression | ( | DfvPDFIMAGECOMPRESSION | 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.
| IMGCMPR_AUTO | = 0 Auto |
| IMGCMPR_JPEG | = 1 JPEG compression |
| IMGCMPR_ZLIB | = 2 ZLIB compression |
| IMGCMPR_JPEG2K | = 3 JPEG2000 compression |
| newVal | the value of how raster graphics are compressed and stored |
| int DfvInterface::DfvObj::getPdfJPEGQuality | ( | ) | const |
Gets the value of the quality of JPEG format that is specified by xfo_setPdfImageCompression() stored in PDF.
| void DfvInterface::DfvObj::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.
| newVal | the value of the quality of JPEG format |
| long DfvInterface::DfvObj::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.
| void DfvInterface::DfvObj::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.
| newVal | If the value is 'true' is specified, make the PDF compress |
| long DfvInterface::DfvObj::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.
| void DfvInterface::DfvObj::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.
| newVal | If nonezero is specified, it is transformed to 'Open the file'. If zero is specified, it is transformed to 'World Wide Web link' |
| DfvPDFRGBCONVERSION DfvInterface::DfvObj::getPdfRGBConversion | ( | ) | const |
Effective when outputting to PDF.
Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.
| RGBCONV_NONE | = 0 No Conversion |
| RGBCONV_BLACK | = 1 Black to DeviceGray |
| RGBCONV_GRAY | = 2 Gray to DeviceGray |
| RGBCONV_ALL | = 3 All RGB to DeviceGray |
| void DfvInterface::DfvObj::setPdfRGBConversion | ( | DfvPDFRGBCONVERSION | newVal | ) |
Effective when outputting to PDF.
Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.
| RGBCONV_NONE | = 0 No Conversion |
| RGBCONV_BLACK | = 1 Black to DeviceGray |
| RGBCONV_GRAY | = 2 Gray to DeviceGray |
| RGBCONV_ALL | = 3 All RGB to DeviceGray |
| newVal | the value of how to convert |
| int DfvInterface::DfvObj::getPdfRasterizeResolution | ( | ) | const |
Effective when outputting to PDF.
Gets the value of the rasterised-resolution of the transformed raster images.
| void DfvInterface::DfvObj::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.
| newVal | Rasterised-resolution (70 to 500) |
| long DfvInterface::DfvObj::getPdfLinearize | ( | ) | const |
Effective when outputting to PDF.
Gets the value of whether to output linearize PDF or not.
| void DfvInterface::DfvObj::setPdfLinearize | ( | long | newVal | ) |
Effective when outputting to PDF.
Specifies whether to output linearize PDF or not.
| newVal | If the value is 'true' is specified, output linearlize PDF. |
| long DfvInterface::DfvObj::getPdfSignature | ( | ) | const |
Effective when outputting to PDF.
Gets the value of whether to sign a signature to PDF or not.
| void DfvInterface::DfvObj::setPdfSignature | ( | long | newVal | ) |
Effective when outputting to PDF.
Specifies whether to sign a signature to PDF or not.
| newVal | If the value is 'true' is specified, sign a signature to PDF. |
| char* DfvInterface::DfvObj::getPdfSignatureName | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the value of a signature information name.
| wchar_t* DfvInterface::DfvObj::getPdfSignatureNameW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the value of a signature information name.
| void DfvInterface::DfvObj::setPdfSignatureName | ( | const char * | newVal | ) |
Effective when outputting to PDF.
Sets a signature information name.
| newVal | the value of a signature information name. |
| void DfvInterface::DfvObj::setPdfSignatureNameW | ( | const wchar_t * | newVal | ) |
Effective when outputting to PDF.
Sets a signature information name.
| newVal | the value of a signature information name. |
| char* DfvInterface::DfvObj::getPdfCertificateName | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the value of a certificate information name.
| wchar_t* DfvInterface::DfvObj::getPdfCertificateNameW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the value of a certificate information name.
| void DfvInterface::DfvObj::setPdfCertificateName | ( | const char * | newVal | ) |
Effective when outputting to PDF.
Sets a certificate information name.
| newVal | the value of a certificate information name. |
| void DfvInterface::DfvObj::setPdfCertificateNameW | ( | const wchar_t * | newVal | ) |
Effective when outputting to PDF.
Sets a certificate information name.
| newVal | the value of a certificate information name. |
| DfvEMBEDALLFONT DfvInterface::DfvObj::getPdfEmbedAllFontsEx | ( | void | ) | const |
Effective when outputting to PDF.
Gets the value of whether to embed all embeddable fonts
| EMBALLFONT_PART | = 0 Specified fonts |
| EMBALLFONT_ALL | = 1 All fonts except Base14 fonts |
| EMBALLFONT_BASE14 | = 2 All fonts |
| void DfvInterface::DfvObj::setPdfEmbedAllFontsEx | ( | DfvEMBEDALLFONT | 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.
| 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.
| newVal | the value of whether to embed all embeddable fonts |
| DfvIMAGEDOWNSAMPLING DfvInterface::DfvObj::getPdfImageDownSampling | ( | void | ) | const |
Effective when outputting to PDF.
Gets the value of method to downsample the color image
| void DfvInterface::DfvObj::setPdfImageDownSampling | ( | DfvIMAGEDOWNSAMPLING | newVal | ) |
Effective when outputting to PDF.
Specifies the following either of method to downsample the color image that is put into PDF.
| 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.
| newVal | the value of method to downsample the color image |
| int DfvInterface::DfvObj::getPdfImageDownSamplingTarget | ( | void | ) | const |
Effective when outputting to PDF.
Gets resolution when the color image is downsampled.
| void DfvInterface::DfvObj::setPdfImageDownSamplingTarget | ( | int | newVal | ) |
Effective when outputting to PDF.
Set resolution when the color image is downsampled.
| newVal | the value of resolution. |
| int DfvInterface::DfvObj::getPdfImageDownSamplingDPI | ( | void | ) | const |
Effective when outputting to PDF.
Gets resolution of the color image which performs a downsampling.
| void DfvInterface::DfvObj::setPdfImageDownSamplingDPI | ( | int | newVal | ) |
Effective when outputting to PDF.
Set resolution of the color image which performs a downsampling.
| newVal | the value of resolution. |
| long DfvInterface::DfvObj::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.
| void DfvInterface::DfvObj::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.
| newVal | If nonezero is specified, it is embedded. If zero is specified, it is not embedded. |
| DfvPDFIMAGECOMPRESSION DfvInterface::DfvObj::getPdfGrayscaleImageCompression | ( | void | ) | const |
Effective when outputting to PDF.
Gets the value of how to compress the grayscale images embedded in PDF.
| IMGCMPR_AUTO | = 0 Auto |
| IMGCMPR_JPEG | = 1 JPEG compression |
| IMGCMPR_ZLIB | = 2 ZLIB compression |
| IMGCMPR_JPEG2K | = 3 JPEG2000 compression |
| void DfvInterface::DfvObj::setPdfGrayscaleImageCompression | ( | DfvPDFIMAGECOMPRESSION | 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.
| IMGCMPR_AUTO | = 0 Auto |
| IMGCMPR_JPEG | = 1 JPEG compression |
| IMGCMPR_ZLIB | = 2 ZLIB compression |
| IMGCMPR_JPEG2K | = 3 JPEG2000 compression |
| newVal | the value of how raster graphics are compressed and stored |
| int DfvInterface::DfvObj::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.
| void DfvInterface::DfvObj::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.
| newVal | the value of the quality of JPEG format |
| DfvIMAGEDOWNSAMPLING DfvInterface::DfvObj::getPdfGrayscaleImageDownSampling | ( | void | ) | const |
Effective when outputting to PDF.
Gets the value of method to downsample the grayscale image
| void DfvInterface::DfvObj::setPdfGrayscaleImageDownSampling | ( | DfvIMAGEDOWNSAMPLING | newVal | ) |
Effective when outputting to PDF.
Specifies the following either of method to downsample the grayscale image that is put into PDF.
| 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.
| newVal | the value of method to downsample the grayscale image |
| int DfvInterface::DfvObj::getPdfGrayscaleImageDownSamplingTarget | ( | void | ) | const |
Effective when outputting to PDF.
Gets resolution when the grayscale image is downsampled.
| void DfvInterface::DfvObj::setPdfGrayscaleImageDownSamplingTarget | ( | int | newVal | ) |
Effective when outputting to PDF.
Set resolution when the grayscale image is downsampled.
| newVal | the value of resolution. |
| int DfvInterface::DfvObj::getPdfGrayscaleImageDownSamplingDPI | ( | void | ) | const |
Effective when outputting to PDF.
Gets resolution of the grayscale image which performs a downsampling.
| void DfvInterface::DfvObj::setPdfGrayscaleImageDownSamplingDPI | ( | int | newVal | ) |
Effective when outputting to PDF.
Set resolution of the grayscale image which performs a downsampling.
| newVal | the value of resolution. |
| DfvMONOCHROMECOMPRESSION DfvInterface::DfvObj::getPdfMonochromeImageCompression | ( | void | ) | const |
Effective when outputting to PDF.
Gets the value of how to compress the monochrome images embedded in PDF.
| 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 |
| void DfvInterface::DfvObj::setPdfMonochromeImageCompression | ( | DfvMONOCHROMECOMPRESSION | 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.
| 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 |
| newVal | the value of how raster graphics are compressed and stored |
| DfvIMAGEDOWNSAMPLING DfvInterface::DfvObj::getPdfMonochromeImageDownSampling | ( | void | ) | const |
Effective when outputting to PDF.
Gets the value of method to downsample the monochrome image
| void DfvInterface::DfvObj::setPdfMonochromeImageDownSampling | ( | DfvIMAGEDOWNSAMPLING | newVal | ) |
Effective when outputting to PDF.
Specifies the following either of method to downsample the monochrome image that is put into PDF.
| 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.
| newVal | the value of method to downsample the monochrome image |
| int DfvInterface::DfvObj::getPdfMonochromeImageDownSamplingTarget | ( | void | ) | const |
Effective when outputting to PDF.
Gets resolution when the monochrome image is downsampled.
| void DfvInterface::DfvObj::setPdfMonochromeImageDownSamplingTarget | ( | int | newVal | ) |
Effective when outputting to PDF.
Set resolution when the monochrome image is downsampled.
| newVal | the value of resolution. |
| int DfvInterface::DfvObj::getPdfMonochromeImageDownSamplingDPI | ( | void | ) | const |
Effective when outputting to PDF.
Gets resolution of the monochrome image which performs a downsampling.
| void DfvInterface::DfvObj::setPdfMonochromeImageDownSamplingDPI | ( | int | newVal | ) |
Effective when outputting to PDF.
Set resolution of the monochrome image which performs a downsampling.
| newVal | the value of resolution. |
| char* DfvInterface::DfvObj::getPdfOutputWidth | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the width of PDF to output.
| 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. |
| wchar_t* DfvInterface::DfvObj::getPdfOutputWidthW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the width of PDF to output.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the width of PDF to output. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the width of PDF to output. |
| char* DfvInterface::DfvObj::getPdfOutputHeight | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the height of PDF to output.
| 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. |
| wchar_t* DfvInterface::DfvObj::getPdfOutputHeightW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to PDF.
Gets the height of PDF to output.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the width of PDF to output. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as the width of PDF to output. |
| long DfvInterface::DfvObj::getPdfErrorOnPDFXFault | ( | ) |
Effective when outputting to PDF.
Gets the value of whether to issue error or not when PDF/X is generating.
| void DfvInterface::DfvObj::setPdfErrorOnPDFXFault | ( | long | newVal | ) |
Effective when outputting to PDF.
An error is not issued when PDF/X is generating.
| newVal | If the value is 'true' is specified, no error is issued. |
| DfvSVGVERSION DfvInterface::DfvObj::getSvgVersion | ( | ) | const |
Effective when outputting to SVG.
Get the version of SVG.
| void DfvInterface::DfvObj::setSvgVersion | ( | DfvSVGVERSION | newVal | ) |
Effective when outputting to SVG.
Enables specifying whether the version of SVG is 1.1, Basic or Tiny.
| newVal | Specifies the version of SVG. |
| long DfvInterface::DfvObj::getSvgGzipCompression | ( | ) | const |
Effective when outputting to SVG.
Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
| void DfvInterface::DfvObj::setSvgGzipCompression | ( | long | newVal | ) |
Effective when outputting to SVG.
Specifies whether to compress the outputted SVG into gzip format or not.
| newVal | If the value is 'true' is specified, enables to compress data into gzip format. |
| long DfvInterface::DfvObj::getSvgEmbedAllFonts | ( | ) | const |
Effective when outputting to SVG.
Gets the setting indicating whether to embed fonts in the outputted SVG.
| void DfvInterface::DfvObj::setSvgEmbedAllFonts | ( | long | newVal | ) |
Effective when outputting to SVG.
Specifies whether to embed fonts in the outputted SVG.
| newVal | If the value is 'true' is specified, embeds fonts. |
| char* DfvInterface::DfvObj::getSvgFormat | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to SVG.
Gets the format for naming files when the outputted SVG becomes multiple.
| 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. |
| wchar_t* DfvInterface::DfvObj::getSvgFormatW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to SVG.
Gets the format for naming files when the outputted SVG becomes multiple.
| 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. |
| void DfvInterface::DfvObj::setSvgFormat | ( | const char * | newVal | ) |
Effective when outputting to SVG.
Specifies the format for naming files when the outputted SVG becomes multiple.
| newVal | Pointer to a null-terminated string to be used as the SVG file name format. |
| void DfvInterface::DfvObj::setSvgFormatW | ( | const wchar_t * | newVal | ) |
Effective when outputting to SVG.
Specifies the format for naming files when the outputted SVG becomes multiple.
| newVal | Pointer to a null-terminated string to be used as the SVG file name format. |
| char* DfvInterface::DfvObj::getSvgEmbedFonts | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to SVG.
Gets the font specified to be embedded in SVG.
| 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. |
| wchar_t* DfvInterface::DfvObj::getSvgEmbedFontsW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Effective when outputting to SVG.
Gets the font specified to be embedded in SVG.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | fonts specified to embed |
| void DfvInterface::DfvObj::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.
| newVal | fonts specified to embed |
| long DfvInterface::DfvObj::getSvgErrorOnEmbedFault | ( | ) | const |
Effective when outputting to SVG.
Gets the value of whether to issues the error when failing to embed fonts.
| void DfvInterface::DfvObj::setSvgErrorOnEmbedFault | ( | long | newVal | ) |
Effective when outputting to SVG.
An error is issued in case of failing to embed fonts.
| newVal | If the value is 'true' is specified, an error is issued. |
| DfvIMAGECONVERSION DfvInterface::DfvObj::getSvgImageConversion | ( | ) | const |
Effective when outputting to SVG.
Gets the value of how to compress the images embedded in SVG.
| IMGCMPR_AUTO | = 0 Auto conversion |
| IMGCMPR_JPEG | = 1 JPEG conversion |
| IMGCMPR_PNG | = 2 PNG conversion |
| void DfvInterface::DfvObj::setSvgImageConversion | ( | DfvIMAGECONVERSION | newVal | ) |
Effective when outputting to SVG.
Selects how to compress the images embedded in SVG to create from the following.
| IMGCMPR_AUTO | = 0 Auto conversion |
| IMGCMPR_JPEG | = 1 JPEG conversion |
| IMGCMPR_PNG | = 2 PNG conversion |
| newVal | the value of how raster graphics are compressed and stored |
| int DfvInterface::DfvObj::getSvgJPEGQuality | ( | ) | const |
Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.
| void DfvInterface::DfvObj::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.
| newVal | JPEG quality (1 to 100) |
| DfvIMAGEPROCTYPE DfvInterface::DfvObj::getSvgImageProcessingType | ( | ) | const |
Effective when outputting to SVG.
Gets specification how to treat the referred image.
| 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. |
| void DfvInterface::DfvObj::setSvgImageProcessingType | ( | DfvIMAGEPROCTYPE | newVal | ) |
Effective when outputting to SVG.
Specifies how to treat the referred image.
| 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. |
| newVal | specification how to treat the referred image. |
| char* DfvInterface::DfvObj::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.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as image copy path |
| wchar_t* DfvInterface::DfvObj::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.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | Pointer to a null-terminated string to be used as image copy path |
| long DfvInterface::DfvObj::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.
| void DfvInterface::DfvObj::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.
| newVal | specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. |
| long DfvInterface::DfvObj::getSvgImageRename | ( | ) | const |
Effective when outputting to SVG.
Gets specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
| void DfvInterface::DfvObj::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.
| newVal | specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original nam |
| char* DfvInterface::DfvObj::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.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | the prefix of the file name. |
| wchar_t* DfvInterface::DfvObj::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.
| 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. |
| void DfvInterface::DfvObj::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.
| newVal | the prefix of the file name. |
| long DfvInterface::DfvObj::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.
| void DfvInterface::DfvObj::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.
| newVal | specification whether to add sequential number to the output SVG even if it has only one-page. |
| int DfvInterface::DfvObj::getSvgRasterizeResolution | ( | ) | const |
Effective when outputting to SVG.
Gets the value of the rasterised-resolution of the transformed raster images.
| void DfvInterface::DfvObj::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.
| newVal | Rasterised-resolution (70 to 500) |
| DfvIfErrorLevel DfvInterface::DfvObj::getExitLevel | ( | ) | const |
Get the error level to abort formatting process.
| void DfvInterface::DfvObj::setExitLevel | ( | DfvIfErrorLevel | newVal | ) |
Error level to abort formatting process.
Server Based Converter 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 |
| newVal | error level to abort formatting process. |
| DfvIfErrorLevel DfvInterface::DfvObj::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 |
| DfvIfErrorCode DfvInterface::DfvObj::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.
| char* DfvInterface::DfvObj::getErrorMessage | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Returns the error message of the error that occurred during the formatting process.
| 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. |
| wchar_t* DfvInterface::DfvObj::getErrorMessageW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Returns the error message of the error that occurred during the formatting process.
| 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. |
| void DfvInterface::DfvObj::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'.
| src | Specifies the font name which is replaced. | |
| dst | Specifies the aliasName. |
| void DfvInterface::DfvObj::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'.
| src | Specifies the font name which is replaced. | |
| dst | Specifies the aliasName. |
| void DfvInterface::DfvObj::clearFontAlias | ( | ) |
Clear all substitutions of font name.
| void DfvInterface::DfvObj::eraseFontAlias | ( | const char * | src | ) |
Erase the substitution of font name 'fontName'.
| src | Specifies the font name which is replaced. |
| void DfvInterface::DfvObj::eraseFontAliasW | ( | const wchar_t * | src | ) |
Erase the substitution of font name 'fontName'.
| src | Specifies the font name which is replaced. |
| DfvIfErrorCode DfvInterface::DfvObj::execute | ( | bool | bNoThrow = false |
) |
Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
| void DfvInterface::DfvObj::clear | ( | ) |
Initialize formatting engine.
| void DfvInterface::DfvObj::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.
| listener | Pointer of the MessageListener instance. |
| void DfvInterface::DfvObj::setFormatPageListener | ( | DfvFormatPageListener * | listener | ) |
Register the DfvFormatPageListener interface to the instance of implemented class The page number that formatted during the formatting process can be received as the event.
| listener | Pointer of the DfvFormatPageListener instance. |
| char* DfvInterface::DfvObj::getPrinterName | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Get the printer name where the formatted result is outputted.
| 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. |
| wchar_t* DfvInterface::DfvObj::getPrinterNameW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Get the printer name where the formatted result is outputted.
| 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. |
| void DfvInterface::DfvObj::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 "\@MIF" is specified, the formatted result is outputted to MIF. 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.
| newVal | Pointer to a null-terminated string to be used as the printer name. |
| void DfvInterface::DfvObj::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 "\@MIF" is specified, the formatted result is outputted to MIF. 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.
| newVal | Pointer to a null-terminated string to be used as the printer name. |
| long DfvInterface::DfvObj::getPrnCopies | ( | ) | const |
Get the number of copies.
Effective when outputting to printer.
| void DfvInterface::DfvObj::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.
| newVal | the number of copies. |
| long DfvInterface::DfvObj::getPrnCollate | ( | ) | const |
Get collation of multiple copies.
| void DfvInterface::DfvObj::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.
| newVal | Zpecifies zero or nonzero. |
| long DfvInterface::DfvObj::getBatchPrint | ( | ) | const |
Get the setting of whether print dialog box is displayed or not when printing.
| void DfvInterface::DfvObj::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.
| newVal | If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed. |
| char* DfvInterface::DfvObj::getVersion | ( | char * | pVal, | |
| int | size | |||
| ) | const |
Get the version string of Server Based Converter.
| 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. |
| wchar_t* DfvInterface::DfvObj::getVersionW | ( | wchar_t * | pVal, | |
| int | size | |||
| ) | const |
Get the version string of Server Based Converter.
| 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. |
| DfvINXOUTPUTMODE DfvInterface::DfvObj::getInxOutputMode | ( | ) | const |
Get INX output mode.
| void DfvInterface::DfvObj::setInxOutputMode | ( | DfvINXOUTPUTMODE | newVal | ) |
Set INX output mode.
| output | mode of INX. |
| bool DfvInterface::DfvObj::getOmitBlankPages | ( | ) |
Get the specification that omit blank pages.
return Specification that omit blank pages
| void DfvInterface::DfvObj::setOmitBlankPages | ( | bool | newVal | ) |
Disregard any empty pages.
Effective only when the original file is MS Word or MS Excel. Specifies to disregard any empty pages at the beginning of document. By using this parameter with setEndPage = 1 parameter, it is possible to acquire the output of the first page which has actual contents. Other operation is not guaranteed.
| newVal | If the value is 'true' is specified, omit blank pages |
| long DfvInterface::DfvObj::getFlashPartiallyOutput | ( | ) | const |
Get specifies of the FlashPartiallyOutput.
| void DfvInterface::DfvObj::setFlashPartiallyOutput | ( | long | newVal | ) |
When an error occurs within the document, the flash file in process will be outputted.
Effective when outputting to Flash.
| newVal | Specifies zero or nonzero. |
| long DfvInterface::DfvObj::getFlashHidePageButton | ( | ) | const |
Get specifies of the FlashHidePageButton.
| void DfvInterface::DfvObj::setFlashHidePageButton | ( | long | newVal | ) |
Output a no page button.
Effective when outputting to Flash.
| newVal | If the value is 'true' is specified, output a no page button. |
| void DfvInterface::DfvObj::setTextPaperHeight | ( | const char * | newVal | ) |
Specifies the height of the paper when inputting text.
Effective when inputting text.
| newVal | the height of paper |
| void DfvInterface::DfvObj::setTextPaperHeightW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextPaperWidth | ( | const char * | newVal | ) |
Specifies the width of the paper when inputting text.
Effective when inputting text.
| newVal | the width of paper |
| void DfvInterface::DfvObj::setTextPaperWidthW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextMarginLeft | ( | const char * | newVal | ) |
Specifies the left margin of the paper when inputting text.
Effective when inputting text.
| newVal | the left margin of the paper |
| void DfvInterface::DfvObj::setTextMarginLeftW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextMarginTop | ( | const char * | newVal | ) |
Specifies the right margin of the paper when inputting text.
Effective when inputting text.
| newVal | the top margin of the paper |
| void DfvInterface::DfvObj::setTextMarginTopW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextMarginRight | ( | const char * | newVal | ) |
Specifies the right margin of the paper when inputting text.
Effective when inputting text.
| newVal | the right margin of the paper |
| void DfvInterface::DfvObj::setTextMarginRightW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextMarginBottom | ( | const char * | newVal | ) |
Specifies the right margin of the paper when inputting text.
Effective when inputting text.
| newVal | the bottom margin of the paper |
| void DfvInterface::DfvObj::setTextMarginBottomW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextFontFamily | ( | const char * | newVal | ) |
Specifies the font family name when inputting text.
Effective when inputting text.
| newVal | font family name |
| void DfvInterface::DfvObj::setTextFontFamilyW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextFontSize | ( | const char * | newVal | ) |
Specifies the font size when inputting text.
Effective when inputting text.
| newVal | font size |
| void DfvInterface::DfvObj::setTextFontSizeW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextShowPageNumber | ( | bool | newVal | ) |
Specifies the value of whether show page number or not when inputting text.
Effective when inputting text.
| newVal | the value of whether show page number or not |
| void DfvInterface::DfvObj::setTextShowLineNumber | ( | bool | newVal | ) |
Specifies the value of whether show page number or not when inputting text.
Effective when inputting text.
| newVal | the value of whether show page number or not |
| void DfvInterface::DfvObj::setTextLineNumberOffset | ( | const char * | newVal | ) |
Specifies the offset value of range from body area when showing line number and inputting text.
Effective when inputting text.
| newVal | the offset value |
| void DfvInterface::DfvObj::setTextLineNumberOffsetW | ( | const wchar_t * | newVal | ) |
| void DfvInterface::DfvObj::setTextLineNumberFormat | ( | const char * | newVal | ) |
Specifies the line number format when showing line number and inputting text.
Effective when inputting text.
| newVal | line number format |
| void DfvInterface::DfvObj::setTextLineNumberFormatW | ( | const wchar_t * | newVal | ) |
DfvCppIfObject* DfvInterface::DfvObj::m_pDfvObj [private] |