Idioma

WordprocessingDocument Classe

Definição

Define WordprocessingDocument - um OpenXmlPackage representa um documento do Word.

public class WordprocessingDocument : DocumentFormat.OpenXml.Packaging.OpenXmlPackage
public class WordprocessingDocument : DocumentFormat.OpenXml.Packaging.TypedOpenXmlPackage
public class WordprocessingDocument : DocumentFormat.OpenXml.Packaging.OpenXmlPackage, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.MainDocumentPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.ThumbnailPart>
type WordprocessingDocument = class
    inherit OpenXmlPackage
type WordprocessingDocument = class
    inherit TypedOpenXmlPackage
type WordprocessingDocument = class
    inherit OpenXmlPackage
    interface ISupportedRelationship<MainDocumentPart>
    interface ISupportedRelationship<ThumbnailPart>
Public Class WordprocessingDocument
Inherits OpenXmlPackage
Public Class WordprocessingDocument
Inherits TypedOpenXmlPackage
Public Class WordprocessingDocument
Inherits OpenXmlPackage
Implements ISupportedRelationship(Of MainDocumentPart), ISupportedRelationship(Of ThumbnailPart)
Herança
WordprocessingDocument
Herança
Implementações

Exemplos

O exemplo a seguir mostra como aplicar o estilo "Título3" ao primeiro parágrafo em um documento de processamento de texto existente. Para executar o exemplo de código, crie um arquivo de processamento de texto e escreva algum texto nele. Depois de executar o exemplo de código, examine o texto no arquivo. Você notaria que o estilo do primeiro parágrafo é alterado para "Título3".

using System;  
using System.Linq;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Wordprocessing;  

namespace WordProcessingEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            // Apply the Heading 3 style to a paragraph.   
            string fileName = @"C:\Users\Public\Documents\WordProcessingEx.docx";  
            using ( WordprocessingDocument myDocument = WordprocessingDocument.Open(fileName, true))  
            {  
                // Get the first paragraph.  
                Paragraph p = myDocument.MainDocumentPart.Document.Body.Elements<Paragraph>().First();  

                // If the paragraph has no ParagraphProperties object, create a new one.  
                if ( p.Elements<ParagraphProperties>().Count() == 0 )  
                    p.PrependChild<ParagraphProperties>(new ParagraphProperties());  

                // Get the ParagraphProperties element of the paragraph.  
                ParagraphProperties pPr = p.Elements<ParagraphProperties>().First();  

                // Set the value of ParagraphStyleId to "Heading3".  
                pPr.ParagraphStyleId = new ParagraphStyleId() { Val = "Heading3" };  
            }  
            Console.WriteLine("All done. Press a key.");  
            Console.ReadKey();  
        }  
   }  
}  
Imports System  
Imports System.Linq  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Wordprocessing  

Module Module1  
    Sub Main()  
        ' Apply the Heading 3 style to a paragraph.   
        Dim fileName As String = "C:\Users\Public\Documents\WordProcessingEx.docx"  
        Using myDocument As WordprocessingDocument = WordprocessingDocument.Open(fileName, True)  
            ' Get the first paragraph.  
            Dim p As Paragraph = myDocument.MainDocumentPart.Document.Body.Elements(Of Paragraph)().First()  

            ' If the paragraph has no ParagraphProperties object, create a new one.  
            If p.Elements(Of ParagraphProperties)().Count() = 0 Then  
                p.PrependChild(Of ParagraphProperties)(New ParagraphProperties())  
            End If  

            ' Get the ParagraphProperties element of the paragraph.  
            Dim pPr As ParagraphProperties = p.Elements(Of ParagraphProperties)().First()  

            ' Set the value of ParagraphStyleId to "Heading3".  
            pPr.ParagraphStyleId = New ParagraphStyleId() With {.Val = "Heading3"}  
        End Using  
        Console.WriteLine("All done. Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module  

Construtores

Nome Description
WordprocessingDocument()
Obsoleto.

Cria um WordprocessingDocument.

Propriedades

Nome Description
AutoSave

Obtém um valor que indica se as peças devem ser salvas quando descartadas.

(Herdado de OpenXmlPackage)
CompressionOption

Obtém ou define o nível de compactação para o conteúdo da nova parte

(Herdado de OpenXmlPackage)
CoreFilePropertiesPart

Obtém o CoreFilePropertiesPart do WordprocessingDocument.

CustomFilePropertiesPart

Obtém o CustomFilePropertiesPart do WordprocessingDocument.

DataPartReferenceRelationships

Obtém todas as DataPartReferenceRelationship relações.

(Herdado de OpenXmlPartContainer)
DataParts

Obtém todas as partes no pacote de DataPart documentos.

(Herdado de OpenXmlPackage)
DigitalSignatureOriginPart

Obtém o DigitalSignatureOriginPart do WordprocessingDocument.

DocumentType

Obtém o tipo de WordprocessingDocument.

ExtendedFilePropertiesPart

Obtém o ExtendedFilePropertiesPart do WordprocessingDocument.

ExternalRelationships

Obtém todas as relações externas. Relações de hiperlink não estão incluídas, use a propriedade HyperlinkRelationship para enumerar relações de hiperlink.

(Herdado de OpenXmlPartContainer)
Features

Obtém os recursos associados a essa parte.

FileOpenAccess

Obtém a configuração FileAccess para o documento. As configurações atuais de acesso de E/S são: Read, Write ou ReadWrite.

(Herdado de OpenXmlPackage)
HyperlinkRelationships

Obtém todas as relações de hiperlink.

(Herdado de OpenXmlPartContainer)
LabelInfoPart

Obtém o LabelInfoPart do WordprocessingDocument, disponível apenas no Office2021.

MainDocumentPart

Obtém o MainDocumentPart do WordprocessingDocument.

MarkupCompatibilityProcessSettings

Obtém as configurações de compatibilidade de marcação aplicadas no momento do carregamento.

(Herdado de OpenXmlPackage)
MaxCharactersInPart

Obtém um valor que indica o número máximo permitido de caracteres em uma parte Open XML. Um valor zero (0) indica que não há limites para o tamanho da peça. Um valor diferente de zero especifica o tamanho máximo, em caracteres.

(Herdado de OpenXmlPackage)
Package
Obsoleto.

Obtém o pacote do documento.

(Herdado de OpenXmlPackage)
PackageProperties

Obtém as propriedades do pacote.

(Herdado de OpenXmlPackage)
PartExtensionProvider

Obtém uma parte PartExtensionProvider que fornece um mapeamento de ContentType para a extensão da parte.

(Herdado de OpenXmlPackage)
Parts

Obtém todas as partes que são alvos de relação desta parte.

(Herdado de OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart

Obtém QuickAccessToolbarCustomizationsPart do WordprocessingDocument.

RibbonAndBackstageCustomizationsPart

Obtém a Faixa de OpçõesAndBackstageCustomizationsParte do WordprocessingDocument, disponível apenas no Office2010.

RibbonExtensibilityPart

Obtém a RibbonExtensibilityPart do WordprocessingDocument.

RootPart

Obtém a parte raiz do pacote.

RootPart

Obtém a parte raiz do pacote.

(Herdado de OpenXmlPackage)
StrictRelationshipFound

Obtém um valor que indica se esse pacote contém relações de transição convertidas de estritas.

(Herdado de OpenXmlPackage)
ThumbnailPart

Obtém o ThumbnailPart do WordprocessingDocument.

WebExTaskpanesPart

Obtém o WebExTaskpanesPart do WordprocessingDocument, disponível apenas no Office2013.

Métodos

Nome Description
AddAnnotation(Object)

Adiciona um objeto à lista de anotações deste PartContainer.

(Herdado de OpenXmlPartContainer)
AddCoreFilePropertiesPart()

Adiciona um CoreFilePropertiesPart ao WordprocessingDocument.

AddCustomFilePropertiesPart()

Adiciona um CustomFilePropertiesPart ao WordprocessingDocument.

AddDigitalSignatureOriginPart()

Adiciona um DigitalSignatureOriginPart ao WordprocessingDocument.

AddExtendedFilePropertiesPart()

Adiciona um ExtendedFilePropertiesPart ao WordprocessingDocument.

AddExtendedPart(String, String, String, String)

Adiciona uma parte estendida (parte específica do aplicativo).

(Herdado de OpenXmlPartContainer)
AddExtendedPart(String, String, String)

Adiciona uma parte estendida (parte específica do aplicativo).

(Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)

Adiciona uma relação externa. Não adicione relações de hiperlink por esse método. Em vez disso, use AddHyperlinkRelationship().

(Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri)

Adiciona uma relação externa. Não adicione relações de hiperlink por esse método. Em vez disso, use AddHyperlinkRelationship().

(Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)

Adiciona uma nova relação de hiperlink.

(Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)

Adiciona uma nova relação de hiperlink.

(Herdado de OpenXmlPartContainer)
AddLabelInfoPart()

Adiciona um LabelInfoPart ao WordprocessingDocument, essa parte só está disponível no Office2021.

AddMainDocumentPart()

Cria o MainDocumentPart e o adiciona a este documento.

AddNewPart<T>()

Adiciona uma nova parte do tipo T.

(Herdado de OpenXmlPartContainer)
AddNewPart<T>(String, String)

Adiciona uma nova parte do tipo T.

AddNewPart<T>(String)

Adiciona uma nova parte do tipo T.

(Herdado de OpenXmlPartContainer)
AddPart<T>(T, String)

Adiciona a parte ao documento com um determinado identificador de relação (ID). Deve usar a peça devolvida para operar na parte adicionada ao documento

(Herdado de OpenXmlPartContainer)
AddPart<T>(T)

Adiciona a parte especificada ao documento. Use a peça devolvida para operar na parte adicionada ao documento.

(Herdado de OpenXmlPackage)
AddQuickAccessToolbarCustomizationsPart()

Adiciona um QuickAccessToolbarCustomizationsPart ao WordprocessingDocument.

AddRibbonAndBackstageCustomizationsPart()

Adiciona uma RibbonAndBackstageCustomizationsPart ao WordprocessingDocument. Essa parte só está disponível no Office2010.

AddRibbonExtensibilityPart()

Adiciona um RibbonExtensibilityPart ao WordprocessingDocument.

AddThumbnailPart(String)

Adiciona um ThumbnailPart ao WordprocessingDocument.

AddThumbnailPart(ThumbnailPartType)

Adiciona um ThumbnailPart ao WordprocessingDocument.

AddWebExTaskpanesPart()

Adiciona um WebExTaskpanesPart ao WordprocessingDocument, essa parte só está disponível no Office2013.

Annotation(Type)

Obtenha o primeiro objeto de anotação do tipo especificado deste PartContainer.

(Herdado de OpenXmlPartContainer)
Annotation<T>()

Obtenha o primeiro objeto de anotação do tipo especificado deste PartContainer.

(Herdado de OpenXmlPartContainer)
Annotations(Type)

Obtém uma coleção de anotações do tipo especificado para este PartContainer.

(Herdado de OpenXmlPartContainer)
Annotations<T>()

Obtém uma coleção de anotações do tipo especificado para este PartContainer.

(Herdado de OpenXmlPartContainer)
ChangeDocumentType(WordprocessingDocumentType)

Altera o tipo de documento.

ChangeIdOfPart(OpenXmlPart, String)

Altera a ID de relação da peça.

(Herdado de OpenXmlPartContainer)
Clone()

Cria um clone editável deste pacote OpenXml, aberto em um MemoryStream com capacidade expansível e usando OpenSettings padrão.

(Herdado de OpenXmlPackage)
Clone(Package, OpenSettings)

Cria um clone deste pacote OpenXml, aberto na instância especificada do Pacote.

(Herdado de OpenXmlPackage)
Clone(Package)

Cria um clone deste pacote OpenXml, aberto na instância especificada do Pacote. O clone será aberto com o mesmo OpenSettings deste pacote OpenXml.

(Herdado de OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)

Cria um clone deste pacote OpenXml, aberto no fluxo fornecido.

(Herdado de OpenXmlPackage)
Clone(Stream, Boolean)

Cria um clone deste pacote OpenXml, aberto no fluxo fornecido. O pacote OpenXml clonado é aberto com o mesmo OpenSettings que este pacote OpenXml.

(Herdado de OpenXmlPackage)
Clone(Stream)

Cria um clone deste pacote OpenXml, aberto no fluxo fornecido. O pacote OpenXml clonado é aberto com as mesmas configurações, ou seja, FileOpenAccess e OpenSettings, que este pacote OpenXml.

(Herdado de OpenXmlPackage)
Clone(String, Boolean, OpenSettings)

Cria um clone deste pacote OpenXml aberto a partir do arquivo fornecido (que será criado clonando este pacote OpenXml).

(Herdado de OpenXmlPackage)
Clone(String, Boolean)

Cria um clone deste pacote OpenXml aberto a partir do arquivo fornecido (que será criado clonando este pacote OpenXml). O pacote OpenXml clonado é aberto com o mesmo OpenSettings que este pacote OpenXml.

(Herdado de OpenXmlPackage)
Clone(String)

Cria um clone deste pacote OpenXml aberto a partir do arquivo fornecido (que será criado clonando este pacote OpenXml). O pacote OpenXml clonado é aberto com as mesmas configurações, ou seja, FileOpenAccess e OpenSettings, que este pacote OpenXml.

(Herdado de OpenXmlPackage)
Close()
Obsoleto.

Salva e fecha o pacote OpenXml e todos os fluxos de partes subjacentes.

(Herdado de OpenXmlPackage)
Create(Package, WordprocessingDocumentType, Boolean)

Cria uma nova instância da classe WordprocessingDocument do pacote especificado.

Create(Package, WordprocessingDocumentType)

Cria uma nova instância da classe WordprocessingDocument do pacote especificado.

Create(Stream, WordprocessingDocumentType, Boolean)

Cria uma nova instância da classe WordprocessingDocument a partir do fluxo de E/S.

Create(Stream, WordprocessingDocumentType)

Cria uma nova instância da classe WordprocessingDocument a partir do fluxo de E/S.

Create(String, WordprocessingDocumentType, Boolean)

Cria uma nova instância da classe WordprocessingDocument do arquivo especificado.

Create(String, WordprocessingDocumentType)

Cria uma nova instância da classe WordprocessingDocument do arquivo especificado.

CreateClone(Package)

Cria uma nova instância de OpenXmlPackage na instância especificada de Package.

CreateClone(Stream)

Cria um novo OpenXmlPackage no fluxo fornecido.

CreateClone(String)

Cria um novo pacote OpenXml no arquivo fornecido.

CreateFromTemplate(String, Boolean)

Cria um WordprocessingDocument editável a partir de um modelo, aberto em um MemoryStream com capacidade expansível.

CreateFromTemplate(String)

Cria um WordprocessingDocument editável a partir de um modelo, aberto em um MemoryStream com capacidade expansível. O modelo será anexado ao WordprocessingDocument.

CreateMediaDataPart(MediaDataPartType)

Cria uma nova MediaDataPart parte no pacote de documentos.

(Herdado de OpenXmlPackage)
CreateMediaDataPart(String, String)

Cria uma nova MediaDataPart parte no pacote de documentos.

(Herdado de OpenXmlPackage)
CreateMediaDataPart(String)

Cria uma nova MediaDataPart parte no pacote de documentos.

(Herdado de OpenXmlPackage)
CreateRelationshipToPart(OpenXmlPart, String)

Adiciona uma relação da peça especificada a essa parte.

(Herdado de OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart)

Adiciona uma relação da peça especificada a essa parte.

(Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)

Exclui a relação externa especificada.

(Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(String)

Exclui o ExternalRelationship especificado.

(Herdado de OpenXmlPartContainer)
DeletePart(DataPart)

Exclui o especificado DataPart do pacote de documentos.

(Herdado de OpenXmlPackage)
DeletePart(OpenXmlPart)

Exclui uma parte especificada na camada raiz do pacote.

(Herdado de OpenXmlPartContainer)
DeletePart(String)

Exclui a parte filho especificada dessa parte.

(Herdado de OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)

Exclui todas as partes que estão na coleção passada do documento.

(Herdado de OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()

Exclui todas as partes com o tipo de peça especificado do pacote recursivamente.

(Herdado de OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)

Exclui a relação de referência especificada.

(Herdado de OpenXmlPartContainer)
DeleteReferenceRelationship(String)

Exclui a relação de referência especificada.

(Herdado de OpenXmlPartContainer)
Dispose()

Libera e salva o conteúdo, fecha o documento e libera todos os recursos.

(Herdado de OpenXmlPackage)
Dispose(Boolean)

Libera e salva o conteúdo, fecha o documento e libera todos os recursos.

(Herdado de OpenXmlPackage)
FromFlatOpcDocument(XDocument, Package)

Cria uma nova instância de WordprocessingDocument de um XDocument formato OPC simples.

FromFlatOpcDocument(XDocument, Stream, Boolean)

Cria uma nova instância de WordprocessingDocument de um XDocument formato OPC simples.

FromFlatOpcDocument(XDocument, String, Boolean)

Cria uma nova instância de WordprocessingDocument de um XDocument formato OPC simples.

FromFlatOpcDocument(XDocument)

Cria uma nova instância editável de WordprocessingDocument a partir de um XDocument formato OPC simples, aberto em um MemoryStreamarquivo .

FromFlatOpcString(String, Package)

Cria uma nova instância de WordprocessingDocument de uma cadeia de caracteres no formato OPC simples.

FromFlatOpcString(String, Stream, Boolean)

Cria uma nova instância de WordprocessingDocument de uma cadeia de caracteres no formato OPC simples em um

FromFlatOpcString(String, String, Boolean)

Cria uma nova instância de WordprocessingDocument de uma cadeia de caracteres no formato OPC simples.

FromFlatOpcString(String)

Cria uma nova instância de WordprocessingDocument de uma cadeia de caracteres no formato OPC simples em um MemoryStream com capacidade expansível.

GetExternalRelationship(String)

Obtém o ExternalRelationship especificado.

(Herdado de OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)

Obtém a ID da relação da peça.

(Herdado de OpenXmlPartContainer)
GetPartById(String)

Obtém a parte filho por meio da ID da relação.

(Herdado de OpenXmlPartContainer)
GetPartsCountOfType<T>()
Obsoleto.

Obtém a contagem de todas as partes do tipo T.

(Herdado de OpenXmlPartContainer)
GetPartsOfType<T>()

Enumera todas as partes filhos do tipo T especificado dessa parte.

(Herdado de OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)
Obsoleto.

Obtém todas as partes filhos do tipo T especificado nesta partCollection parte.

(Herdado de OpenXmlPartContainer)
GetReferenceRelationship(String)

Obtém o ReferenceRelationship especificado.

(Herdado de OpenXmlPartContainer)
Open(Package, OpenSettings)

Cria uma nova instância da classe WordprocessingDocument do pacote especificado.

Open(Package)

Cria uma nova instância da classe WordprocessingDocument do pacote especificado.

Open(Stream, Boolean, OpenSettings)

Cria uma nova instância da classe WordprocessingDocument a partir do fluxo de E/S.

Open(Stream, Boolean)

Cria uma nova instância da classe WordprocessingDocument a partir do fluxo de E/S.

Open(String, Boolean, OpenSettings)

Cria uma nova instância da classe WordprocessingDocument do arquivo especificado.

Open(String, Boolean)

Cria uma nova instância da classe WordprocessingDocument do arquivo especificado.

OpenClone(Stream, Boolean, OpenSettings)

Abre o pacote OpenXml clonado no fluxo fornecido.

OpenClone(String, Boolean, OpenSettings)

Abre o pacote OpenXml clonado no arquivo fornecido.

RemoveAnnotations(Type)

Remove as anotações do tipo especificado deste PartContainer.

(Herdado de OpenXmlPartContainer)
RemoveAnnotations<T>()

Remove as anotações do tipo especificado deste PartContainer.

(Herdado de OpenXmlPartContainer)
Save()

Salva o conteúdo de todas as partes e relacionamentos contidos no pacote OpenXml, se FileOpenAccess for ReadWrite. Algumas plataformas não dão suporte ao salvamento devido a limitações no Package, portanto, consulte CanSave em tempo de execução para saber se o salvamento completo terá suporte sem fechar e descartar o OpenXmlPackagearquivo .

(Herdado de OpenXmlPackage)
SaveAs(String)
Obsoleto.

Salva o conteúdo de todas as partes e relacionamentos contidos no pacote OpenXml no arquivo especificado. Abre o documento salvo usando as mesmas configurações usadas para abrir este pacote OpenXml.

(Herdado de OpenXmlPackage)
ThrowIfObjectDisposed()

Lançada se um objeto for descartado.

(Herdado de OpenXmlPackage)
ToFlatOpcDocument()

Converte um pacote OpenXml em formato OPC em formato XDocument OPC plano.

ToFlatOpcDocument(XProcessingInstruction)

Converte um pacote OpenXml em formato OPC em formato XDocument OPC plano.

(Herdado de OpenXmlPackage)
ToFlatOpcString()

Converte um pacote OpenXml no formato OPC em cadeia de caracteres no formato OPC simples.

(Herdado de OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)

Tente obter a parte filho pela ID da relação.

(Herdado de OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)
Obsoleto.

Valida o pacote. Esse método não valida o conteúdo XML em cada parte.

(Herdado de OpenXmlPackage)

Métodos de Extensão

Nome Description
AddDisposableFeature(OpenXmlPackage)

Define WordprocessingDocument - um OpenXmlPackage representa um documento do Word.

AddPackageEventsFeature(OpenXmlPackage)

Adiciona um recurso para acompanhar eventos de ciclo de vida de um pacote.

AddParagraphIdFeature(WordprocessingDocument, ParagraphIdOptions)

Adicione o recurso de ID de parágrafo se ainda não estiver registrado.

AddParagraphIdGeneratorFeature(WordprocessingDocument)

Adiciona uma IParagraphIdGeneratorFeature se ainda não estiver disponível.

AddPartEventsFeature(OpenXmlPackage)

Adiciona um recurso para rastrear eventos para um pacote de criação ou remoção de peças.

AddPartRootEventsFeature(OpenXmlPartContainer)

Adiciona um recurso para rastrear eventos de ciclo de vida de pacotes.

AddRandomNumberGeneratorFeature(OpenXmlPackage)

Adicione um gerador de números aleatórios ao pacote.

AddSharedParagraphIdFeature(WordprocessingDocument)

Registra um documento para uma coleção compartilhada de ID de parágrafo.

CreateUnknownElement(OpenXmlPartContainer, String)

Cria uma nova classe OpenXmlUnknownElement usando o XML externo.

GetAllParts(OpenXmlPackage)

Percorra as OpenXmlPackage peças na largura-primeiro.

GetPackage(OpenXmlPackage)

Obtém a corrente IPackage para o package.

ToFlatOpcDocument(OpenXmlPackage)

Converte um pacote OpenXml em formato OPC em formato XDocument OPC plano.

ToFlatOpcString(OpenXmlPackage)

Converte um pacote OpenXml no formato OPC em cadeia de caracteres no formato OPC simples.

Aplica-se a