The PdfDocument type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| PdfDocument |
Constructs an empty document
|
Methods
| Name | Description | |
|---|---|---|
| AddDigitalSignature |
Adds a digital signature to a PDF document
| |
| AddDocument |
Adds another document to the end of this document. The added document must remain open until this document is saved
| |
| AddPage()()()() |
Adds a new page with the default size, orientation and margins to the end of this document
| |
| AddPage(PdfDocumentMargins) |
Adds a new page with the default size and orientation and the given margins to the end of this document
| |
| AddPage(PdfPage) |
Adds an existing page to the end of the PDF document. When the page is from another document that document must remain open until this document is saved
| |
| AddPage(PdfPageSize, PdfDocumentMargins) |
Adds a new page with the default orientation and the given size and margins to end of this document
| |
| AddPage(PdfPageSize, PdfDocumentMargins, PdfPageOrientation) |
Adds a new page with the given size, margins and orientation at the end of this document
| |
| AddPageAtIndex(Int32, PdfPage) |
Adds an existing page at the given index. The first page index is 0.
When the page is from another document that document must remain open until this document is saved
| |
| AddPageAtIndex(Int32, PdfPageSize, PdfDocumentMargins, PdfPageOrientation) |
Adds a new page with the given size, margins and orientation at the given index. The first page index is 0
| |
| Close |
Call this method to release the document resources
| |
| CreateAttachmentFromFile(String) |
Attaches the given file to PDF document
| |
| CreateAttachmentFromFile(PdfPage, RectangleF, PdfAttachIconType, String) |
Attaches the given file to the PDF document and creates an icon for the attachment in the given rectangle in the given PDF page
| |
| CreateAttachmentFromStream(Stream, String) |
Creates an attachment in PDF document from the given stream. The stream must remain opened until
the document is saved
| |
| CreateAttachmentFromStream(PdfPage, RectangleF, PdfAttachIconType, Stream, String) |
Creates an attachment in PDF document from the given stream and an icon for attachment in the given rectangle in the given PDF page.
The stream must remain opened until the document is saved
| |
| CreateChildOutline |
Creates a child outline with the given parent in the outline hierarchy
| |
| CreateColorSpacePdf |
Creates a PDF document with a given color space
| |
| CreateFileLink |
Creates link to a file in the given PDF page and the given bounds
| |
| CreateFont(Font) |
Creates a PDF font from the given .NET font. The font will be embedded in the generated PDF document
| |
| CreateFont(Font, Boolean) |
Creates a PDF font from the given .NET font and optionally embeds the font in the generated PDF document based on embed parameter value
| |
| CreateFooterCanvas(Single) |
Creates a footer canvas and assigns it to Footer property of the document. The width
of the footer is given by the first page of the document
| |
| CreateFooterCanvas(Single, Single) |
Creates a footer canvas that can be assigned to the Footer property of the document
| |
| CreateHeaderCanvas(Single) |
Creates a header canvas and assigns it to Header property of the document. The width
of the header is given by the first page of the document
| |
| CreateHeaderCanvas(Single, Single) |
Creates a header canvas that can be assigned to the Header property of the document
| |
| CreatePdfLink |
Constructs a link in the given PDF page from the given rectangle to the given destination
| |
| CreateRepeatedCanvas |
Creates a canvas to be repeated on each PDF page in the given bounding box
| |
| CreateStandardFont |
Creates a PDF font from the given standard Type 1 font and adds it to the collection
| |
| CreateStandardPdf |
Creates a PDF document with a given PDF standard
| |
| CreateTextNote |
Constructs a text note in the given PDF page at the given location and with the given text
| |
| CreateTopOutline |
Creates a top level outline in document
| |
| CreateUriLink |
Constructs a link in the given PDF page from the given rectangle to the resource given by the the destination URI
| |
| Equals | (Inherited from Object.) | |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| FromFile(String) |
Loads a PDF document from a file
| |
| FromFile(String, String) |
Loads a password protected PDF document from a file
| |
| FromStream(Stream) |
Loads a PDF document from a stream
| |
| FromStream(Stream, String) |
Loads a password protected PDF document from a stream
| |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| ReleaseSourceDoc |
Call this method to release the source from which the document was loaded before closing the document
| |
| RemovePage(Int32) |
Removes the page at the given index from document. The first page index is 0
| |
| RemovePage(PdfPage) |
Removes the given page from document
| |
| SetOpenAction |
Set an action a PDF viewer will execute when the document is opened. An action can be the submit or reset of the PDF form,
the execution of a JavaScript code or the jump to a destination in the PDF document
| |
| ToString | (Inherited from Object.) | |
| WriteToFile |
Writes the PDF document to the given output file
| |
| WriteToMemory |
Writes the PDF document in a memory buffer
| |
| WriteToStream |
Writes the PDF document to the given output stream
|
Properties
| Name | Description | |
|---|---|---|
| Compress |
This property controls the content streams compression in the PDF document.
By default the content streams are compressed to reduce the size of the generated PDF document
| |
| Fonts |
The PDF document fonts
| |
| Footer |
The PDF document footer. The CreateFooterCanvas(Single, Single) method can be used to create an object of PdfDocumentFooter type
| |
| Form |
The document form
| |
| Header |
The PDF document header. The CreateHeaderCanvas(Single, Single) method can be used to create an object of PdfDocumentHeader type
| |
| ImagesCompression |
Controls the images compression percentage in the PDF document on a scale from 0 to 100.
A 0 compression produces the best quality images which leads to larger PDF documents while a
100 compression produces low quality images and small PDF documents
| |
| Margins |
The PDF document margins
| |
| Outlines |
The collection of top level outlines. The children of a top level outline can be accessed
with ChildOutlines property of PdfOutline
| |
| Pages |
The PDF document pages
| |
| Properties |
Controls the title, subject, keywords, author and the creation date of the PDF document
| |
| RepeatCanvases |
The collection of canvases to be repeated on each PDF page
| |
| Security |
Exposes an object to control the PDF document security
| |
| SerialNumber |
The serial number obtained after product purchase. Must be set before writing the document.
If it is not set the library will work in evaluation mode
| |
| Viewer |
Controls the PDF viewer preferences
|