Click or drag to resize

Document Methods

The Document type exposes the following members.

Methods
 NameDescription
Public methodAddAssociatedFile(String, AttachmentRelationship, String, String) Embeds an arbitrary file into the PDF document as an associated file.
Public methodAddAssociatedFile(Stream, String, AttachmentRelationship, String, String) Embeds the content of a stream into the PDF document as an associated file.
Public methodAddBookmark(String, ExplicitDestination) Creates a root bookmark for the document
Public methodAddBookmark(String, ExplicitDestination, Bookmark) Creates a child bookmark for the existing parentBookmark
Public methodAddFont(Font) Adds a system font to the fonts collection. If the font was already added the method returns the existing font. By default the font is embedded in the PDF document in order to support Unicode texts.
Public methodAddFont(StandardCJKFont) Adds a standard CJK font to the collection. If the font was already added the method returns the existing font.
Public methodAddFont(StdFontBaseFamily) Adds a standard font to the collection. If the font was already added the method returns the existing font.
Public methodAddFont(String) Adds a system font to the fonts collection. The font is created from the specified file. If the font was already added the method returns the existing font.
Public methodAddFont(Font, Boolean) Adds a system font to the fonts collection. If the font was already added the method returns the existing font. The embedFont property indicates if the added font will be embedded into the PDF document.
Public methodAddNamedDestination Adds a named destination to the document: a location that links and other documents can refer to by name, for example "document.pdf#chapter-2" in a web page or a link in another PDF.
Public methodAddPage Creates a new PDF page and adds it to the collection. If there is a previous page in the collection, the orientation and size are inherited from the that page otherwise a first page with the default A4 size and Portrait orientation is created. The page margins are inherited from the default document margins
Public methodAddPage(Margins) Creates a new PDF page and adds it to the collection. If there is a previous page in the collection, the orientation and size are inherited from the that page otherwise a first page with the default A4 size and Portrait orientation is created
Public methodAddPage(PdfPage) Adds the specified page to the document pages collection. The page to be added is allowed to be from another document. The source document of the page to be added must remain opened until the current document is saved.
Public methodAddPage(PageSize, Margins) Creates a new PDF page and adds it to the collection. If there is a previous page in the collection, the page orientation is inherited from the that page otherwise a first page with the specified size and Portrait orientation is created
Public methodAddPage(PageSize, Margins, PDFPageOrientation) Creates a new PDF page with the specified size, margins and orientation and adds it to the collection
Public methodAddPageLabelRange(Int32, PageLabelStyle) Adds a range of page labels: from the page at firstPageIndex up to the next range, a PDF viewer shows the pages numbered in the specified style instead of their positions, the first page of the range numbered 1.
Public methodAddPageLabelRange(Int32, PageLabelStyle, String, Int32) Adds a range of page labels: from the page at firstPageIndex up to the next range, a PDF viewer shows the pages numbered in the specified style, after the prefix, instead of their positions.
Public methodAddTemplate(RectangleF) Add a new template with the specified bounds to the document templates collection.
Public methodAddTemplate(Single, Single) Add a new template with the specified width and height to the document templates collection. The template location is top left corner of the page.
Public methodAddXmpExtensionSchema Declares a custom PDF/A extension schema in the document XMP metadata and writes the values of its properties.
Public methodAddZugferdInvoice(Stream, ZugferdProfile, AttachmentRelationship) Makes this document a ZUGFeRD / Factur-X hybrid electronic invoice: embeds the invoice XML as an associated file and writes the Factur-X metadata.
Public methodAddZugferdInvoice(String, ZugferdProfile, AttachmentRelationship) Makes this document a ZUGFeRD / Factur-X hybrid electronic invoice, from an invoice XML file.
Public methodAddZugferdInvoice(Stream, ZugferdProfile, AttachmentRelationship, ZugferdSchema) Makes this document a ZUGFeRD / Factur-X hybrid electronic invoice, with the specified metadata schema.
Public methodAddZugferdInvoice(String, ZugferdProfile, AttachmentRelationship, ZugferdSchema) Makes this document a ZUGFeRD / Factur-X hybrid electronic invoice, from an invoice XML file, with the specified metadata schema.
Public methodAppendDocument Appends all pages from the another document specified as parameter to the current document. A custom range of pages from another document can be appended to the current document calling the Document.Pages.Add(PdfPage pdfPage) method for each page to be appended. The appended document must remain open until the current document is saved.
Public methodBeginTag Opens a container structure element (such as Table, TableRow, List or ListItem) in the logical structure of a tagged document. The elements added, and the containers opened, before the matching EndTag become its children.
Public methodClearPageLabels Removes all the page label ranges: PDF viewers show the page positions 1, 2, 3 as page numbers.
Public methodClose Releases all the resources allocated by this PDF document. Always call this method after the document was saved. If the document was created from a stream or file, the stream will be closed if it was not explicitly detached by calling the DetachStream() before the document is closed.
Public methodDetachStream Call this method to detach the stream from which this document was created. When this method is called before calling Close(), the Close method will not close the detached stream.
Public methodEndTag Closes the container structure element opened by the most recent BeginTag(PdfTagType).
Public methodStatic memberGetPageCount(Stream) A fast method to obtain the page count of a specified PDF document.
Public methodStatic memberGetPageCount(String) A fast method to obtain the page count of a specified PDF document.
Public methodGetPageLabel Gets the label a PDF viewer shows for the page at the specified index: its page label when page label ranges are added, else the page position (the index plus 1).
Public methodInsertPage(Int32, PdfPage) Inserts the specified page into the document pages collection at the specified index. The page to be added is allowed to be from another document. The source document of the page to be inserted must remain opened until the current document is saved.
Public methodInsertPage(Int32, PageSize, Margins, PDFPageOrientation) Creates a new PDF page with the specified size, margins and orientation and inserts it into the collection at the specified index.
Public methodInsertTableOfContents Inserts the table of contents at the specified page position, on pages of the same size, orientation and margins as the page at that position (or as the last page, when the position is after the last page).
Public methodRemovePage(Int32) Removes the PDF page at the specified index in pages collection.
Public methodRemovePage(PdfPage) Removes the specified PDF page from the pages collection.
Public methodSave Saves the PDF document as byte array that can be further saved into a file or send over HTTP.
Public methodSave(Stream) Saves the document into the specified stream.
Public methodSave(String) Saves the PDF document into the specified file.
Top
See Also