PdfDocument Class

Terminal Works - PDF Printing.Net Library

Represents a PDF document.

Inheritance Hierarchy

SystemObject
  PdfEdit.PdfPdfItem
    PdfEdit.PdfPdfObject
      PdfEdit.PdfPdfDocument

Namespace: PdfEdit.Pdf
Assembly: PdfPrintingNet (in PdfPrintingNet.dll) Version: 5.2.1.0 (5.2.1.0)

Syntax

C++

Copy

public sealed class PdfDocument : PdfObject, 
	IDisposable

Public NotInheritable Class PdfDocument
	Inherits PdfObject
	Implements IDisposable

public ref class PdfDocument sealed : public PdfObject, 
	IDisposable

The PdfDocument type exposes the following members.

Constructors

	Name	Description
	PdfDocument	Creates a new PDF document in memory. To open an existing PDF file, use the PdfReader class.
	PdfDocument(Stream)	Creates a new PDF document using the specified stream. The stream won't be used until the document is closed, at that time the document is saved automatically. Do not call Save() for documents created with this constructor, just call Close(). To open an existing PDF file, use the PdfReader class.
	PdfDocument(String)	Creates a new PDF document with the specified file name. The file is immediately created and keeps locked until the document is closed, at that time the document is saved automatically. Do not call Save() for documents created with this constructor, just call Close(). To open an existing PDF file and import it, use the PdfReader class.

Top

Methods

	Name	Description
	AddPage	Creates a new page and adds it to this document. Depending of the IsMetric property of the current region the page size is set to A4 or Letter respectively. If this size is not appropriate it should be changed before any drawing operations are performed on the page.
	AddPage(PdfPage)	Adds the specified page to this document. If the page is from an external document, it is imported to this document. In this case the returned page is not the same object as the specified one.
	CanSave	Determines whether the document can be saved.
	Clone	Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. (Inherited from PdfObject.)
	Close	Closes this instance.
	Dispose	Disposes all references to this document stored in other documents. This function should be called for documents you finished importing pages from. Calling Dispose is technically not necessary but useful for earlier reclaiming memory of documents you do not need anymore.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FinishPageImport	Must be called after adding pages to a document to fix up page-references in imported Acro-Fields.
	GetAllObjectIDs	Gets an array of all object identifiers. For debugging purposes only.
	GetAllReferences	Gets an array of all cross references ordered ascendingly by their object identifier.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InsertPage(Int32)	Creates a new page and inserts it in this document at the specified position.
	InsertPage(Int32, PdfPage)	Inserts the specified page in this document. If the page is from an external document, it is imported to this document. In this case the returned page is not the same object as the specified one.
	Save(Stream)	Saves the document to the specified stream. The stream is not closed by this function.
	Save(String)	Saves the document to the specified path. If a file already exists, it will be overwritten.
	Save(Stream, Boolean)	Saves the document to the specified stream.
	SetLicenseInfo	Sets the license information.
	SignWithCertificate	Digitally sign document with the certificate
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	AcroForm	Get the AcroForm dictionary.
	CustomValues	This function is intended to be undocumented.
	FileSize	Gets the file size of the document.
	FullPath	Gets the full qualified file name if the document was read form a file, or an empty string otherwise.
	Guid	Gets a Guid that uniquely identifies this instance of PdfDocument.
	Info	Gets information about the document.
	Internals	Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument.
	IsImported	Returns a value indicating whether the document was newly created or opened from an existing document. Returns true if the document was opened with the PdfReader.Open function, false otherwise.
	IsIndirect	Indicates whether the object is an indirect object. (Inherited from PdfObject.)
	IsReadOnly	Returns a value indicating whether the document is read only or can be modified.
	IsSigned	Checks if document has at least one signed certificate. It doesn't check validity of the signed certificate.
	Language	Gets or sets the default language of the document.
	Options	Gets the document options used for saving the document.
	Outlines	Gets the root of the outline (or bookmark) tree.
	Owner	Gets the PdfDocument this object belongs to. (Inherited from PdfObject.)
	PageCount	Gets the number of pages in the document.
	PageLayout	Gets or sets a value specifying the page layout to be used when the document is opened.
	PageMode	Gets or sets a value specifying how the document should be displayed when opened.
	Pages	Get the pages dictionary.
	Reference	Gets the indirect reference of this object. If the value is null, this object is a direct object. (Inherited from PdfObject.)
	SecurityHandler	Gets the security handler.
	SecuritySettings	Gets the security settings of this document.
	Settings	Gets PDF specific document settings.
	Tag	Gets or sets a user defined object that contains arbitrary information associated with this document. The tag is not used by PDFEdit.
	Version	Gets or sets the PDF version number. Return value 14 e.g. means PDF 1.4 / Acrobat 5 etc.
	ViewerPreferences	Gets the viewer preferences of this document.

Top

Reference

PdfEdit.Pdf Namespace