EVO Word to PDF Converter for .NET Core Documentation
Pdf
This class encapsulates the options to control the PDF document
redering process. The WordToPdfConverter class define
a reference to an object of this type.
Definition
Namespace: EvoWordToPdf
Assembly: EvoWordToPdf_NetCore (in EvoWordToPdf_NetCore.dll) Version: 12.0.0
Assembly: EvoWordToPdf_NetCore (in EvoWordToPdf_NetCore.dll) Version: 12.0.0
C#
public class PdfDocumentOptionsVB
Public Class PdfDocumentOptionsC++
public ref class PdfDocumentOptionsF#
type PdfDocumentOptions = class end- Inheritance
- Object PdfDocumentOptions
Constructors
| PdfDocumentOptions | Initializes a new instance of the PdfDocumentOptions class |
Properties
| AutoCloseExternalDocs | This flag indicates if the external documents added by the AddStartDocument() and AddEndDocument() are automatically closed after the final document was generated. By default the external documents are closed |
| AvoidTextBreak | When true this property instructs the converter to try to avoid cutting off the text between PDF pages. By default this property is true. |
| BackColor | The PDF pages background color |
| BottomMargin | The rendered PDF document bottom margin in points. 1 point is 1/72 inch. By default the left margin is 0. |
| BottomSpacing | A space in points to introduce at the bottom of PDF pages where the content is rendered. 1 point is 1/72 inch. By default the bottom spacing is 0. |
| ColorProfile | Gets or sets the color profile of the PDF document generated by the converter. |
| ColorSpace | Gets or sets the color space of the PDF document generated by the converter. The possible values are RGB, CMYK or Gray Scale. The default color space is RGB. |
| CompressCrossReference | Set this property on true to store the cross-reference table and the trailer of the PDF document generated by the converter in compressed cross-reference streams and to reduce the PDF file size. The default value is false |
| DocumentObject | A reference to the internal Document object initialized by converter during conversion |
| EmbedFonts | When true this options instructs the converter to embed all the true type fonts in the PDF document generated by the converter. The default value of this property is true |
| Height | The height in points of the destination rectangle in PDF page where the content is rendered. By default the destination height is automatically calculated to render the whole content |
| JpegCompressionEnabled | Gets or sets a flag indicating if the JPEG compression is enabled or not for the images in the PDF document created by the converter. By default the JPEG compression is enabled to reduce the size of the generated PDF. When the JPEG compression is enabled the quality of the images in the generated PDF is lower than the quality of the original images in the document, function of the JpegCompressionLevel parameter. When the JpegCompressionLevel is increased, the quality of the images in PDF decreases. |
| JpegCompressionLevel | Gets or sets the compression level of images in the PDF document generated by the converter as an integer value between 0 and 100. This property has effect only when the JpegCompressionEnabled is true. When the JpegCompressionLevel is 0, the compression rate is the lowest and the quality of the images is the best. When the JpegCompressionLevel is 100, the compression rate is the highest and quality of the images in PDF is the worst. The default JPEG compression level is 10, which should offer a good balance between the compression rate and the quality of the images in PDF. |
| LeftMargin | The rendered PDF document left margin in points. 1 point is 1/72 inch. By default the left margin is 0. |
| PdfCompressionLevel | This property controls the compression level of the PDF document created by the converter. |
| PdfStandardSubset | Defines the PDF subset used by the PDF document generated by the converter. The default value is Full. This property can be used to instruct the converter to generate PDF/A or PDF/X compliant documents. |
| RightMargin | The rendered PDF document right margin in points. 1 point is 1/72 inch. By default the right margin is 0. |
| ShowFooter | This property controls the whether the footer appears or not in the PDF document generated by the converter. The footer properties can be further customized by setting the properties of object exposed by the PdfFooterOptions property of the WordToPdfConverter class. The default value of this property is false. |
| ShowHeader | This property controls the whether the header appears or not in the PDF document generated by the converter. The header properties can be further customized by setting the properties of object exposed by the PdfHeaderOptions property of the WordToPdfConverter class. The default value of this property is false. |
| TopMargin | The rendered PDF document top margin in points. 1 point is 1/72 inch. By default the top margin is 0. |
| TopSpacing | A space in points to introduce at the top of PDF pages where the content is rendered. 1 point is 1/72 inch. By default the top spacing is 0. |
| TransparencyEnabled | Gets or sets a flag indicating if the transparency is enabled in the PDF document generated by the converter. Default value is true. This property can be set to false to eliminate the additional flattening time when the document is sent to the printer from Adobe Reader viewer. |
| TransparentImagesEnabled | A flag indicating if the converter uses transparency information of the images in the PDF document generated by the converter. The default property value is true |
| Width | The width in points of the destination rectangle in PDF page where the content is rendered. By default the destination width is the available width in PDF page |
| X | The X coordinate in points where to start rendering in first page. By default the left location is 0 |
| Y | The Y coordinate in points where to start rendering in first page. By default the top location is 0 |
Methods
| AddEndDocument(Document) | Adds a PDF document object after the result of conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved. The header and footer are not applied to the PDF documents added by this method. If you want to enable the header and footer in the added PDF document use the AddEndDocument(Document, Boolean, Boolean, Boolean) |
| AddEndDocument(Stream) | Adds a PDF document from the given stream after the result of conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved. The header and footer are not applied to the PDF documents added by this method. If you want to enable the header and footer in the added PDF document use the AddEndDocument(Stream, Boolean, Boolean, Boolean) |
| AddEndDocument(String) | Adds a PDF document from the given file after the result of conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved. The header and footer are not applied to the PDF documents added by this method. If you want to enable the header and footer in the added PDF document use the AddEndDocument(String, Boolean, Boolean, Boolean) |
| AddEndDocument(Document, Boolean, Boolean, Boolean) | Adds a PDF document object after the result of Word to PDF conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved |
| AddEndDocument(Stream, Boolean, Boolean, Boolean) | Adds a PDF document from the given stream after the result of Word to PDF conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved |
| AddEndDocument(String, Boolean, Boolean, Boolean) | Adds a PDF document from the given file after the result of Word to PDF conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved |
| AddStartDocument(Document) | Adds a PDF document object before the result of Word to PDF conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved. The header and footer are not applied to the PDF documents added by this method. If you want to enable the header and footer in the added PDF document use the AddStartDocument(Document, Boolean, Boolean, Boolean) |
| AddStartDocument(Stream) | Adds a PDF document from the given stream before the result of conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved. The header and footer are not applied to the PDF documents added by this method. If you want to enable the header and footer in the added PDF document use the AddStartDocument(Stream, Boolean, Boolean, Boolean) |
| AddStartDocument(String) | Adds a PDF document from the given file before the result of conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved. The header and footer are not applied to the PDF documents added by this method. If you want to enable the header and footer in the added PDF document use the AddStartDocument(String, Boolean, Boolean, Boolean) |
| AddStartDocument(Document, Boolean, Boolean, Boolean) | Adds a PDF document object before the result of Word to PDF conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved. |
| AddStartDocument(Stream, Boolean, Boolean, Boolean) | Adds a PDF document from the given stream before the result of Word to PDF conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved |
| AddStartDocument(String, Boolean, Boolean, Boolean) | Adds a PDF document from the given file before the result of Word to PDF conversion. If the AutoCloseExternalDocs property is true the added document will be automatically closed when the final document is closed or saved |
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| ToString | (Inherited from Object) |