Document Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Documento.

Essa classe está disponível no Office 2007 e superior.

Quando o objeto é serializado como xml, seu nome qualificado é w:document.

public class Document : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Document = class
    inherit OpenXmlPartRootElement

Public Class Document
Inherits OpenXmlPartRootElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Document

Exemplos

O exemplo de código a seguir cria um documento de processamento de palavras chamado "DocumentEx.docx" no caminho fornecido.

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  

Comentários

[ISO/IEC 29500-1 1st Edition]

documento (Documento)

Esse elemento especifica o conteúdo de uma parte do documento main em um documento WordprocessingML.

[Exemplo: considere a estrutura básica da parte do documento main em um documento wordprocessingML básico, da seguinte maneira:

<w:document>  
  <w:body>  
    <w:p/>  
  </w:body>  
</w:document>  

Todo o conteúdo da parte do documento main está contido sob o elemento documento. exemplo final]

Elementos pai
Elemento raiz da parte do Documento Principal do WordprocessingML

Elementos filho	Subclause
plano de fundo (Plano de fundo do documento)	§17.2.1
body (Corpo do Documento)	§17.2.2

[Observação: a definição de esquema XML W3C do modelo de conteúdo desse elemento (CT_Document) está localizada em §A.1. nota final]

ISO/IEC29500: 2008.

Construtores

Document()	Inicializa uma nova instância da classe Document.
Document(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Document com os elementos filho especificados.
Document(OpenXmlElement[])	Inicializa uma nova instância da classe Document com os elementos filho especificados.
Document(String)	Inicializa uma nova instância da classe Document do XML externo.

Propriedades

Body	Corpo. Representa a seguinte marca de elemento no esquema: w:body.
ChildElements	Obtém todos os nós filho do elemento atual. (Herdado de OpenXmlElement)
Conformance	Conformidade Representa o seguinte atributo no esquema: w:conformance
DocumentBackground	Histórico do documento. Representa a seguinte marca de elemento no esquema: w:background.
ExtendedAttributes	Obtém todos os atributos estendidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
Features	Obtém um IFeatureCollection para o elemento atual. Essa coleção de recursos será somente leitura, mas herdará recursos de sua parte pai e pacote, se disponível. (Herdado de OpenXmlElement)
FirstChild	Obtém o primeiro filho do elemento OpenXmlElement atual. (Herdado de OpenXmlCompositeElement)
HasAttributes	Obtém um valor que indica se o elemento atual tem atributos. (Herdado de OpenXmlElement)
HasChildren	Obtém um valor que indica se o elemento atual tem elementos filho. (Herdado de OpenXmlCompositeElement)
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os seus filhos. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós filho do nó atual. (Herdado de OpenXmlCompositeElement)
LastChild	Obtém o último filho do elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver esse elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
LocalName	Obtém o nome local do elemento atual. (Herdado de OpenXmlElement)
MainDocumentPart	Obtém o MainDocumentPart associado a esse elemento.
MCAttributes	Obtém ou define os atributos de compatibilidade de marcação. Retorna nulo se nenhum atributo de compatibilidade de marcação for definido para o elemento atual. (Herdado de OpenXmlElement)
NamespaceDeclarations	Obtém todas as declarações de namespace definidas no elemento atual. Retornará um enumerador vazio se não houver nenhuma declaração de namespace. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do namespace do elemento atual. (Herdado de OpenXmlElement)
OpenXmlElementContext	Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement)
OpenXmlPart	Obtém a parte associada à árvore DOM. Ele retorna nulo quando a árvore DOM não está associada a uma parte. (Herdado de OpenXmlPartRootElement)
OuterXml	Obtém a marcação que representa o elemento atual e todos os seus elementos filho. (Herdado de OpenXmlElement)
Parent	Obtém o elemento pai do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo namespace do elemento atual. (Herdado de OpenXmlElement)
XmlQualifiedName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)
XName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotações do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adiciona o elemento especificado ao elemento se ele for uma criança conhecida. Isso adiciona o elemento no local correto de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de namespace ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os ancestrais do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os ancestrais do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations(Type)	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations<T>()	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Acrescenta cada elemento de uma lista de elementos ao final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos até o final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao final da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos estendidos. (Herdado de OpenXmlElement)
Clone()	Cria uma duplicata do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria uma duplicata desse nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumera todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os filhos do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os filhos do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos irmãos que seguem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos irmãos que precedem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da marca e o URI do namespace especificados. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento filho no tipo T. (Herdado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente após o elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Insere o elemento especificado imediatamente após o elemento atual. (Herdado de OpenXmlElement)
InsertAt<T>(T, Int32)	Insere o elemento especificado no índice especificado dos filhos do elemento atual. (Herdado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente antes do elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Insere o elemento especificado imediatamente antes do elemento atual. (Herdado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina se o elemento atual é exibido após um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual é exibido antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
Load(MainDocumentPart)	Carrega o DOM do MainDocumentPart
LookupNamespace(String)	Resolve o prefixo namespace no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um uri de namespace no escopo do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum próximo elemento OpenXmlElement. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver o próximo OpenXmlElement. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic ) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Reload()	Recarrega o conteúdo da parte em uma árvore DOM Open XML. Esse método pode ser chamado várias vezes e cada vez que for chamado, a árvore será recarregada e as alterações anteriores na árvore são abandonadas. (Herdado de OpenXmlPartRootElement)
Remove()	Remove o elemento atual de seu pai. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos filho do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos filho do elemento atual que são do tipo T. (Herdado de OpenXmlElement)
RemoveAnnotations(Type)	Remove as anotações do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAnnotations<T>()	Remove as anotações com o tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAttribute(String, String)	Remove o atributo do elemento atual. (Herdado de OpenXmlElement)
RemoveChild<T>(T)	Remove o elemento filho especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de namespace do prefixo especificado. Não removerá nada se não houver nenhum prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos filho do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
Save()	Salva os dados na árvore DOM de volta para a parte. Esse método pode ser chamado várias vezes e cada vez que for chamado, o fluxo será liberado. (Herdado de OpenXmlPartRootElement)
Save(MainDocumentPart)	Salva o DOM no MainDocumentPart.
Save(Stream)	Salva a árvore DOM no fluxo especificado. (Herdado de OpenXmlPartRootElement)
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for um atributo conhecido, o valor do atributo será definido. Se o atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define uma série de atributos para o elemento. Se um atributo for um atributo conhecido, o valor do atributo será definido. Se um atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Salva o nó atual no XmlWriter especificado. (Herdado de OpenXmlPartRootElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Documento. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é w:document. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)