PdfDocument Class

Represents a new PDF document being constructed in memory

Definition

Namespace: Winnovative.Pdf.Chromium
Assembly: Winnovative.Pdf.Chromium (in Winnovative.Pdf.Chromium.dll) Version: 19.5.0
C#
public class PdfDocument : IDisposable
Inheritance
Object    PdfDocument
Implements
IDisposable

Constructors

PdfDocument Initializes a new instance of the PdfDocument class with default settings. To explicitly set the PDF page size, orientation, or margins, use the constructor that accepts a PdfDocumentCreateSettings object
PdfDocument(PdfDocumentCreateSettings) Initializes a new instance of the PdfDocument class using the specified creation settings.

Properties

ContentHeight Gets the available content height of the current PDF page, after applying the top and bottom margins
ContentWidth Gets the available content width of the current PDF page, after applying the left and right margins
DigitalSignature The digital signature to apply to generated PDF document
Flatten A flag indicating if the resulted PDF is flattened. The default value is false
Margins Gets a copy of the current PDF document margins or sets the new margins used when adding new PDF elements to document
PageNumber Gets the current page number in the PDF document (1-based index)
PageSize Gets the page size of the PDF document used when creating new PDF pages
PdfDocumentInfo Gets a reference to the object to controlling the generated PDF document information like the document title, author, subject or creation date
PdfSecurityOptions Gets a reference to the object to controlling the generated PDF document security settings like user and owner password, restrict printing or editing of the generated PDF document
PdfViewerPreferences Gets a reference to the object controlling how the generated PDF is displayed by a PDF viewer

Methods

AddHtmlTemplate(Int32, Int32, Int32, String) Creates a HTML Template object based on the HTML string and an optional base URL. The height of template is auto-resized. To create a template with fixed height use the method with height parameter
AddHtmlTemplate(Int32, Int32, Int32, Int32, String) Creates a HTML Template object based on URL from which the HTML content should be retrieved. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height
AddHtmlTemplate(Int32, Int32, Int32, String, String) Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. The height of template is auto-resized. To create a template with fixed height use the method with height parameter
AddHtmlTemplate(Int32, Int32, Int32, Int32, String, String) Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height
AddHtmlTemplate(Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String) Creates a HTML Template object based on the HTML string and an optional base URL. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is auto-resized. To create a template with fixed height use the method with height parameter
AddHtmlTemplate(Int32, Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String) Creates a HTML Template object based on URL from which the HTML content should be retrieved. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height
AddHtmlTemplate(Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String, String) Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is auto-resized. To create a template with fixed height use the method with height parameter
AddHtmlTemplate(Int32, Int32, Int32, Int32, PdfTemplateHorizontalAlign, PdfTemplateVerticalAlign, String, String) Creates a HTML Template object to be rendered in PDF pages based on the HTML string and an optional base URL. Specifies the horizontal and the vertical alignment of the template on the PDF page. The alignment takes precedence over the X and Y coordinates when set to a value other than None. The height of template is fixed. If AutoResizeHeight is true, the HTML content may be scaled down to fit the specified height.
AddImage Adds an image element to the current PDF page. Supports byte array or file path images, scaling and alignment
AddPage Adds a new page to the PDF document using the current PDF page size. Use PageSize property or SetPageSize method to set the current PDF page size
AddRectangle Adds a rectangle shape to the current page
AddText Adds a text element to the current PDF page. If the text exceeds the current page, it will continue on subsequent pages based on element settings
Dispose Releases all resources used by this instance
Equals
(Inherited from Object)
Finalize
(Inherited from Object)
GetHashCode
(Inherited from Object)
GetType
(Inherited from Object)
MemberwiseClone
(Inherited from Object)
Save Finalizes and returns the PDF document as a byte array
Save(String) Saves the PDF document to the specified file.
SetPageSize Gets the page size of the PDF document used when creating new PDF pages
ToString
(Inherited from Object)

See Also