Document Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Documento.
Esta classe está disponível no Office 2007 e superior.
Quando o objeto é serializado como xml, o nome qualificado é 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- Herança
- Herança
- Atributos
Exemplos
O exemplo de código seguinte cria um documento de processamento de palavras com o nome "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)
Este elemento especifica o conteúdo de uma peça de documento main num documento do WordprocessingML.
[Exemplo: considere a estrutura básica da parte do documento main num documento wordprocessingML básico, da seguinte forma:
<w:document>
<w:body>
<w:p/>
</w:body>
</w:document>
Todos os conteúdos da parte do documento main estão contidos abaixo do elemento do documento. exemplo final]
| Elementos pai |
|---|
| Elemento raiz da parte do Documento Principal do WordprocessingML |
| Elementos filho | Subclautilizar |
|---|---|
| fundo (Fundo do Documento) | §17.2.1 |
| corpo (Corpo do Documento) | §17.2.2 |
[Nota: a definição de Esquema XML W3C do modelo de conteúdo deste elemento (CT_Document) está localizada em {A.1. nota de fim]
ISO/IEC29500: 2008.
Construtores
| Document() |
Inicializa uma nova instância da classe Documento. |
| Document(IEnumerable<OpenXmlElement>) |
Inicializa uma nova instância da classe Documento com os elementos subordinados especificados. |
| Document(OpenXmlElement[]) |
Inicializa uma nova instância da classe Documento com os elementos subordinados especificados. |
| Document(String) |
Inicializa uma nova instância da classe Documento a partir de XML externo. |
Propriedades
| Body |
O corpo. Representa a seguinte etiqueta de elemento no esquema: w:body. |
| ChildElements |
Obtém todos os nós subordinados do elemento atual. (Herdado de OpenXmlElement) |
| Conformance |
conformidade Representa o seguinte atributo no esquema: w:conformance |
| DocumentBackground |
Fundo do Documento. Representa a seguinte etiqueta de elemento no esquema: w:background. |
| ExtendedAttributes |
Obtém todos os atributos expandidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement) |
| Features |
Obtém um IFeatureCollection para o elemento atual. Esta coleção de funcionalidades será só de leitura, mas herdará as funcionalidades da parte principal e do pacote, se disponível. (Herdado de OpenXmlElement) |
| FirstChild |
Obtém o primeiro elemento subordinado 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 subordinados. (Herdado de OpenXmlCompositeElement) |
| InnerText |
Obtém ou define os valores concatenados do nó atual e de todos os respetivos subordinados. (Herdado de OpenXmlCompositeElement) |
| InnerXml |
Obtém ou define a marcação que representa apenas os nós subordinados do nó atual. (Herdado de OpenXmlCompositeElement) |
| LastChild |
Obtém o último elemento subordinado do elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir esse elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement) |
| LocalName |
Documento. Esta classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, o nome qualificado é w:document. |
| LocalName |
Obtém o nome local do elemento atual. (Herdado de OpenXmlElement) |
| MainDocumentPart |
Obtém a MainDocumentPart associada a este elemento. |
| MCAttributes |
Obtém ou define os atributos de compatibilidade de markup. Devolve nulo se não forem definidos atributos de compatibilidade de markup para o elemento atual. (Herdado de OpenXmlElement) |
| NamespaceDeclarations |
Obtém todas as declarações de espaço de nomes definidas no elemento atual. Devolve um enumerador vazio se não existir nenhuma declaração de espaço de nomes. (Herdado de OpenXmlElement) |
| NamespaceUri |
Obtém o URI do espaço de nomes do elemento atual. (Herdado de OpenXmlElement) |
| OpenXmlElementContext |
Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement) |
| OpenXmlPart |
Obtém a parte que está associada à árvore DOM. Devolve nulo quando a árvore DOM não está associada a uma peça. (Herdado de OpenXmlPartRootElement) |
| OuterXml |
Obtém a marcação que representa o elemento atual e todos os respetivos elementos subordinados. (Herdado de OpenXmlElement) |
| Parent |
Obtém o elemento principal do elemento atual. (Herdado de OpenXmlElement) |
| Prefix |
Obtém o prefixo de espaço de nomes 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 for um subordinado conhecido. Esta ação adiciona o elemento na localização correta de acordo com o esquema. (Herdado de OpenXmlCompositeElement) |
| AddNamespaceDeclaration(String, String) |
Adiciona uma declaração de espaço de nomes ao nó atual. (Herdado de OpenXmlElement) |
| Ancestors() |
Enumera todos os predecessores do elemento atual. (Herdado de OpenXmlElement) |
| Ancestors<T>() |
Enumera apenas os predecessores do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement) |
| Annotation(Type) |
Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement) |
| Annotation<T>() |
Obtenha o primeiro objeto de anotação do tipo especificado a partir 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 fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement) |
| Append(OpenXmlElement[]) |
Acrescenta cada elemento de uma matriz de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement) |
| AppendChild<T>(T) |
Acrescenta o elemento especificado ao fim da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement) |
| ClearAllAttributes() |
Limpa todos os atributos, incluindo atributos conhecidos e atributos expandidos. (Herdado de OpenXmlElement) |
| Clone() |
Cria um duplicado do nó atual. (Herdado de OpenXmlElement) |
| CloneNode(Boolean) |
Cria um duplicado deste nó. |
| Descendants() |
Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement) |
| Descendants<T>() |
Enumerar todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement) |
| Elements() |
Enumera todos os elementos subordinados do elemento atual. (Herdado de OpenXmlElement) |
| Elements<T>() |
Enumera apenas os subordinados do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement) |
| ElementsAfter() |
Enumera todos os elementos do elemento colateral que seguem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement) |
| ElementsBefore() |
Enumera todos os elementos do elemento colateral que precedem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement) |
| GetAttribute(String, String) |
Obtém um atributo Open XML com o nome da etiqueta especificado e o URI do espaço de nomes. (Herdado de OpenXmlElement) |
| GetAttributes() |
Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement) |
| GetEnumerator() |
Devolve um enumerador que itera através da coleção subordinada. (Herdado de OpenXmlElement) |
| GetFirstChild<T>() |
Localiza o primeiro elemento subordinado 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 subordinados 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 aparece depois de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement) |
| IsBefore(OpenXmlElement) |
Determina se o elemento atual aparece antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement) |
| Load(MainDocumentPart) |
Carrega o DOM a partir de MainDocumentPart |
| LookupNamespace(String) |
Resolve o prefixo do espaço de nomes no contexto do nó atual. (Herdado de OpenXmlElement) |
| LookupPrefix(String) |
Localiza o prefixo correspondente para um URI de espaço de nomes no âmbito do elemento atual. (Herdado de OpenXmlElement) |
| NextSibling() |
Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement seguinte. (Herdado de OpenXmlElement) |
| NextSibling<T>() |
Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir um OpenXmlElement seguinte. (Herdado de OpenXmlElement) |
| PrependChild<T>(T) |
Insere o elemento especificado no início da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement) |
| PreviousSibling() |
Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement) |
| PreviousSibling<T>() |
Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement) |
| Reload() |
Recarrega o conteúdo da peça para uma árvore DOM Open XML. Este método pode ser chamado várias vezes e, sempre que for chamado, a árvore será recarregada e as alterações anteriores na árvore serão abandonadas. (Herdado de OpenXmlPartRootElement) |
| Remove() |
Remove o elemento atual do respetivo elemento principal. (Herdado de OpenXmlElement) |
| RemoveAllChildren() |
Remove todos os elementos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement) |
| RemoveAllChildren<T>() |
Remova todos os elementos subordinados 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 subordinado especificado. (Herdado de OpenXmlCompositeElement) |
| RemoveNamespaceDeclaration(String) |
Remove a declaração de espaço de nomes para o prefixo especificado. Não remove nada se não existir um prefixo. (Herdado de OpenXmlElement) |
| ReplaceChild<T>(OpenXmlElement, T) |
Substitui um dos elementos subordinados do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement) |
| Save() |
Guarda os dados na árvore DOM novamente na peça. Este método pode ser chamado várias vezes e, sempre que for chamado, o fluxo será descarregado. (Herdado de OpenXmlPartRootElement) |
| Save(MainDocumentPart) |
Guarda o DOM na MainDocumentPart. |
| Save(Stream) |
Guarda 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 é definido. Se o atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement) |
| SetAttributes(IEnumerable<OpenXmlAttribute>) |
Define vários atributos para o elemento . Se um atributo for um atributo conhecido, o valor do atributo é definido. Se um atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement) |
| WriteTo(XmlWriter) |
Guarda o nó atual no XmlWriter especificado. (Herdado de OpenXmlPartRootElement) |
Implantações explícitas de interface
| IEnumerable.GetEnumerator() |
Documento. Esta classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, o nome qualificado é w:document. (Herdado de OpenXmlElement) |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Devolve um enumerador que itera através da coleção subordinada. (Herdado de OpenXmlElement) |