Document Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Document.
This class is available in Office 2007 and above.
When the object is serialized out as xml, it's qualified name is w:document.
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.DocumentBackground))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Body))]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(23, "document")]
public class Document : DocumentFormat.OpenXml.OpenXmlPartRootElementpublic class Document : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.SchemaAttr(23, "document")]
public class Document : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.SchemaAttr("w:document")]
public class Document : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.SchemaAttr("w:document")]
public class Document : DocumentFormat.OpenXml.TypedOpenXmlPartRootElement[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.DocumentBackground))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Body))]
public class Document : DocumentFormat.OpenXml.OpenXmlPartRootElement[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.DocumentBackground))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Body))]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class Document : DocumentFormat.OpenXml.OpenXmlPartRootElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.DocumentBackground))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Body))>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(23, "document")>]
type Document = class
inherit OpenXmlPartRootElementtype Document = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.SchemaAttr(23, "document")>]
type Document = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.SchemaAttr("w:document")>]
type Document = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.SchemaAttr("w:document")>]
type Document = class
inherit TypedOpenXmlPartRootElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.DocumentBackground))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Body))>]
type Document = class
inherit OpenXmlPartRootElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.DocumentBackground))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Body))>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type Document = class
inherit OpenXmlPartRootElementPublic Class Document
Inherits OpenXmlPartRootElementPublic Class Document
Inherits TypedOpenXmlPartRootElement- Inheritance
- Inheritance
- Attributes
Examples
The following code example creates a word-processing document named "DocumentEx.docx" in the supplied path.
using System;
using DocumentFormat.OpenXml;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
namespace DocumentEx
{
class Program
{
static void Main(string[] args)
{
string fileName = @"C:\users\public\documents\DocumentEx.docx";
// Create a document.
using (WordprocessingDocument myDocument =
WordprocessingDocument.Create(fileName, WordprocessingDocumentType.Document))
{
// Add a main part.
MainDocumentPart mainPart = myDocument.AddMainDocumentPart();
// Create the document structure.
mainPart.Document = new Document();
Body body = mainPart.Document.AppendChild(new Body());
Paragraph para = body.AppendChild(new Paragraph());
Run run = para.AppendChild(new Run());
// Add some text to the document.
run.AppendChild(new Text("Hello, World!"));
}
Console.WriteLine("The document has been created.\nPress a key.");
Console.ReadKey();
}
}
}
Imports DocumentFormat.OpenXml
Imports DocumentFormat.OpenXml.Packaging
Imports DocumentFormat.OpenXml.Wordprocessing
Module Module1
Sub Main(ByVal args As String())
Dim fileName As String = "C:\users\public\documents\DocumentEx.docx"
' Create a document.
Using myDocument As WordprocessingDocument = WordprocessingDocument.Create(fileName, WordprocessingDocumentType.Document)
' Add a main part.
Dim mainPart As MainDocumentPart = myDocument.AddMainDocumentPart()
' Create the document structure.
mainPart.Document = New Document()
Dim body As Body = mainPart.Document.AppendChild(New Body())
Dim para As Paragraph = body.AppendChild(New Paragraph())
Dim run As Run = para.AppendChild(New Run())
' Add some text to the document.
run.AppendChild(New Text("Hello, World!"))
End Using
Console.WriteLine("The document has been created." & vbLf & "Press a key.")
Console.ReadKey()
End Sub
End Module
Remarks
[ISO/IEC 29500-1 1st Edition]
document (Document)
This element specifies the contents of a main document part in a WordprocessingML document.
[Example: Consider the basic structure of the main document part in a basic WordprocessingML document, as follows:
<w:document>
<w:body>
<w:p/>
</w:body>
</w:document>
All of the contents of the main document part are contained beneath the document element. end example]
| Parent Elements |
|---|
| Root element of WordprocessingML Main Document part |
| Child Elements | Subclause |
|---|---|
| background (Document Background) | §17.2.1 |
| body (Document Body) | §17.2.2 |
[Note: The W3C XML Schema definition of this element’s content model (CT_Document) is located in §A.1. end note]
� ISO/IEC29500: 2008.
Constructors
| Document() |
Initializes a new instance of the Document class. |
| Document(IEnumerable<OpenXmlElement>) |
Initializes a new instance of the Document class with the specified child elements. |
| Document(OpenXmlElement[]) |
Initializes a new instance of the Document class with the specified child elements. |
| Document(String) |
Initializes a new instance of the Document class from outer XML. |
Properties
| Body |
Body. Represents the following element tag in the schema: w:body. |
| ChildElements |
Gets all the child nodes of the current element. (Inherited from OpenXmlElement) |
| Conformance |
conformance Represents the following attribute in the schema: w:conformance |
| DocumentBackground |
Document Background. Represents the following element tag in the schema: w:background. |
| ExtendedAttributes |
Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement) |
| Features |
Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement) |
| FirstChild |
Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement) |
| HasAttributes |
Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement) |
| HasChildren |
Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement) |
| InnerText |
Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement) |
| InnerXml |
Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement) |
| LastChild |
Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement) |
| LocalName | |
| LocalName |
Gets the local name of the current element. (Inherited from OpenXmlElement) |
| MainDocumentPart |
Gets the MainDocumentPart associated with this element. |
| MCAttributes |
Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement) |
| NamespaceDeclarations |
Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement) |
| NamespaceUri |
Gets the namespace URI of the current element. (Inherited from OpenXmlElement) |
| OpenXmlElementContext |
Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement) |
| OpenXmlPart |
Gets the part that is associated with the DOM tree. It returns null when the DOM tree is not associated with a part. (Inherited from OpenXmlPartRootElement) |
| OuterXml |
Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement) |
| Parent |
Gets the parent element of the current element. (Inherited from OpenXmlElement) |
| Prefix |
Gets the namespace prefix of current element. (Inherited from OpenXmlElement) |
| XmlQualifiedName |
Gets the qualified name of the current element. (Inherited from OpenXmlElement) |
| XName |
Gets the qualified name of the current element. (Inherited from OpenXmlElement) |
Methods
| AddAnnotation(Object) |
Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement) |
| AddChild(OpenXmlElement, Boolean) |
Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement) |
| AddNamespaceDeclaration(String, String) |
Adds a namespace declaration to the current node. (Inherited from OpenXmlElement) |
| Ancestors() |
Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement) |
| Ancestors<T>() |
Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement) |
| Annotation(Type) |
Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotation<T>() |
Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotations(Type) |
Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotations<T>() |
Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Append(IEnumerable<OpenXmlElement>) |
Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement) |
| Append(OpenXmlElement[]) |
Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement) |
| AppendChild<T>(T) |
Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement) |
| ClearAllAttributes() |
Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement) |
| Clone() |
Creates a duplicate of the current node. (Inherited from OpenXmlElement) |
| CloneNode(Boolean) |
Creates a duplicate of this node. |
| Descendants() |
Enumerates all of the current element's descendants. (Inherited from OpenXmlElement) |
| Descendants<T>() |
Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement) |
| Elements() |
Enumerates all of the current element's children. (Inherited from OpenXmlElement) |
| Elements<T>() |
Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement) |
| ElementsAfter() |
Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement) |
| ElementsBefore() |
Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement) |
| GetAttribute(String, String) |
Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement) |
| GetAttributes() |
Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement) |
| GetEnumerator() |
Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement) |
| GetFirstChild<T>() |
Finds the first child element in type T. (Inherited from OpenXmlElement) |
| InsertAfter<T>(T, OpenXmlElement) |
Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement) |
| InsertAfterSelf<T>(T) |
Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement) |
| InsertAt<T>(T, Int32) |
Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement) |
| InsertBefore<T>(T, OpenXmlElement) |
Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement) |
| InsertBeforeSelf<T>(T) |
Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement) |
| IsAfter(OpenXmlElement) |
Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement) |
| IsBefore(OpenXmlElement) |
Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement) |
| Load(MainDocumentPart) |
Loads the DOM from the MainDocumentPart |
| LookupNamespace(String) |
Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement) |
| LookupPrefix(String) |
Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement) |
| NextSibling() |
Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement) |
| NextSibling<T>() |
Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement) |
| PrependChild<T>(T) |
Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement) |
| PreviousSibling() |
Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement) |
| PreviousSibling<T>() |
Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement) |
| Reload() |
Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement) |
| Remove() |
Removes the current element from its parent. (Inherited from OpenXmlElement) |
| RemoveAllChildren() |
Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement) |
| RemoveAllChildren<T>() |
Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement) |
| RemoveAnnotations(Type) |
Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| RemoveAnnotations<T>() |
Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| RemoveAttribute(String, String) |
Removes the attribute from the current element. (Inherited from OpenXmlElement) |
| RemoveChild<T>(T) |
Removes the specified child element. (Inherited from OpenXmlCompositeElement) |
| RemoveNamespaceDeclaration(String) |
Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement) |
| ReplaceChild<T>(OpenXmlElement, T) |
Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement) |
| Save() |
Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement) |
| Save(MainDocumentPart) |
Saves the DOM into the MainDocumentPart. |
| Save(Stream) |
Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement) |
| SetAttribute(OpenXmlAttribute) |
Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement) |
| SetAttributes(IEnumerable<OpenXmlAttribute>) |
Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement) |
| WriteTo(XmlWriter) |
Saves the current node to the specified XmlWriter. (Inherited from OpenXmlPartRootElement) |
Explicit Interface Implementations
| IEnumerable.GetEnumerator() | (Inherited from OpenXmlElement) |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement) |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for