Properties Methods

In This Topic
GdPicture14 Namespace / GdPictureDocumentConverter Class

GdPictureDocumentConverter Class Members

In This Topic

The following tables list the members exposed by GdPictureDocumentConverter.

Public Constructors
 NameDescription
Public ConstructorA standard constructor for the GdPictureDocumentConverter class. It initializes an instance of the GdPictureDocumentConverter class, which subsequently represents a wrapper for your file. You will need this object to perform all available conversion operations with your file.  
Top
Public Properties
 NameDescription
Public Property Specifies the name of the person who created the document.  
Public PropertySets the level of quality used to compress images with a lossy compression scheme, which are embedded in the newly produced DOCX document when converting/saving the currently loaded document to DOCX format.

It must be a value from 0 to 100. 0 means the worst quality and the best compression, 100 means the best quality and the worst compression.

 
Public PropertySpecifies if present GdPictureAnnotations objects in the loaded document should be copied before further processing.  
Public Property Specify JavaScript code to execute once the page is loaded and before the print to PDF step  
Public Property Specifies whether the email header should be injected in the output document.  
Public Property Specifies the page height, in points, of the resulting document when converting from the source Email file. Default value is 1080.  
Public Property Specifies the bottom page margin, in points, of the resulting document when converting from the source Email file.  
Public Property Specifies the left page margin, in points, of the resulting document when converting from the source Email file.  
Public Property Specifies the right page margin, in points, of the resulting document when converting from the source Email file.  
Public Property Specifies the top page margin, in points, of the resulting document when converting from the source Email file.  
Public Property Specifies the page width, in points, of the resulting document when converting from the source Email file. The default value is 792.  
Public Property Specify whether if the output document should contains one page  
Public PropertySpecifies if the ICC profile should be preserved during the conversion if it's present in the loaded document.  
Public Property Specify JavaScript code to execute once the page is loaded and before the print to PDF step  
Public Property Specify additionnals flags or settings to browser instance at process creation time.  
Public Property Specifies a type of a media to emulate.  
Public Property Specifies the page height, in points, of the resulting document when converting from the source html file. Default value is 810.  
Public Property Specifies the bottom page margin, in points, of the resulting document when converting from the source html file.  
Public Property Specifies the left page margin, in points, of the resulting document when converting from the source html file.  
Public Property Specifies the right page margin, in points, of the resulting document when converting from the source html file.  
Public Property Specifies the top page margin, in points, of the resulting document when converting from the source html file.  
Public Property Specifies the page width, in points, of the resulting document when converting from the source html file. The default value is 1440.  
Public Property Give any CSS @page size declared in the page priority over what is declared in HtmlPageWidth and HtmlPageHeight. If set to false, the renderer will scale the content to fit the paper size.  
Public Property Specifies whether the output document should contain a single page.  
Public Property Defines the load event to wait for before printing the page to PDF.  
Public Property Specifies the threshold value for the JBIG2 encoder pattern matching and substitution between 0 and 1. Any number lower than 1 may lead to lossy compression. Default value is 0.75.  
Public Property Specifies keywords associated with the document.  
Public PropertySpecifies that all executed actions with the loaded document will be processed using only the first page of the document.  
Public Property Specifies medatada of the produced document that must be represented in Extensible Markup Language (XML).  
Public PropertySpecifies individual pages or page intervals related to the loaded document for further processing.

The required page numbers need to be defined in the matching pattern, for example use the string of "1-5" for pages 1 to 5, or use the string of "1,5,6" to specify pages 1 and 5 and 6. You can use the string of "1,5,8-12" to specify pages 1, 5, 8 and all pages from page 8 to page 12, etc.

 
Public PropertySets the scheme to be used to compress bitonal image data when converting/saving the currently loaded document to PDF format.  
Public PropertySets the scheme to be used to compress color image data when converting/saving the currently loaded document to PDF format.  
Public PropertyEnables or disables the automatic color detection feature when converting/saving the currently loaded document to PDF format.

The purpose is to automatically detect the original color of documents scanned in color mode and convert the B/W and/or grayscale ones to the appropriate bpp (bits-per-pixel) encoding. The result is allowing preservation of image quality while considerably reducing the file size.

 
Public Property Specifies whether pdf encoder is applying linearization (aka fast web view). Default value is false.  
Public PropertySets the level of quality used to compress images with a lossy compression scheme, which are embedded in the newly produced PDF document when converting/saving the currently loaded document to PDF format.

It must be a value from 0 to 100. 0 means the worst quality and the best compression, 100 means the best quality and the worst compression.

 
Public PropertySpecifies if the converter shall use additional Deflate compression for JPEG images in PDF output.  
Public Property Specifies the name of the application (for example, PaperScan) that produced the document.  
Public PropertySets the rendering resolution to be used when converting vector content to raster content, if any is included in the currently loaded document.  
Public PropertySpecifies that the xls and xlsx headers and footers should be rendered.  
Public PropertySpecifies that xls and xlsx sheets should be split into pages according to the PageSetup element of each sheet.  
Public Property Specifies the spreadsheet bottom margin height in millimeters. If height is not given or negative, the margin specified in the document will be used instead. The addition of top and bottom page margin must be lower than page height.  
Public Property Specifies the spreadsheet left margin width in millimeters. If width is not given or negative, the margin specified in the document will be used instead. The addition of left and right page margin must be lower than page width.  
Public Property Decimal value indicating the maximum height of the sheet content, in millimeters. Maximum content height ignores header and footer height. When multiple pages are required to render a sheet, the content height will be the sum of the content height of each page. If set to zero or less, no limitation will be applied.  
Public Property Decimal value indicating the maximum width of the sheet content, in millimeters. Maximum content width ignores margins. When multiple pages are required to render a sheet, the content width will be the sum of the content width of each page. If set to zero or less, no limitation will be applied.  
Public Property Specifies the spreadsheet page height in millimeters. If height is not given or not positive, the page height specified in the document will be used instead. The addition of top and bottom page margin must be lower than page height.  
Public Property Specifies the spreadsheet page width in millimeters. If width is not given or not positive, the page width specified in the document will be used instead. The addition of left and right page margin must be lower than page width.  
Public Property For spreadsheet, specifies that for each sheets only the print areas must be rendered. If no print area are found the whole sheets will be rendered  
Public Property Specifies the spreadsheet right margin width in millimeters. If width is not given or negative, the margin specified in the document will be used instead. The addition of left and right page margin must be lower than page width.  
Public Property Specifies the spreadsheet top margin height in millimeters. If height is not given or negative, the margin specified in the document will be used instead. The addition of top and bottom page margin must be lower than page height.  
Public Property Specifies the subject of the document.  
Public Property Specifies whether tiff encoder is using Exif rotate flag to handle page rotations. Default value is true.  
Public Property Specifies the timeout of the subsequent conversion process, in milliseconds. Default value is -1, which means no timeout.  
Public Property Specifies the document’s title.  
Public PropertySpecifies that Office documents will be rendered showing the revisions. Inserted runs will be rendered in red, underlined. Deleted runs will be rendered in red, strikethrough.  
Public Property Specifies whether the font used for the resulting document when converting from the source txt file must have a bold style.  
Public Property Specifies the name of the font to be used for the resulting document when converting from the source txt file.  
Public Property Specifies whether the font used for the resulting document when converting from the source txt file must have an italic style.  
Public Property Specifies the text size, in points, to be used for the resulting document when converting from the source txt file.  
Public Property Specifies the horizontal text alignment of the resulting document when converting from the source txt file. Default value is TextAlignment.TextAlignmentNear.  
Public Property Specifies the page height, in points, of the resulting document when converting from the source txt file. Default value is 842, which is the A4 document height.  
Public Property Specifies the bottom page margin, in points, of the resulting document when converting from the source txt file.  
Public Property Specifies the left page margin, in points, of the resulting document when converting from the source txt file.  
Public Property Specifies the right page margin, in points, of the resulting document when converting from the source txt file.  
Public Property Specifies the top page margin, in points, of the resulting document when converting from the source txt file.  
Public Property Specifies the page width, in points, of the resulting document when converting from the source txt file. The default value is 595, which is the A4 document width.  
Top
Public Methods
 NameDescription
Public MethodCloses the currently loaded document and releases any related resources from memory.  
Public MethodOverloaded. These methods combines all the specified input files to a single PDF document and saves the resulting file to a stream or to a file according to what you have specified.  
Public MethodThis method converts the specified document from an instantiated input stream object to a single PDF document and saves the resulting file into an instantiated output stream object according to what you have specified.

The PDF version or the PDF conformance level of the resulting PDF document is set according to the given Conformance parameter.

 
Public MethodThis method disposes already used GdPictureDocumentConverter object completely. All related resources used by this object are released.  
Public Method  
Public MethodThis method loads the source document according to a file path you have specified.  
Public MethodThis method loads the source document from an http uri.  
Public MethodThis method loads the source document from a previously instantiated stream object according to what you have specified.  
Public MethodOverloaded. These methods convert the currently loaded document to DOCX and save it to a stream or to a file according to what you have specified.  
Public MethodOverloaded. These methods convert and save the currently loaded document to a stream or to a file according to what you have specified. The output document format is PDF. You can also specify the PDF conformance level of the resulting PDF document.  
Public MethodOverloaded. These methods convert the currently loaded document to PPTX and save it to a stream or to a file according to what you have specified.  
Public MethodOverloaded. These methods convert and save the currently loaded document to a stream or to a file according to what you have specified. The output document format is SVG. Only the first page within page range is converted.  
Public MethodOverloaded. These methods convert and save the currently loaded document to a stream or to a file according to what you have specified. The output document format is TIFF. You can also specify the compression method used to compress the resulting image.  
Public MethodOverloaded. These methods convert the currently loaded document to XLSX and save it to a stream or to a file according to what you have specified.  
Top
See Also