 | |
Pdf | |
Represents a pdf document.
Inheritance HierarchySystemObject
SelectPdfPdfDocument
SelectPdfPdfDocument
Namespace: SelectPdf
Assembly: Select.Pdf (in Select.Pdf.dll) Version: 26.3
SyntaxThe PdfDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfDocument | Creates an empty pdf document object. |
| PdfDocument(PdfStandard) | Creates an empty pdf document object. |
| PdfDocument(Stream) | Loads a pdf document from the specified stream. |
| PdfDocument(String) | Loads a pdf document from an existing pdf file. |
| PdfDocument(Stream, String) | Loads a pdf document from a stream containing a password protected pdf document. |
| PdfDocument(String, String) | Loads a pdf document from an existing password protected pdf file. |
Properties| Name | Description | |
|---|---|---|
 | Bookmarks | Gets the bookmarks collection of the pdf document. |
| CompressionLevel | Gets or sets the pdf document compression level. |
| DocumentInformation | Gets a reference to the object that specifies the pdf document properties. |
| Fonts | Gets the pdf document fonts collection. |
| Footer | Represents the default pdf document footer template. |
| Header | Represents the default pdf document header template. |
| JpegCompressionEnabled | Gets or sets a flag indicating if the JPEG compression is enabled or not for the images in the generated pdf document. |
| JpegCompressionLevel | Gets or sets the compression level of images in the generated pdf document. |
| Language | Gets or sets the natural language of the document content (e.g. "en-US"), written as the document /Lang entry and on tagged structure elements. The default value is "en-US". |
| LFN | Internal use only. |
| Margins | The default pdf document margins. |
| OpenAction | The action to be performed when the pdf document is opened. |
| Pages | Gets the pdf document pages collection. |
| Security | Gets a reference to the object that specifies the pdf document security settings. |
| Tagged | Gets or sets whether the document is generated as a tagged (accessible) PDF. |
| Templates | Gets the pdf document templates collection. |
| Title | Gets or sets the document title. For a tagged document (Tagged) this is written as the XMP dc:title and, together with the ViewerPreferences DisplayDocTitle flag, is required for PDF/UA conformance. |
| ViewerPreferences | Controls how the pdf document will appear in a pdf viewer (like Adobe Reader). |
Methods| Name | Description | |
|---|---|---|
| AddAssociatedFile(String, PdfAttachmentRelationship, String, String) | Embeds an arbitrary file into the pdf document as an associated file. |
| AddAssociatedFile(Stream, String, PdfAttachmentRelationship, String, String) | Embeds the content of a stream into the pdf document as an associated file. |
| AddBookmark(String, PdfDestination) | Creates a root bookmark in the current pdf document. |
| AddBookmark(String, PdfDestination, PdfBookmark) | Creates a child bookmark in the current pdf document under the specified parent bookmark. |
| AddFont(Font) | Adds a system font to the pdf fonts collection. |
| AddFont(PdfStandardCJKFont) | Adds a standard CJK font to the pdf fonts collection. |
| AddFont(PdfStandardFont) | Adds a standard font to the pdf fonts collection. |
| AddFont(String) | Adds a system font to the pdf fonts collection. The font is loaded from the specified file. |
| AddFont(Font, Boolean) | Adds a system font to the pdf fonts collection. |
| AddPage | Creates a new pdf page and adds it to the pdf document pages collection. |
| AddPage(PdfMargins) | Creates a new pdf page with the specified margins and adds it to the pdf document pages collection. |
| AddPage(PdfPage) | Adds the specified page to the pdf document pages collection. |
| AddPage(PdfCustomPageSize, PdfMargins) | Creates a new pdf page with the specified size and margins and adds it to the pdf document pages collection. |
| AddPage(PdfCustomPageSize, PdfMargins, PdfPageOrientation) | Creates a new pdf page with the specified size, margins and orientation and adds it to the pdf document pages collection. |
| AddTemplate(RectangleF) | Adds a new template with the specified bounds to the pdf document templates collection. |
| AddTemplate(Single, Single) | Adds a new template with the specified width and height to the pdf document templates collection. |
| Append | Appends all pages from another pdf document to the current pdf document. |
| BeginTag | Opens a container structure element (such as Table, TableRow, List or ListItem) in the tagged logical structure. Page elements added, and further containers opened, before the matching EndTag become children of this element, allowing nested structures such as Table>TR>TH/TD and L>LI>LBody. |
| Close | Closes the current pdf document. |
| DetachStream | Detaches the stream that was used to load the pdf document, leaving it open in case the current pdf document is closed. |
| EndTag | Closes the most recently opened BeginTag(PdfTagType) container structure element. |
 | GetPagesCount(Stream) | Returns the number of pages in a specified pdf document. |
| GetPagesCount(String) | Returns the number of pages in a specified pdf document. |
| InsertPage(Int32, PdfPage) | Inserts the specified page into the pdf document pages collection at the specified index. |
| InsertPage(Int32, PdfCustomPageSize, PdfMargins, PdfPageOrientation) | Creates a new pdf page with the specified size, margins and orientation and inserts it into the pdf document pages collection at the specified index. |
| RemovePage | Removes the specified page from the pdf document pages collection. |
| RemovePageAt | Removes the pdf page at the specified index in pdf document pages collection. |
| Save | Saves the pdf document as byte array. |
| Save(Stream) | Saves the pdf document to the specified stream. |
| Save(String) | Saves the pdf document to the specified file. |
Remarks
This class provides the API to create, load, modify and save a pdf document.
See Also