Main Page   Namespace List   Compound List   File List   Compound Members   File Members   Related Pages  

DfvInterface::DfvObj Class Reference

#include <dfvifc.h>

List of all members.

Public Methods

 DfvObj ()
 Constructor.

virtual ~DfvObj ()
 Destructor.

DfvCppIfObject * getDfvObj () const
 Get instance of DfvObj.

char * getDocumentURI (char *pVal, int size) const
 Get the URL of document you will format.

wchar_t * getDocumentURIW (wchar_t *pVal, int size) const
 Get the URL of document you will format.

void setDocumentURI (const char *newVal)
 Specifies the URL of document you will format.

void setDocumentURIW (const wchar_t *newVal)
 Specifies the URL of 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 format Option setting file which describes Office Server Document Converter options.

wchar_t * getOptionFileURIW (wchar_t *pVal, int size, int n=0) const
 Get the path name of format Option setting file which describes Office Server Document Converter options.

void setOptionFileURI (const char *newVal)
 Specifies the path name of format Option setting file which describes Office Server Document Converter options.

void setOptionFileURIW (const wchar_t *newVal)
 Specifies the path name of format Option setting file which describes Office Server Document Converter options.

void addOptionFileURI (const char *newVal)
 Append the path name of format Option setting file which describes Office Server Document Converter options.

void addOptionFileURIW (const wchar_t *newVal)
 Append the path name of format Option setting file which describes Office Server Document Converter options.

int getOptionFileCount () const
 Get the number of URIs of format Option setting file which describes Office Server Document 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 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.

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.

void setPdfOutputScale (const char *newVal)
 Specifies the scaling ratio of the PDF to output.

void setPdfOutputScaleW (const wchar_t *newVal)
 Specifies the scaling ratio of the PDF to output.

long getPdfErrorOnPDFXFault ()
 Effective when outputting to PDF.

void setPdfErrorOnPDFXFault (long newVal)
 Effective when outputting to PDF.

bool getPdfAnnotation () const
 Effective when inputting from PDF.

void setPdfAnnotation (bool newVal)
 Effective when inputting from PDF.

char * getPdfFormat (char *pVal, int size) const
 Effective when outputting to PDF.

wchar_t * getPdfFormatW (wchar_t *pVal, int size) const
 Effective when outputting to PDF.

void setPdfFormat (const char *newVal)
 Effective when outputting to PDF.

void setPdfFormatW (const wchar_t *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.

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.

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 render (std::istream &src, std::ostream &out)
 Executes the formatting of document specified for inputStream, and outputs it to outputStream in the output form specified for setPrinterName.

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 This setting is effective only with Windows version.

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 Office Server Document Converter.

wchar_t * getVersionW (wchar_t *pVal, int size) const
 Get the version string of Office Server Document 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.

bool getFlashSplitPage () const
 Get the setting of the FlashSplitPage.

void setFlashSplitPage (bool newVal)
 Outputs Flash file per page and saves as every single file..
Effective when outputting to Flash.


bool getFlashOutputAction () const
 Get the setting of FlashOutputAction.

void setFlashOutputAction (bool newVal)
 Do not output features of ActionScript1.0, such as stop action per page, the page navigation button, linking, etc..
Effective when outputting to Flash.


int getFlashImageLimitSize () const
 Get the setting of FlashImageLimitSize.

void setFlashImageLimitSize (int newVal)
 Specifies the number of maximum pixels of images outputted to the Flash file by the integral value.

void setPrnFitPaper (bool newVal)
 It print at size of paper.

int getRasterDPI (void) const
 Get the image resolution when outputting JPEG and PNG.

void setRasterDPI (int newVal)
 Sets the image resolution when outputting JPEG and PNG.

char * getRasterScale (char *pVal, int size) const
 Get the image scale when outputting JPEG and PNG.

wchar_t * getRasterScaleW (wchar_t *pVal, int size) const
 Get the image scale when outputting JPEG and PNG.

void setRasterScale (const char *newVal)
 Sets the image scale when outputting JPEG and PNG.

void setRasterScaleW (const wchar_t *newVal)
 Sets the image scale when outputting JPEG and PNG.

int getRasterHeight () const
 Get the maximum image height when outputting JPEG and PNG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


void setRasterHeight (int newVal)
 Sets the maximum image height decided by setRasterScale when outputting JPEG and PNG.
"px" (pixel) is available as the unit.


char * getRasterFormat (char *pVal, int size) const
 Get the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


wchar_t * getRasterFormatW (wchar_t *pVal, int size) const
 Get the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


void setRasterFormat (const char *newVal)
 Specifies the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


void setRasterFormatW (const wchar_t *newVal)
 Specifies the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


int getRasterJpegQuality () const
 Get the conversion accuracy when outputting JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


void setRasterJpegQuality (int newVal)
 Specifies the conversion accuracy by the value with the range of 1-100() when outputting JPEG.
When this parameter is omitted, it is regarded as 80%.


bool getRasterUseGdiPlus () const
 Gets specification whether to use GdiPlus .
Effective only when outputting to image with Windows version.


void setRasterUseGdiPlus (bool newVal)
 GdiPlus is used when the file is converted to Jpeg or PNG.
This setting is effective only with Windows Vista or later / Windows Server 2003.


bool getRasterMonochrome () const
 Gets specification whether to convert to monochrome image, when outputting JPEG and PNG.
Effective only when outputting to image with Windows version.


void setRasterMonochrome (bool newVal)
 Specifies whether to convert to monochrome image, when outputting JPEG and PNG.
Effective only when outputting to image with Windows version.


char * getRasterRGBProfile (char *pVal, int size) const
 Get the path name of RGB ICC profile for input when outputting CMYK TIFF.

wchar_t * getRasterRGBProfileW (wchar_t *pVal, int size) const
 Get the path name of RGB ICC profile for input when outputting CMYK TIFF.

void setRasterRGBProfile (const char *newVal)
 Set the path name of RGB ICC profile for input when outputting CMYK TIFF.

void setRasterRGBProfileW (const wchar_t *newVal)
 Set the path name of RGB ICC profile for input when outputting CMYK TIFF.

char * getRasterCMYKProfile (char *pVal, int size) const
 Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.

wchar_t * getRasterCMYKProfileW (wchar_t *pVal, int size) const
 Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.

void setRasterCMYKProfile (const char *newVal)
 Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.

void setRasterCMYKProfileW (const wchar_t *newVal)
 Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.

bool getRasterGrayscale () const
 Get the setting of whether to convert images to grayscale 256 tones.

void setRasterGrayscale (bool newVal)
 Outputs grayscale 256 tones..
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


bool getRaster256Color () const
 Get the setting of whether to convert images to 256 colors, and only Windows version.

void setRaster256Color (bool newVal)
 Outputs 256 colors..
Effective only when outputting to image with Windows version.


char * getRasterCompression (char *pVal, int size) const
 Get the compression method when outputting TIFF / MTIFF.

wchar_t * getRasterCompressionW (wchar_t *pVal, int size) const
 Get the compression method when outputting TIFF / MTIFF.

void setRasterCompression (const char *newVal)
 Specifies the compression method when outputting TIFF / MTIFF.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


void setRasterCompressionW (const wchar_t *newVal)
 Specifies the compression method when outputting TIFF / MTIFF.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.


void setTextPaperHeight (const char *newVal)
 Specifies the height of the paper when inputting text.

void setTextPaperHeightW (const wchar_t *newVal)
 Specifies the height of the paper when inputting text.

void setTextPaperWidth (const char *newVal)
 Specifies the width of the paper when inputting text.

void setTextPaperWidthW (const wchar_t *newVal)
 Specifies the width of the paper when inputting text.

void setTextMarginLeft (const char *newVal)
 Specifies the left margin of the paper when inputting text.

void setTextMarginLeftW (const wchar_t *newVal)
 Specifies the left margin of the paper when inputting text.

void setTextMarginTop (const char *newVal)
 Specifies the right margin of the paper when inputting text.

void setTextMarginTopW (const wchar_t *newVal)
 Specifies the right margin of the paper when inputting text.

void setTextMarginRight (const char *newVal)
 Specifies the right margin of the paper when inputting text.

void setTextMarginRightW (const wchar_t *newVal)
 Specifies the right margin of the paper when inputting text.

void setTextMarginBottom (const char *newVal)
 Specifies the right margin of the paper when inputting text.

void setTextMarginBottomW (const wchar_t *newVal)
 Specifies the right margin of the paper when inputting text.

void setTextFontFamily (const char *newVal)
 Specifies the font family name when inputting text.

void setTextFontFamilyW (const wchar_t *newVal)
 Specifies the font family name when inputting text.

void setTextFontSize (const char *newVal)
 Specifies the font size when inputting text.

void setTextFontSizeW (const wchar_t *newVal)
 Specifies the font size when inputting text.

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)
 Specifies the offset value of range from body area when showing line number and inputting text.

void setTextLineNumberFormat (const char *newVal)
 Specifies the line number format when showing line number and inputting text.

void setTextLineNumberFormatW (const wchar_t *newVal)
 Specifies the line number format when showing line number and inputting text.

bool getGdiTextAntialias () const
 Acquires the setting of the smoothing processing to text.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.


void setGdiTextAntialias (bool newVal)
 Performs the smoothing processing to text.
Effective only when printing and outputting images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.


bool getGdiLineartSmoothing () const
 Acquires the setting of the smoothing processing to borders.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.


void setGdiLineartSmoothing (bool newVal)
 Performs the smoothing processing to borders.
Effective only when printing and outputting images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.


bool getGdiImageSmoothing () const
 Acquires the setting of the smoothing processing to images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.


void setGdiImageSmoothing (bool newVal)
 Performs the smoothing processing to images.
Effective only when printing and outputting images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.


char * getWatermarkText (char *pVal, int size) const
 Get the watermark text on each page.

wchar_t * getWatermarkTextW (wchar_t *pVal, int size) const
 Get watermark text on each page.

void setWatermarkText (const char *newVal)
 Displays the specified watermark text on each page.

void setWatermarkTextW (const wchar_t *newVal)
 Displays the specified watermark text on each page.

char * getWatermarkFontFamily (char *pVal, int size) const
 Get the font family of the watermark text.

wchar_t * getWatermarkFontFamilyW (wchar_t *pVal, int size) const
 Get the font family of the watermark text.

void setWatermarkFontFamily (const char *newVal)
 Specifies the font family to the character string which you set to watermark-text.

void setWatermarkFontFamilyW (const wchar_t *newVal)
 Specifies the font family to the character string which you set to watermark-text.

char * getWatermarkFontWeight (char *pVal, int size) const
 Get the font weight of the watermark text.

wchar_t * getWatermarkFontWeightW (wchar_t *pVal, int size) const
 Get the font weight of the watermark text.

void setWatermarkFontWeight (const char *newVal)
 Specifies the font weight to the character string which you set to watermark-text.

void setWatermarkFontWeightW (const wchar_t *newVal)
 Specifies the font weight to the character string which you set to watermark-text.

char * getWatermarkFontStyle (char *pVal, int size) const
 Get the font style of the watermark text.

wchar_t * getWatermarkFontStyleW (wchar_t *pVal, int size) const
 Get the font style of the watermark text.

void setWatermarkFontStyle (const char *newVal)
 Specifies the font style to the character string which you set to watermark-text.

void setWatermarkFontStyleW (const wchar_t *newVal)
 Specifies the font style to the character string which you set to watermark-text.

char * getWatermarkOpacity (char *pVal, int size) const
 Get the opacity of the watermark text.

wchar_t * getWatermarkOpacityW (wchar_t *pVal, int size) const
 Get the opacity of the watermark text.

void setWatermarkOpacity (const char *newVal)
 Specifies the opacity to the character string which you set to watermark-text.

void setWatermarkOpacityW (const wchar_t *newVal)
 Specifies the opacity to the character string which you set to watermark-text.

bool getContinuePageNumber () const
 Gets the setting of continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.

void setContinuePageNumber (bool newVal)
 Sets continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.

char * getPdfColorProfile (char *pVal, int size) const
 Get the ICC profile file name.

wchar_t * getPdfColorProfileW (wchar_t *pVal, int size) const
 Get the ICC profile file name.

void setPdfColorProfile (const char *newVal)
 Set the ICC profile file name.

void setPdfColorProfileW (const wchar_t *newVal)
 Set the ICC profile file name.

void setOpenPassword (const char *newVal)
 Specifies the open password for document.

void setOpenPasswordW (const wchar_t *newVal)
 Specifies the open password for document.

long getPageNumberCorrection () const
 Get the setting of Support for correct number of pages in Word.

void setPageNumberCorrection (long newVal)
 Set the setting of Support for correct number of pages in Word.

bool getSheetOrderActiveFirst () const
 Gets the specified sheet first to output the active sheet when files are saved in MS Excel.

void setSheetOrderActiveFirst (bool newVal)
 Set to specify the active sheet to sheet top output when files are saved in MS Excel.

char * getSheetOrderSelect (char *pVal, int size) const
 Get the sheet order and select.

wchar_t * getSheetOrderSelectW (wchar_t *pVal, int size) const
 Get the sheet order and select.

void setSheetOrderSelect (const char *newVal)
 Set the sheet order and select.

void setSheetOrderSelectW (const wchar_t *newVal)
 Set the sheet order and select.

char * getLocale (char *pVal, int size) const
 Get the locale.

wchar_t * getLocaleW (wchar_t *pVal, int size) const
 Get the locale.

void setLocale (const char *newVal)
 Set the locale.

void setLocaleW (const wchar_t *newVal)
 Set the locale.

char * getRowColControlFileName (char *pVal, int size) const
 Get the RowColControl configuration file name.

wchar_t * getRowColControlFileNameW (wchar_t *pVal, int size) const
 Get the RowColControl configuration file name.

void setRowColControlFileName (const char *newVal)
 Set the RowColControl configuration file name.

void setRowColControlFileNameW (const wchar_t *newVal)
 Set the RowColControl configuration file name.

char * getRowColControlParameter (char *pVal, int size) const
 Get the RowColControl parameter row,col string.

wchar_t * getRowColControlParameterW (wchar_t *pVal, int size) const
 Get the RowColControl parameter row,col string.

void setRowColControlParameter (const char *newVal)
 Set the RowColControl parameter row,col.

void setRowColControlParameterW (const wchar_t *newVal)
 Set the RowColControl parameter row,col.

bool getXlsInfoView () const
 Gets the view information option.

void setXlsInfoView (bool newVal)
 Set the view information option.

char * getXlsPaperDefault (char *pVal, int size) const
 Get the XlsPaperDefault parameter string.

wchar_t * getXlsPaperDefaultW (wchar_t *pVal, int size) const
 Get the XlsPaperDefault parameter string.

void setXlsPaperDefault (const char *newVal)
 Set the XlsPaperDefault parameter.

void setXlsPaperDefaultW (const wchar_t *newVal)
 Set the XlsPaperDefault parameter.

char * getXlsPaper (char *pVal, int size) const
 Get the XlsPaper parameter string.

wchar_t * getXlsPaperW (wchar_t *pVal, int size) const
 Get the XlsPaper parameter string.

void setXlsPaper (const char *newVal)
 Set the XlsPaper parameter.

void setXlsPaperW (const wchar_t *newVal)
 Set the XlsPaper parameter.

int getDocPdfBookmarkLevel () const
 Get whether Word outline level is reflected on PDF bookmark hierarchy.

void setDocPdfBookmarkLevel (int newVal)
 Specifies whether Word outline level is reflected on PDF bookmark hierarchy.

bool getXlsSelectedSheet () const
 Get specification to output only selected sheet when files are saved in MS Excel.

void setXlsSelectedSheet (bool newVal)
 Set to output only the selected sheet when files are saved in MS Excel.

bool getPptNotes () const
 Get whether to output Notes page in PowerPoint.

void setPptNotes (bool newVal)
 Specifies whether to output Notes page in PowerPoint.

bool getDocTrackChange () const
 Gets the output track change option in MS Word.

void setDocTrackChange (bool newVal)
 Set the output track change option.

long getPdfTag () const
 Gets the tagged-pdf output.

void setPdfTag (long newVal)
 Set the tagged-pdf output.

bool getLinkfile () const
 Get the linkfile output.

void setLinkfile (bool newVal)
 Set the linkfile output.

bool getPropertyNonOutput () const
 Get whether to non-output property.

void setPropertyNonOutput (bool newVal)
 Specifies whether to non-output property.

char * getXlsOutputArea (char *pVal, int size) const
 Get the output cell-area parameter string.

wchar_t * getXlsOutputAreaW (wchar_t *pVal, int size) const
 Get the output cell-area parameter string.

void setXlsOutputArea (const char *newVal)
 Set the output cell-area parameter.

void setXlsOutputAreaW (const wchar_t *newVal)
 Set the output cell-area parameter.

void setOutputSVGFilePath (const char *newVal)
void setOutputSVGFilePathW (const wchar_t *newVal)
bool getDocNonOutline () const
 Gets the NonOutline option in MS Word.

void setDocNonOutline (bool newVal)
 Set the NonOutline option.


Private Attributes

DfvCppIfObject * m_pDfvObj


Constructor & Destructor Documentation

DfvInterface::DfvObj::DfvObj  
 

Constructor.

virtual DfvInterface::DfvObj::~DfvObj   [virtual]
 

Destructor.


Member Function Documentation

DfvCppIfObject* DfvInterface::DfvObj::getDfvObj   const [inline]
 

Get instance of DfvObj.

Returns:
pointer to DfvObj instance.

char* DfvInterface::DfvObj::getDocumentURI char *    pVal,
int    size
const
 

Get the URL of 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* DfvInterface::DfvObj::getDocumentURIW wchar_t *    pVal,
int    size
const
 

Get the URL of 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 DfvInterface::DfvObj::setDocumentURI const char *    newVal
 

Specifies the URL of document you will format.

If it is omitted or "@STDIN" is specified, 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 document.

void DfvInterface::DfvObj::setDocumentURIW const wchar_t *    newVal
 

Specifies the URL of document you will format.

If it is omitted or "@STDIN" is specified, 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 document.

char* DfvInterface::DfvObj::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* DfvInterface::DfvObj::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 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.

Parameters:
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.

Parameters:
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 format Option setting file which describes Office Server Document Converter 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* DfvInterface::DfvObj::getOptionFileURIW wchar_t *    pVal,
int    size,
int    n = 0
const
 

Get the path name of format Option setting file which describes Office Server Document Converter 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 DfvInterface::DfvObj::setOptionFileURI const char *    newVal
 

Specifies the path name of format Option setting file which describes Office Server Document Converter 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 format Option setting file.

void DfvInterface::DfvObj::setOptionFileURIW const wchar_t *    newVal
 

Specifies the path name of format Option setting file which describes Office Server Document Converter 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 format Option setting file.

void DfvInterface::DfvObj::addOptionFileURI const char *    newVal
 

Append the path name of format Option setting file which describes Office Server Document Converter options.

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

void DfvInterface::DfvObj::addOptionFileURIW const wchar_t *    newVal
 

Append the path name of format Option setting file which describes Office Server Document Converter options.

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

int DfvInterface::DfvObj::getOptionFileCount   const
 

Get the number of URIs of format Option setting file which describes Office Server Document Converter options.

Returns:
Returns the number of URIs.

long DfvInterface::DfvObj::getStartPage   const
 

Get the start page number of document to output.

Returns:
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.

Parameters:
newVal start page number of output.

long DfvInterface::DfvObj::getEndPage   const
 

Get the end page number of document to output.

Returns:
end page number of 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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

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

void DfvInterface::DfvObj::setPdfNoChanging long    newVal
 

Effective when outputting to PDF.

Disables making changes of the PDF file.

Parameters:
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.

Returns:
If zero is returned, Enables making changes of the PDF file. If nonezero is returned, 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.

Parameters:
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.

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 DfvInterface::DfvObj::setPdfNoAddingOrChangingCommnets long    newVal
 

Effective when outputting to PDF.

Disables adding comments and form fields to the PDF file.

Parameters:
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.

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 DfvInterface::DfvObj::setPdfNoAddingOrChangingComments long    newVal
 

Effective when outputting to PDF.

Disables adding comments and form fields to the PDF file.

Parameters:
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.

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 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.

Parameters:
newVal Specifies the version of PDF.

DfvPDFVERSION DfvInterface::DfvObj::getPdfVersion   const
 

Effective when outputting to PDF.

Get the version of PDF.

Returns:
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.

Parameters:
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.

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 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.

Parameters:
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.

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 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

Parameters:
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.

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 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

Parameters:
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.

Returns:
the key length.

long DfvInterface::DfvObj::getPdfEmbedAllFonts   const
 

Effective when outputting to PDF.

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

Returns:
the value of whether to embed all embeddable fonts

void DfvInterface::DfvObj::setPdfEmbedAllFonts long    newVal
 

Effective when outputting to PDF.

Embeds all embeddable fonts in PDF to create.

Parameters:
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.

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* DfvInterface::DfvObj::getPdfEmbedFontsW wchar_t *    pVal,
int    size
const
 

Effective when outputting to PDF.

Gets the font specified to be embedded in PDF.

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 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.

Parameters:
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.

Parameters:
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.

Returns:
the value of whether to issues the error

void DfvInterface::DfvObj::setPdfErrorOnEmbedFault long    newVal
 

Effective when outputting to PDF.

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

Parameters:
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.

Returns:
the value of whether to issues the error

void DfvInterface::DfvObj::setPdfErrorOnMissingGlyph long    newVal
 

Effective when outputting to PDF.

An error is issued in case of missing glyph.

Parameters:
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

Returns:
the value of printing allowed

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

Parameters:
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

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

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

Parameters:
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 setPdfImageCompression() stored in PDF.

Returns:
the value of the quality of JPEG format

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.

Parameters:
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.

Returns:
the value of whether 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.

Parameters:
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.

Returns:
the value of how to transform external 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.

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'

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

Returns:
the value of how to convert

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

Parameters:
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.

Returns:
Rasterised-resolution

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.

Parameters:
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.

Since:
7.0
Returns:
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.

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

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

Returns:
the value of whether to embed all embeddable 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.

Parameters:
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

Returns:
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.

Parameters:
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.

Returns:
the value of resolution.

void DfvInterface::DfvObj::setPdfImageDownSamplingTarget int    newVal
 

Effective when outputting to PDF.

Set resolution when the color image is downsampled.

Parameters:
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.

Returns:
the value of resolution.

void DfvInterface::DfvObj::setPdfImageDownSamplingDPI int    newVal
 

Effective when outputting to PDF.

Set resolution of the color image which performs a downsampling.

Parameters:
newVal the value of resolution.

long DfvInterface::DfvObj::getPdfPutImageColorProfile void    const
 

Effective when outputting to PDF.

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

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

void DfvInterface::DfvObj::setPdfPutImageColorProfile long    newVal
 

Effective when outputting to PDF.

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

Parameters:
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

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

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

Parameters:
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 setPdfGrayscaleImageCompression stored in PDF.

Returns:
the value of the quality of JPEG format

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.

Parameters:
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

Returns:
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.

Parameters:
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.

Returns:
the value of resolution.

void DfvInterface::DfvObj::setPdfGrayscaleImageDownSamplingTarget int    newVal
 

Effective when outputting to PDF.

Set resolution when the grayscale image is downsampled.

Parameters:
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.

Returns:
the value of resolution.

void DfvInterface::DfvObj::setPdfGrayscaleImageDownSamplingDPI int    newVal
 

Effective when outputting to PDF.

Set resolution of the grayscale image which performs a downsampling.

Parameters:
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

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

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

Parameters:
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

Returns:
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.

Parameters:
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.

Returns:
the value of resolution.

void DfvInterface::DfvObj::setPdfMonochromeImageDownSamplingTarget int    newVal
 

Effective when outputting to PDF.

Set resolution when the monochrome image is downsampled.

Parameters:
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.

Returns:
the value of resolution.

void DfvInterface::DfvObj::setPdfMonochromeImageDownSamplingDPI int    newVal
 

Effective when outputting to PDF.

Set resolution of the monochrome image which performs a downsampling.

Parameters:
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.

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* DfvInterface::DfvObj::getPdfOutputWidthW wchar_t *    pVal,
int    size
const
 

Effective when outputting to PDF.

Gets the width of PDF to output.

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 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.

Parameters:
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.

Parameters:
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.

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* DfvInterface::DfvObj::getPdfOutputHeightW wchar_t *    pVal,
int    size
const
 

Effective when outputting to PDF.

Gets the height of PDF to output.

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 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.

Parameters:
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.

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

void DfvInterface::DfvObj::setPdfOutputScale const char *    newVal
 

Specifies the scaling ratio of the PDF to output.

A value with a unit or value can be specified as length. Effective when outputting to PDF.

Parameters:
newVal the scaling ratio of the PDF

void DfvInterface::DfvObj::setPdfOutputScaleW const wchar_t *    newVal
 

Specifies the scaling ratio of the PDF to output.

A value with a unit or value can be specified as length. Effective when outputting to PDF.

Parameters:
newVal the scaling ratio of the PDF

long DfvInterface::DfvObj::getPdfErrorOnPDFXFault  
 

Effective when outputting to PDF.

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

Returns:
the value of whether to issue error.

void DfvInterface::DfvObj::setPdfErrorOnPDFXFault long    newVal
 

Effective when outputting to PDF.

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

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

bool DfvInterface::DfvObj::getPdfAnnotation   const
 

Effective when inputting from PDF.

Specifies whether to output PDF Annotation.

Returns:
If true is returned, Annotation is output. If false is returned, Annotation is not output.

void DfvInterface::DfvObj::setPdfAnnotation bool    newVal
 

Effective when inputting from PDF.

Gets the setting indicating whether to output PDF Annotation.

Parameters:
newVal If true is specified, Annotation is output.

char* DfvInterface::DfvObj::getPdfFormat char *    pVal,
int    size
const
 

Effective when outputting to PDF.

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

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* DfvInterface::DfvObj::getPdfFormatW wchar_t *    pVal,
int    size
const
 

Effective when outputting to PDF.

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

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 DfvInterface::DfvObj::setPdfFormat const char *    newVal
 

Effective when outputting to PDF.

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

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

void DfvInterface::DfvObj::setPdfFormatW const wchar_t *    newVal
 

Effective when outputting to PDF.

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

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

DfvSVGVERSION DfvInterface::DfvObj::getSvgVersion   const
 

Effective when outputting to SVG.

Get the version of SVG.

Returns:
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.

Parameters:
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.

Returns:
whether gzip compression 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.

Parameters:
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.

Returns:
whether embeds fonts or not.

void DfvInterface::DfvObj::setSvgEmbedAllFonts long    newVal
 

Effective when outputting to SVG.

Specifies whether to embed fonts in the outputted SVG.

Parameters:
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.

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* 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.

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 DfvInterface::DfvObj::setSvgFormat const char *    newVal
 

Effective when outputting to SVG.

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

Parameters:
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.

Parameters:
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.

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* DfvInterface::DfvObj::getSvgEmbedFontsW wchar_t *    pVal,
int    size
const
 

Effective when outputting to SVG.

Gets the font specified to be embedded in SVG.

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 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.

Parameters:
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.

Parameters:
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.

Returns:
the value of whether to issues the error

void DfvInterface::DfvObj::setSvgErrorOnEmbedFault long    newVal
 

Effective when outputting to SVG.

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

Parameters:
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

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

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

Parameters:
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.

Returns:
the value of the quality

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.

Parameters:
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.

Returns:
specification how to treat the referred image.

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.

Parameters:
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.

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 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.

Parameters:
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.

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 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.

Parameters:
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.

Returns:
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.

Parameters:
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.

Returns:
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.

Parameters:
newVal specification whether to rename all file name to prefix specified by 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.

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 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.

Parameters:
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.

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 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.

Parameters:
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.

Returns:
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 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.

Parameters:
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.

Returns:
Rasterised-resolution

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.

Parameters:
newVal Rasterised-resolution (70 to 500)

long DfvInterface::DfvObj::getStartVolume   const
 

Get the start volume of document to output.

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

void DfvInterface::DfvObj::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:
7.1
Parameters:
newVal start volume of output.

long DfvInterface::DfvObj::getEndVolume   const
 

Get the end volume of document to output.

Since:
7.1
Returns:
end volume of output.

void DfvInterface::DfvObj::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:
7.1
Parameters:
newVal end volume of output.

long DfvInterface::DfvObj::getMultiVolume   const
 

Get multiple volume of PDF output.

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

void DfvInterface::DfvObj::setMultiVolume long    newVal
 

Specifies multiple volume of PDF output.

Since:
7.1
Parameters:
newVal Specifies zero or nonzero.

DfvIfErrorLevel DfvInterface::DfvObj::getExitLevel   const
 

Get the error level to abort formatting process.

Returns:
Returns the error level.

void DfvInterface::DfvObj::setExitLevel DfvIfErrorLevel    newVal
 

Error level to abort formatting process.

Office Server Document 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

Parameters:
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

Returns:
Returns the error level.

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.

Returns:
Returns the error code.

char* DfvInterface::DfvObj::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* DfvInterface::DfvObj::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 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'.

Parameters:
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'.

Parameters:
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'.

Parameters:
src Specifies the font name which is replaced.

void DfvInterface::DfvObj::eraseFontAliasW const wchar_t *    src
 

Erase the substitution of font name 'fontName'.

Parameters:
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.

Parameters:
bNoThrow If the value of 'false' is specified, throws XfoException.
If the value of 'true' is specified, returns the error code.
Returns:
Returns the error code. Zero means no error. Non-zero indicates any error occurred.

void DfvInterface::DfvObj::render std::istream &    src,
std::ostream &    out
 

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

Since:
4.0
Parameters:
src Specifies document.
out the output destination of the formatting result.

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.

Parameters:
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.

Parameters:
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.

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* DfvInterface::DfvObj::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 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 converted result is outputted to the currently used printer. When "@PDF" is specified, the converted result is outputted to PDF. When "@SVG" is specified, the converted result is outputted to SVG. When "@INX" is specified, the converted result is outputted to INX. When "@XPS" is specified, the converted result is outputted to XPS. When "@JPEG" is specified, the converted result is outputted to JPEG. When "@PJPEG" is specified, the converted result is output as progressive JPEG. When "@PNG" is specified, the converted result is outputted to PNG. When "@IPNG" is specified, the converted result is output as interlaced PNG. When "@Flash" is specified, the formatted result is outputted to Flash. When "@TIFF" is specified, the converted result is outputted to TIFF. When "@TIFFC" is specified, the converted result is outputted to TIFF CMYK. When "@MTIFF" is specified, the converted result is outputted to multi-page TIFF. When "@MTIFFC" is specified, the converted result is outputted to multi-page TIFF of CMYK. 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 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 converted result is outputted to the currently used printer. When "@PDF" is specified, the converted result is outputted to PDF. When "@SVG" is specified, the converted result is outputted to SVG. When "@INX" is specified, the converted result is outputted to INX. When "@XPS" is specified, the converted result is outputted to XPS. When "@JPEG" is specified, the converted result is outputted to JPEG. When "@PJPEG" is specified, the converted result is output as progressive JPEG. When "@PNG" is specified, the converted result is outputted to PNG. When "@IPNG" is specified, the converted result is output as interlaced PNG. When "@Flash" is specified, the formatted result is outputted to Flash. When "@TIFF" is specified, the converted result is outputted to TIFF. When "@TIFFC" is specified, the converted result is outputted to TIFF CMYK. When "@MTIFF" is specified, the converted result is outputted to multi-page TIFF. When "@MTIFFC" is specified, the converted result is outputted to multi-page TIFF of CMYK. 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 DfvInterface::DfvObj::getPrnCopies   const
 

Get the number of copies.

Effective when outputting to printer. This setting is effective only with Windows version.

Returns:
Returns the number of copies.

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.

Parameters:
newVal the number of copies.

long DfvInterface::DfvObj::getPrnCollate   const
 

Get collation of multiple copies.

This setting is effective only with Windows version.

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 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.

Parameters:
newVal Zpecifies zero or nonzero.

long DfvInterface::DfvObj::getBatchPrint   const
 

Get the setting of whether print dialog box is displayed or not when printing This setting is effective only with Windows version.

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

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.

Parameters:
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 Office Server Document Converter.

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* DfvInterface::DfvObj::getVersionW wchar_t *    pVal,
int    size
const
 

Get the version string of Office Server Document Converter.

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'.

DfvINXOUTPUTMODE DfvInterface::DfvObj::getInxOutputMode   const
 

Get INX output mode.

Returns:
output mode of INX.

void DfvInterface::DfvObj::setInxOutputMode DfvINXOUTPUTMODE    newVal
 

Set INX output mode.

Parameters:
newVal 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.

Parameters:
newVal If the value is 'true' is specified, omit blank pages

long DfvInterface::DfvObj::getFlashPartiallyOutput   const
 

Get specifies of the FlashPartiallyOutput.

Since:
2.1
Returns:
specifies of 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.

Since:
2.1
Parameters:
newVal Specifies zero or nonzero.

long DfvInterface::DfvObj::getFlashHidePageButton   const
 

Get specifies of the FlashHidePageButton.

Since:
3.0
Returns:
specifies of FlashHidePageButton.

void DfvInterface::DfvObj::setFlashHidePageButton long    newVal
 

Output a no page button.

Effective when outputting to Flash.

Since:
3.0
Parameters:
newVal If the value is 'true' is specified, output a no page button.

bool DfvInterface::DfvObj::getFlashSplitPage   const
 

Get the setting of the FlashSplitPage.

Returns:
Specify FlashSplitPage.

void DfvInterface::DfvObj::setFlashSplitPage bool    newVal
 

Outputs Flash file per page and saves as every single file..
Effective when outputting to Flash.

Parameters:
newVal If 'true' is specified, do not output Flash file per page.

bool DfvInterface::DfvObj::getFlashOutputAction   const
 

Get the setting of FlashOutputAction.

Returns:
Specify FlashOutputAction.

void DfvInterface::DfvObj::setFlashOutputAction bool    newVal
 

Do not output features of ActionScript1.0, such as stop action per page, the page navigation button, linking, etc..
Effective when outputting to Flash.

Parameters:
newVal If 'true' is specified, do not output Flash file per page.

int DfvInterface::DfvObj::getFlashImageLimitSize   const
 

Get the setting of FlashImageLimitSize.

Returns:
Specify FlashImageLimitSize.

void DfvInterface::DfvObj::setFlashImageLimitSize int    newVal
 

Specifies the number of maximum pixels of images outputted to the Flash file by the integral value.

When the width or the height of the output image exceeds the specified value, it is reduced to the specified value when outputting the flash file. When this parameter is omitted, 1000 is applied.
The image size that can be embedded in Flash is limited to the value of width x height with 2 raised to the 24th power (16,777,216) by the number of pixels. Please note that when embedded image exceeds this size, it may not be displayed with Flash Player.
Effective when outputting to Flash.

Parameters:
newVal If 'true' is specified, do not output Flash file per page.

void DfvInterface::DfvObj::setPrnFitPaper bool    newVal
 

It print at size of paper.

Default is false. Effective only when outputting to image with Windows version.

Parameters:
newVal If the value is 'true' is specified, print at size of paper.

int DfvInterface::DfvObj::getRasterDPI void    const
 

Get the image resolution when outputting JPEG and PNG.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Returns:
Image resolution

void DfvInterface::DfvObj::setRasterDPI int    newVal
 

Sets the image resolution when outputting JPEG and PNG.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Image resolution (1 to 1440)

char* DfvInterface::DfvObj::getRasterScale char *    pVal,
int    size
const
 

Get the image scale when outputting JPEG and PNG.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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* DfvInterface::DfvObj::getRasterScaleW wchar_t *    pVal,
int    size
const
 

Get the image scale when outputting JPEG and PNG.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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 DfvInterface::DfvObj::setRasterScale const char *    newVal
 

Sets the image scale when outputting JPEG and PNG.

A numerical value, "%", or "px" (pixel) is available as the unit. Specify the percentage for a numerical value and "%", and specify the width of image for pixel. Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Image scale

void DfvInterface::DfvObj::setRasterScaleW const wchar_t *    newVal
 

Sets the image scale when outputting JPEG and PNG.

A numerical value, "%", or "px" (pixel) is available as the unit. Specify the percentage for a numerical value and "%", and specify the width of image for pixel. Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Image scale

int DfvInterface::DfvObj::getRasterHeight   const
 

Get the maximum image height when outputting JPEG and PNG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Returns:
Maximum image height

void DfvInterface::DfvObj::setRasterHeight int    newVal
 

Sets the maximum image height decided by setRasterScale when outputting JPEG and PNG.
"px" (pixel) is available as the unit.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Maximum image height

char* DfvInterface::DfvObj::getRasterFormat char *    pVal,
int    size
const
 

Get the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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* DfvInterface::DfvObj::getRasterFormatW wchar_t *    pVal,
int    size
const
 

Get the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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 DfvInterface::DfvObj::setRasterFormat const char *    newVal
 

Specifies the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal format for naming files

void DfvInterface::DfvObj::setRasterFormatW const wchar_t *    newVal
 

Specifies the file name naming format when outputting PNG and JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal format for naming files

int DfvInterface::DfvObj::getRasterJpegQuality   const
 

Get the conversion accuracy when outputting JPEG.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Returns:
JPEG quality

void DfvInterface::DfvObj::setRasterJpegQuality int    newVal
 

Specifies the conversion accuracy by the value with the range of 1-100() when outputting JPEG.
When this parameter is omitted, it is regarded as 80%.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal JPEG quality

bool DfvInterface::DfvObj::getRasterUseGdiPlus   const
 

Gets specification whether to use GdiPlus .
Effective only when outputting to image with Windows version.

Returns:
Specification whether to use GdiPlus.

void DfvInterface::DfvObj::setRasterUseGdiPlus bool    newVal
 

GdiPlus is used when the file is converted to Jpeg or PNG.
This setting is effective only with Windows Vista or later / Windows Server 2003.

Effective only when outputting to image with Windows version

Parameters:
newVal Specifies whether to use GdiPlus.

bool DfvInterface::DfvObj::getRasterMonochrome   const
 

Gets specification whether to convert to monochrome image, when outputting JPEG and PNG.
Effective only when outputting to image with Windows version.

Returns:
Specification whether to convert to monochrome.

void DfvInterface::DfvObj::setRasterMonochrome bool    newVal
 

Specifies whether to convert to monochrome image, when outputting JPEG and PNG.
Effective only when outputting to image with Windows version.

Parameters:
newVal Specifies whether to convert to monochrome.

char* DfvInterface::DfvObj::getRasterRGBProfile char *    pVal,
int    size
const
 

Get the path name of RGB ICC profile for input when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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* DfvInterface::DfvObj::getRasterRGBProfileW wchar_t *    pVal,
int    size
const
 

Get the path name of RGB ICC profile for input when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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 DfvInterface::DfvObj::setRasterRGBProfile const char *    newVal
 

Set the path name of RGB ICC profile for input when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setRasterRGBProfileW const wchar_t *    newVal
 

Set the path name of RGB ICC profile for input when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Pointer to a null-terminated string.

char* DfvInterface::DfvObj::getRasterCMYKProfile char *    pVal,
int    size
const
 

Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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* DfvInterface::DfvObj::getRasterCMYKProfileW wchar_t *    pVal,
int    size
const
 

Get the path name of CMYK ICC profile for output when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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 DfvInterface::DfvObj::setRasterCMYKProfile const char *    newVal
 

Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setRasterCMYKProfileW const wchar_t *    newVal
 

Set the path name of CMYK ICC profile for output when outputting CMYK TIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal Pointer to a null-terminated string.

bool DfvInterface::DfvObj::getRasterGrayscale   const
 

Get the setting of whether to convert images to grayscale 256 tones.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Returns:
Specify whether to convert images to grayscale 256 tones.

void DfvInterface::DfvObj::setRasterGrayscale bool    newVal
 

Outputs grayscale 256 tones..
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

Parameters:
newVal If "true" is specified, convert images to grayscale 256 tones.

bool DfvInterface::DfvObj::getRaster256Color   const
 

Get the setting of whether to convert images to 256 colors, and only Windows version.

Effective only when outputting to image with Windows version

Returns:
Specify whether to convert images to 256 colors.

void DfvInterface::DfvObj::setRaster256Color bool    newVal
 

Outputs 256 colors..
Effective only when outputting to image with Windows version.

Parameters:
newVal If "true" is specified, convert images to 256 colors.

char* DfvInterface::DfvObj::getRasterCompression char *    pVal,
int    size
const
 

Get the compression method when outputting TIFF / MTIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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* DfvInterface::DfvObj::getRasterCompressionW wchar_t *    pVal,
int    size
const
 

Get the compression method when outputting TIFF / MTIFF.

Effective only when outputting to image with Windows version and Linux version 6.0 or later.

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 DfvInterface::DfvObj::setRasterCompression const char *    newVal
 

Specifies the compression method when outputting TIFF / MTIFF.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

The compression method.
none : None
lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)
dct : DCTDecode
flate : FlateDecode
runlength : Run Length compression
ccitt3 : CCITT Group3
ccitt4 : CCITT Group4

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setRasterCompressionW const wchar_t *    newVal
 

Specifies the compression method when outputting TIFF / MTIFF.
Effective only when outputting to image with Windows version and Linux version 6.0 or later.

The compression method.
none : None
lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)
dct : DCTDecode
flate : FlateDecode
runlength : Run Length compression
ccitt3 : CCITT Group3
ccitt4 : CCITT Group4

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setTextPaperHeight const char *    newVal
 

Specifies the height of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the height of paper

void DfvInterface::DfvObj::setTextPaperHeightW const wchar_t *    newVal
 

Specifies the height of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the height of paper

void DfvInterface::DfvObj::setTextPaperWidth const char *    newVal
 

Specifies the width of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the width of paper

void DfvInterface::DfvObj::setTextPaperWidthW const wchar_t *    newVal
 

Specifies the width of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the width of paper

void DfvInterface::DfvObj::setTextMarginLeft const char *    newVal
 

Specifies the left margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the left margin of the paper

void DfvInterface::DfvObj::setTextMarginLeftW const wchar_t *    newVal
 

Specifies the left margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the left margin of the paper

void DfvInterface::DfvObj::setTextMarginTop const char *    newVal
 

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the top margin of the paper

void DfvInterface::DfvObj::setTextMarginTopW const wchar_t *    newVal
 

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the top margin of the paper

void DfvInterface::DfvObj::setTextMarginRight const char *    newVal
 

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the right margin of the paper

void DfvInterface::DfvObj::setTextMarginRightW const wchar_t *    newVal
 

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the right margin of the paper

void DfvInterface::DfvObj::setTextMarginBottom const char *    newVal
 

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the bottom margin of the paper

void DfvInterface::DfvObj::setTextMarginBottomW const wchar_t *    newVal
 

Specifies the right margin of the paper when inputting text.

Effective when inputting text.

Parameters:
newVal the bottom margin of the paper

void DfvInterface::DfvObj::setTextFontFamily const char *    newVal
 

Specifies the font family name when inputting text.

Effective when inputting text.

Parameters:
newVal font family name

void DfvInterface::DfvObj::setTextFontFamilyW const wchar_t *    newVal
 

Specifies the font family name when inputting text.

Effective when inputting text.

Parameters:
newVal font family name

void DfvInterface::DfvObj::setTextFontSize const char *    newVal
 

Specifies the font size when inputting text.

Effective when inputting text.

Parameters:
newVal font size

void DfvInterface::DfvObj::setTextFontSizeW const wchar_t *    newVal
 

Specifies the font size when inputting text.

Effective when inputting text.

Parameters:
newVal font size

void DfvInterface::DfvObj::setTextShowPageNumber bool    newVal
 

Specifies the value of whether show page number or not when inputting text.

Effective when inputting text.

Parameters:
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.

Parameters:
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.

Parameters:
newVal the offset value

void DfvInterface::DfvObj::setTextLineNumberOffsetW const wchar_t *    newVal
 

Specifies the offset value of range from body area when showing line number and inputting text.

Effective when inputting text.

Parameters:
newVal the offset value

void DfvInterface::DfvObj::setTextLineNumberFormat const char *    newVal
 

Specifies the line number format when showing line number and inputting text.

Effective when inputting text.

Parameters:
newVal line number format

void DfvInterface::DfvObj::setTextLineNumberFormatW const wchar_t *    newVal
 

Specifies the line number format when showing line number and inputting text.

Effective when inputting text.

Parameters:
newVal line number format

bool DfvInterface::DfvObj::getGdiTextAntialias   const
 

Acquires the setting of the smoothing processing to text.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.

Returns:
Specify whether to perform the smoothing processing to text.

void DfvInterface::DfvObj::setGdiTextAntialias bool    newVal
 

Performs the smoothing processing to text.
Effective only when printing and outputting images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.

Parameters:
newVal Performs the smoothing processing when true is specified.

bool DfvInterface::DfvObj::getGdiLineartSmoothing   const
 

Acquires the setting of the smoothing processing to borders.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.

Returns:
Specify whether to perform the smoothing processing to borders.

void DfvInterface::DfvObj::setGdiLineartSmoothing bool    newVal
 

Performs the smoothing processing to borders.
Effective only when printing and outputting images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.

Parameters:
newVal Performs the smoothing processing when true is specified.

bool DfvInterface::DfvObj::getGdiImageSmoothing   const
 

Acquires the setting of the smoothing processing to images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.

Returns:
Specify whether to perform the smoothing processing to images.

void DfvInterface::DfvObj::setGdiImageSmoothing bool    newVal
 

Performs the smoothing processing to images.
Effective only when printing and outputting images.
This setting is effective only with Windows Vista or later / Windows Server 2003 or later.

Parameters:
newVal Performs the smoothing processing when true is specified.

char* DfvInterface::DfvObj::getWatermarkText char *    pVal,
int    size
const
 

Get the watermark text on each page.

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* DfvInterface::DfvObj::getWatermarkTextW wchar_t *    pVal,
int    size
const
 

Get watermark text on each page.

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 DfvInterface::DfvObj::setWatermarkText const char *    newVal
 

Displays the specified watermark text on each page.

Possible to make it multiple lines by delimiting with the line feed
. This setting is invalid with the evaluation version.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setWatermarkTextW const wchar_t *    newVal
 

Displays the specified watermark text on each page.

Possible to make it multiple lines by delimiting with the line feed
. This setting is invalid with the evaluation version.

Parameters:
newVal Pointer to a null-terminated string.

char* DfvInterface::DfvObj::getWatermarkFontFamily char *    pVal,
int    size
const
 

Get the font family of the watermark text.

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* DfvInterface::DfvObj::getWatermarkFontFamilyW wchar_t *    pVal,
int    size
const
 

Get the font family of the watermark text.

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 DfvInterface::DfvObj::setWatermarkFontFamily const char *    newVal
 

Specifies the font family to the character string which you set to watermark-text.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setWatermarkFontFamilyW const wchar_t *    newVal
 

Specifies the font family to the character string which you set to watermark-text.

Parameters:
newVal Pointer to a null-terminated string.

char* DfvInterface::DfvObj::getWatermarkFontWeight char *    pVal,
int    size
const
 

Get the font weight of the watermark text.

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* DfvInterface::DfvObj::getWatermarkFontWeightW wchar_t *    pVal,
int    size
const
 

Get the font weight of the watermark text.

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 DfvInterface::DfvObj::setWatermarkFontWeight const char *    newVal
 

Specifies the font weight to the character string which you set to watermark-text.

Possible to specify normal, bold or the numerical value from 100 to 900.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setWatermarkFontWeightW const wchar_t *    newVal
 

Specifies the font weight to the character string which you set to watermark-text.

Possible to specify normal, bold or the numerical value from 100 to 900.

Parameters:
newVal Pointer to a null-terminated string.

char* DfvInterface::DfvObj::getWatermarkFontStyle char *    pVal,
int    size
const
 

Get the font style of the watermark text.

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* DfvInterface::DfvObj::getWatermarkFontStyleW wchar_t *    pVal,
int    size
const
 

Get the font style of the watermark text.

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 DfvInterface::DfvObj::setWatermarkFontStyle const char *    newVal
 

Specifies the font style to the character string which you set to watermark-text.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setWatermarkFontStyleW const wchar_t *    newVal
 

Specifies the font style to the character string which you set to watermark-text.

Parameters:
newVal Pointer to a null-terminated string.

char* DfvInterface::DfvObj::getWatermarkOpacity char *    pVal,
int    size
const
 

Get the opacity of the watermark text.

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* DfvInterface::DfvObj::getWatermarkOpacityW wchar_t *    pVal,
int    size
const
 

Get the opacity of the watermark text.

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 DfvInterface::DfvObj::setWatermarkOpacity const char *    newVal
 

Specifies the opacity to the character string which you set to watermark-text.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setWatermarkOpacityW const wchar_t *    newVal
 

Specifies the opacity to the character string which you set to watermark-text.

Parameters:
newVal Pointer to a null-terminated string.

bool DfvInterface::DfvObj::getContinuePageNumber   const
 

Gets the setting of continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.

Returns:
If true, inserts continuous page numbers across all worksheets/number of pages as a total of all worksheets.

void DfvInterface::DfvObj::setContinuePageNumber bool    newVal
 

Sets continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets.

Parameters:
newVal If true, sets continuous page numbers across all worksheets/number of pages as a total of all worksheets.

char* DfvInterface::DfvObj::getPdfColorProfile char *    pVal,
int    size
const
 

Get the ICC profile file name.

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* DfvInterface::DfvObj::getPdfColorProfileW wchar_t *    pVal,
int    size
const
 

Get the ICC profile file name.

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 DfvInterface::DfvObj::setPdfColorProfile const char *    newVal
 

Set the ICC profile file name.

When PDF/A-1b:2005 or PDF/A-2b:2011 is specified for PdfVersion, the ICC profile must be specified. In that case, specify the full path of the ICC profile to this parameter. This parameter is invalid except for PDF/A-1b:2005 and PDF/A-2b:2011.

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

void DfvInterface::DfvObj::setPdfColorProfileW const wchar_t *    newVal
 

Set the ICC profile file name.

When PDF/A-1b:2005 or PDF/A-2b:2011 is specified for PdfVersion, the ICC profile must be specified. In that case, specify the full path of the ICC profile to this parameter. This parameter is invalid except for PDF/A-1b:2005 and PDF/A-2b:2011.

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

void DfvInterface::DfvObj::setOpenPassword const char *    newVal
 

Specifies the open password for document.

Parameters:
newVal Pointer to a null-terminated string.

void DfvInterface::DfvObj::setOpenPasswordW const wchar_t *    newVal
 

Specifies the open password for document.

Parameters:
newVal Pointer to a null-terminated string.

long DfvInterface::DfvObj::getPageNumberCorrection   const
 

Get the setting of Support for correct number of pages in Word.

Returns:
If true, support for correct number of pages and dynamically updating table of contents in Word.

void DfvInterface::DfvObj::setPageNumberCorrection long    newVal
 

Set the setting of Support for correct number of pages in Word.

Parameters:
newVal If true, sets support for correct number of pages and dynamically updating table of contents in Word.

bool DfvInterface::DfvObj::getSheetOrderActiveFirst   const
 

Gets the specified sheet first to output the active sheet when files are saved in MS Excel.

Returns:
Return to specify the active sheet to sheet top output when files are saved in MS Excel.

void DfvInterface::DfvObj::setSheetOrderActiveFirst bool    newVal
 

Set to specify the active sheet to sheet top output when files are saved in MS Excel.

Parameters:
newVal If the value is 'true' is specified, Set to specify the active sheet to sheet top output when files are saved in MS Excel

char* DfvInterface::DfvObj::getSheetOrderSelect char *    pVal,
int    size
const
 

Get the sheet order and select.

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* DfvInterface::DfvObj::getSheetOrderSelectW wchar_t *    pVal,
int    size
const
 

Get the sheet order and select.

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 DfvInterface::DfvObj::setSheetOrderSelect const char *    newVal
 

Set the sheet order and select.

Parameters:
newVal Pointer to a null-terminated string to be used as the sheet order and select.

void DfvInterface::DfvObj::setSheetOrderSelectW const wchar_t *    newVal
 

Set the sheet order and select.

Parameters:
newVal Pointer to a null-terminated string to be used as the sheet order and select.

char* DfvInterface::DfvObj::getLocale char *    pVal,
int    size
const
 

Get the locale.

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* DfvInterface::DfvObj::getLocaleW wchar_t *    pVal,
int    size
const
 

Get the locale.

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 DfvInterface::DfvObj::setLocale const char *    newVal
 

Set the locale.

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

void DfvInterface::DfvObj::setLocaleW const wchar_t *    newVal
 

Set the locale.

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

char* DfvInterface::DfvObj::getRowColControlFileName char *    pVal,
int    size
const
 

Get the RowColControl configuration file name.

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* DfvInterface::DfvObj::getRowColControlFileNameW wchar_t *    pVal,
int    size
const
 

Get the RowColControl configuration file name.

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 DfvInterface::DfvObj::setRowColControlFileName const char *    newVal
 

Set the RowColControl configuration file name.

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

void DfvInterface::DfvObj::setRowColControlFileNameW const wchar_t *    newVal
 

Set the RowColControl configuration file name.

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

char* DfvInterface::DfvObj::getRowColControlParameter char *    pVal,
int    size
const
 

Get the RowColControl parameter row,col string.

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* DfvInterface::DfvObj::getRowColControlParameterW wchar_t *    pVal,
int    size
const
 

Get the RowColControl parameter row,col string.

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 DfvInterface::DfvObj::setRowColControlParameter const char *    newVal
 

Set the RowColControl parameter row,col.

Parameters:
newVal Pointer to a null-terminated string to be used as the parameter row,col string.

void DfvInterface::DfvObj::setRowColControlParameterW const wchar_t *    newVal
 

Set the RowColControl parameter row,col.

Parameters:
newVal Pointer to a null-terminated string to be used as the parameter row,col string.

bool DfvInterface::DfvObj::getXlsInfoView   const
 

Gets the view information option.

default font name/size in file & printer name in sheet and matched parameter.

Returns:
Return to this option.

void DfvInterface::DfvObj::setXlsInfoView bool    newVal
 

Set the view information option.

default font name/size in file & printer name in sheet and matched parameter.

Parameters:
newVal If the value is 'true' is specified, Set to the view information option.

char* DfvInterface::DfvObj::getXlsPaperDefault char *    pVal,
int    size
const
 

Get the XlsPaperDefault parameter string.

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* DfvInterface::DfvObj::getXlsPaperDefaultW wchar_t *    pVal,
int    size
const
 

Get the XlsPaperDefault parameter string.

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 DfvInterface::DfvObj::setXlsPaperDefault const char *    newVal
 

Set the XlsPaperDefault parameter.

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

void DfvInterface::DfvObj::setXlsPaperDefaultW const wchar_t *    newVal
 

Set the XlsPaperDefault parameter.

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

char* DfvInterface::DfvObj::getXlsPaper char *    pVal,
int    size
const
 

Get the XlsPaper parameter string.

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* DfvInterface::DfvObj::getXlsPaperW wchar_t *    pVal,
int    size
const
 

Get the XlsPaper parameter string.

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 DfvInterface::DfvObj::setXlsPaper const char *    newVal
 

Set the XlsPaper parameter.

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

void DfvInterface::DfvObj::setXlsPaperW const wchar_t *    newVal
 

Set the XlsPaper parameter.

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

int DfvInterface::DfvObj::getDocPdfBookmarkLevel   const
 

Get whether Word outline level is reflected on PDF bookmark hierarchy.

Returns:
If 1-9, Generates a hierarchy and folds it at the hierarchy value. If 0, Does not generate a hierarchy.

void DfvInterface::DfvObj::setDocPdfBookmarkLevel int    newVal
 

Specifies whether Word outline level is reflected on PDF bookmark hierarchy.

Parameters:
newVal If 1-9, Generates a hierarchy and folds it at the hierarchy value. If 0, Does not generate a hierarchy.

bool DfvInterface::DfvObj::getXlsSelectedSheet   const
 

Get specification to output only selected sheet when files are saved in MS Excel.

Returns:
Return to specify to output only selected sheet when files are saved in MS Excel.

void DfvInterface::DfvObj::setXlsSelectedSheet bool    newVal
 

Set to output only the selected sheet when files are saved in MS Excel.

Parameters:
newVal If the value is 'true' is specified, only the selected sheet is output when files are saved in MS Excel

bool DfvInterface::DfvObj::getPptNotes   const
 

Get whether to output Notes page in PowerPoint.

Returns:
Return If true is returened, Notes page is output. If false is returned, Slide (normal layout) is output.

void DfvInterface::DfvObj::setPptNotes bool    newVal
 

Specifies whether to output Notes page in PowerPoint.

Parameters:
newVal If true, Notes page is output. If false, Slide (normal layout) is output.

bool DfvInterface::DfvObj::getDocTrackChange   const
 

Gets the output track change option in MS Word.

Returns:
Return to this option.

void DfvInterface::DfvObj::setDocTrackChange bool    newVal
 

Set the output track change option.

Parameters:
newVal If the value is 'true' is specified, Set to the output track change option in MS Word.

long DfvInterface::DfvObj::getPdfTag   const
 

Gets the tagged-pdf output.

Returns:
Return to this option.

void DfvInterface::DfvObj::setPdfTag long    newVal
 

Set the tagged-pdf output.

Parameters:
newVal If the value is 'true' is specified, Set to the output tagged-pdf.

bool DfvInterface::DfvObj::getLinkfile   const
 

Get the linkfile output.

Returns:
Return to this option.

void DfvInterface::DfvObj::setLinkfile bool    newVal
 

Set the linkfile output.

Parameters:
newVal If the value is 'true' is specified, Set to the output linkfile.

bool DfvInterface::DfvObj::getPropertyNonOutput   const
 

Get whether to non-output property.

Returns:
Return If the value is 'true' is specified, Set to the non-output property.

void DfvInterface::DfvObj::setPropertyNonOutput bool    newVal
 

Specifies whether to non-output property.

Parameters:
newVal If the value is 'true' is specified, Set to the non-output property.

char* DfvInterface::DfvObj::getXlsOutputArea char *    pVal,
int    size
const
 

Get the output cell-area parameter string.

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* DfvInterface::DfvObj::getXlsOutputAreaW wchar_t *    pVal,
int    size
const
 

Get the output cell-area parameter string.

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 DfvInterface::DfvObj::setXlsOutputArea const char *    newVal
 

Set the output cell-area parameter.

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

void DfvInterface::DfvObj::setXlsOutputAreaW const wchar_t *    newVal
 

Set the output cell-area parameter.

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

void DfvInterface::DfvObj::setOutputSVGFilePath const char *    newVal
 

void DfvInterface::DfvObj::setOutputSVGFilePathW const wchar_t *    newVal
 

bool DfvInterface::DfvObj::getDocNonOutline   const
 

Gets the NonOutline option in MS Word.

Returns:
Return to this option.

void DfvInterface::DfvObj::setDocNonOutline bool    newVal
 

Set the NonOutline option.

Parameters:
newVal If the value is 'true' is specified, Set to the Do not convert outlines to bookmarks.


Member Data Documentation

DfvCppIfObject* DfvInterface::DfvObj::m_pDfvObj [private]
 


The documentation for this class was generated from the following file:
Generated on 3 Apr 2024 for Office Server Document Converter C/C++ Interface by Doxygen 1.3-rc2