Document Class

Docentric Toolkit Help
Send Feedback

Represents an in-memory document. It is always the root in a DOM object heirarchy.

System.Object
Docentric.Documents.ObjectModel.DocumentObject
Docentric.Documents.ObjectModel.Document

Namespace: Docentric.Documents.ObjectModel
Assembly: Docentric.Documents.ObjectModel (in Docentric.Documents.ObjectModel.dll)

Syntax

public class Document : DocumentObject

The Document type exposes the following members.

Properties

	Name	Description
	Background	Gets the document body.
	Body	Gets the document body.
	DefaultCharacterFormat	Gets or sets the default character format for the document.
	DefaultCharacterStyle	Gets or sets the default character style. The default style gets automatically applied to all Run elements that do not have their style explicitely set.
	DefaultParagraphFormat	Gets or sets the default paragraph format for the document.
	DefaultParagraphStyle	Gets or sets the default paragraph style. The default style gets automatically applied to all Paragraph elements that do not have their style explicitely set.
	DefaultTableStyle	Gets or sets the default table style. The default style gets automatically applied to all Table elements that do not have their style explicitely set.
	EngineSettings	Gets the EngineSettings object containing engine settings for this document.
	Lists	Gets the lists (numbering definitions) of the document.
	OwnerDocument	Gets the owner document. (Inherited from DocumentObject)
	Sections	Gets the sections of the document. This collection is read-only. If you want to add new or remove sections, add or remove corresponding SectionBreak objects from the document body.
	Settings	Gets the DocumentSettings object containing settings that are common to the whole document.
	Styles	Gets the sections of the document.

Methods

	Name	Description
	Append(Document)	Appends another document to the end of this document.
	Append(Document, ImportOptions)	Appends another document to the end of this document.
	Clone	Clones this Document object including its DOM children. (Overrides Document.Clone)
	Concatenate(Stream[], ImportOptions)	Concatenates the specified documents. The input documents do not get modified during the opration.
	Concatenate(Document[], ImportOptions)	Concatenates the specified documents. The input documents do not get modified during the opration.
	Concatenate(Document, Document, ImportOptions)	Concatenates two documents by appending the second document to the first one. The input documents do not get modified during the opration.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Import(T, ImportOptions)	Clones the specified DOM object (from another Document) so that it can be added to this document.
	Import(IEnumerable<T>, ImportOptions)	Clones the specified DOM objects (from another Document) so that they can be added to this document.
	Load(String)	Loads the document from the given file path.
	Load(Stream)	Loads the document from a Stream representing a valid Word document.
	Load(Stream, LoadOptions)	Loads the document from a Stream. The input stream can contain a document in one of the supported file formats.
	New	Creates a new document.
	Print()	Prints the document to the default printer.
	Print(String)	Prints the document to the specified printer.
	Print(String, PrintTicket)	Prints the document to the specified printer using the specified PrintTicket.
	Print(String, PrintTicket, PrintPageSelection)	Prints the document to the specified printer using the specified PrintTicket.
	Save(Stream, SaveOptions)	Saves the document to the given Stream object.
	Save(String)	Saves the document to the specified file.
	SaveAsImage	Saves the document as an image.
	ToString	Returns a String that represents the current Object. (Inherited from Object)

Events

	Name	Description
	SaveProgressChanged	Occurs when a progress is made during a document save operation.

Remarks