WordprocessingDocument Classe

Definição

Namespace:

DocumentFormat.OpenXml.Packaging

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Define o WordprocessingDocument – um OpenXmlPackage representa um Word documento.

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
    interface ISupportedRelationship<MainDocumentPart>
    interface ISupportedRelationship<ThumbnailPart>

Public Class WordprocessingDocument
Inherits OpenXmlPackage
Implements ISupportedRelationship(Of MainDocumentPart), ISupportedRelationship(Of ThumbnailPart)

Herança

Object

OpenXmlPartContainer

OpenXmlPackage

WordprocessingDocument

Implementações

ISupportedRelationship<MainDocumentPart> ISupportedRelationship<ThumbnailPart>

Exemplos

O exemplo seguinte mostra como aplicar o estilo "Cabeçalho3" ao primeiro parágrafo num documento de processamento de palavras existente. Para executar o exemplo de código, crie um ficheiro de processamento de palavras e escreva algum texto no mesmo. Depois de executar o exemplo de código, examine o texto no ficheiro. Notaria que o estilo do primeiro parágrafo foi alterado para "Cabeçalho3".

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  

Propriedades

AutoSave	Obtém um valor que indica se as partes devem ser guardadas quando eliminadas. (Herdado de OpenXmlPackage)
CompressionOption	Obtém ou define o nível de compressã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 DataPart partes no pacote de 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. As relações de hiperligação não estão incluídas, utilize a propriedade HyperlinkRelationship para enumerar relações de hiperligação. (Herdado de OpenXmlPartContainer)
Features	Obtém as funcionalidades associadas a esta parte.
FileOpenAccess	Obtém a definição FileAccess para o documento. As definições de acesso de E/S atuais são: Leitura, Escrita ou Escrita. (Herdado de OpenXmlPackage)
HyperlinkRelationships	Obtém todas as relações de hiperligação. (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 definições de compatibilidade de markup aplicadas no tempo de carregamento. (Herdado de OpenXmlPackage)
MaxCharactersInPart	Obtém um valor que indica o número máximo permitido de carateres numa peça Open XML. Um valor zero (0) indica que não existem limites no tamanho da peça. Um valor diferente de zero especifica o tamanho máximo, em carateres. (Herdado de OpenXmlPackage)
Package	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 uma extensão de parte. (Herdado de OpenXmlPackage)
Parts	Obtém todas as partes que são destinos de relação desta parte. (Herdado de OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart	Obtém o QuickAccessToolbarCustomizationsPart do WordprocessingDocument.
RibbonAndBackstageCustomizationsPart	Obtém o RibbonAndBackstageCustomizationsPart do WordprocessingDocument, apenas disponível no Office2010.
RibbonExtensibilityPart	Obtém o RibbonExtensibilityPart do WordprocessingDocument.
RootPart	Obtém a parte raiz do pacote. (Herdado de OpenXmlPackage)
StrictRelationshipFound	Obtém um valor que indica se este pacote contém relações transitórias convertidas de Estrita. (Herdado de OpenXmlPackage)
ThumbnailPart	Obtém a ThumbnailPart do WordprocessingDocument.
WebExTaskpanesPart	Obtém o WebExTaskpanesPart do WordprocessingDocument, apenas disponível no Office2013.

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotação 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 expandida (parte específica da aplicação ). (Herdado de OpenXmlPartContainer)
AddExtendedPart(String, String, String)	Adiciona uma parte expandida (parte específica da aplicação ). (Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	Adiciona uma relação externa. Não adicione relações de hiperligação através deste método. Em alternativa, utilize AddHyperlinkRelationship(). (Herdado de OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	Adiciona uma relação externa. Não adicione relações de hiperligação através deste método. Em alternativa, utilize AddHyperlinkRelationship(). (Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	Adiciona uma nova relação de hiperligação. (Herdado de OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	Adiciona uma nova relação de hiperligação. (Herdado de OpenXmlPartContainer)
AddLabelInfoPart()	Adiciona uma LabelInfoPart ao WordprocessingDocument. Esta parte só está disponível no Office2021.
AddMainDocumentPart()	Cria a MainDocumentPart e adiciona-a 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). Tem de utilizar a parte devolvida para operar na parte adicionada ao documento (Herdado de OpenXmlPartContainer)
AddPart<T>(T)	Adiciona a parte especificada ao documento. Utilize a parte devolvida para operar na parte adicionada ao documento. (Herdado de OpenXmlPackage)
AddQuickAccessToolbarCustomizationsPart()	Adiciona uma QuickAccessToolbarCustomizationsPart ao WordprocessingDocument.
AddRibbonAndBackstageCustomizationsPart()	Adiciona um RibbonAndBackstageCustomizationsPart ao WordprocessingDocument. Esta parte só está disponível no Office2010.
AddRibbonExtensibilityPart()	Adiciona uma RibbonExtensibilityPart ao WordprocessingDocument.
AddWebExTaskpanesPart()	Adiciona uma Peça WebExTaskpanes ao WordprocessingDocument. Esta parte só está disponível no Office2013.
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado a partir deste PartContainer. (Herdado de OpenXmlPartContainer)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado a partir 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 o ID da relação da peça. (Herdado de OpenXmlPartContainer)
Clone()	Cria um clone editável deste pacote OpenXml, aberto numa MemoryStream capacidade expansível e com OpenSettings predefinido. (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 as mesmas OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)	Cria um clone deste pacote OpenXml, aberto no fluxo especificado. (Herdado de OpenXmlPackage)
Clone(Stream, Boolean)	Cria um clone deste pacote OpenXml, aberto no fluxo especificado. O pacote OpenXml clonado é aberto com as mesmas OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(Stream)	Cria um clone deste pacote OpenXml, aberto no fluxo especificado. O pacote OpenXml clonado é aberto com as mesmas definiçõ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 ficheiro especificado (que será criado através da clonagem deste pacote OpenXml). (Herdado de OpenXmlPackage)
Clone(String, Boolean)	Cria um clone deste pacote OpenXml aberto a partir do ficheiro especificado (que será criado através da clonagem deste pacote OpenXml). O pacote OpenXml clonado é aberto com as mesmas OpenSettings que este pacote OpenXml. (Herdado de OpenXmlPackage)
Clone(String)	Cria um clone deste pacote OpenXml aberto a partir do ficheiro especificado (que será criado através da clonagem deste pacote OpenXml). O pacote OpenXml clonado é aberto com as mesmas definições, ou seja, FileOpenAccess e OpenSettings, que este pacote OpenXml. (Herdado de OpenXmlPackage)
Close()	Guarda e fecha o pacote OpenXml e todos os fluxos de peças subjacentes. (Herdado de OpenXmlPackage)
Create(Package, WordprocessingDocumentType, Boolean)	Cria uma nova instância da classe WordprocessingDocument a partir do pacote especificado.
Create(Package, WordprocessingDocumentType)	Cria uma nova instância da classe WordprocessingDocument a partir 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 a partir do ficheiro especificado.
Create(String, WordprocessingDocumentType)	Cria uma nova instância da classe WordprocessingDocument a partir do ficheiro especificado.
CreateClone(Package)	Cria uma nova instância de OpenXmlPackage na instância especificada do Pacote. (Herdado de OpenXmlPackage)
CreateClone(Stream)	Cria um novo OpenXmlPackage no fluxo especificado. (Herdado de OpenXmlPackage)
CreateClone(String)	Cria um novo pacote OpenXml no ficheiro especificado. (Herdado de OpenXmlPackage)
CreateFromTemplate(String, Boolean)	Cria um WordprocessingDocument editável a partir de um modelo, aberto num MemoryStream com capacidade expansível.
CreateFromTemplate(String)	Cria um WordprocessingDocument editável a partir de um modelo, aberto num 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 para a parte especificada a esta parte. (Herdado de OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart)	Adiciona uma relação para a parte especificada a esta parte. (Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	Elimina a relação externa especificada. (Herdado de OpenXmlPartContainer)
DeleteExternalRelationship(String)	Elimina o ExternalRelationship especificado. (Herdado de OpenXmlPartContainer)
DeletePart(DataPart)	Elimina o especificado DataPart do pacote de documentos. (Herdado de OpenXmlPackage)
DeletePart(OpenXmlPart)	Elimina uma parte especificada na camada raiz do pacote. (Herdado de OpenXmlPartContainer)
DeletePart(String)	Elimina a parte subordinada especificada desta parte. (Herdado de OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	Elimina todas as partes que estão na coleção transmitida do documento. (Herdado de OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()	Elimina todas as partes com o tipo de peça especificado do pacote de forma recursiva. (Herdado de OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)	Elimina a relação de referência especificada. (Herdado de OpenXmlPartContainer)
DeleteReferenceRelationship(String)	Elimina a relação de referência especificada. (Herdado de OpenXmlPartContainer)
Dispose()	Remove e guarda o conteúdo, fecha o documento e liberta todos os recursos. (Herdado de OpenXmlPackage)
Dispose(Boolean)	Remove e guarda o conteúdo, fecha o documento e liberta todos os recursos. (Herdado de OpenXmlPackage)
FromFlatOpcDocument(XDocument, Package)	Cria uma nova instância do WordprocessingDocument a partir de um XDocument formato OPC Plano.
FromFlatOpcDocument(XDocument, Stream, Boolean)	Cria uma nova instância do WordprocessingDocument a partir de um XDocument formato OPC Plano.
FromFlatOpcDocument(XDocument, String, Boolean)	Cria uma nova instância do WordprocessingDocument a partir de um XDocument formato OPC Plano.
FromFlatOpcDocument(XDocument)	Cria uma nova instância editável do WordprocessingDocument a partir de um XDocument formato OPC plano, aberto num MemoryStream.
FromFlatOpcString(String, Package)	Cria uma nova instância do WordprocessingDocument a partir de uma cadeia no formato OPC Plano.
FromFlatOpcString(String, Stream, Boolean)	Cria uma nova instância do WordprocessingDocument a partir de uma cadeia no formato OPC Plano num
FromFlatOpcString(String, String, Boolean)	Cria uma nova instância do WordprocessingDocument a partir de uma cadeia no formato OPC Plano.
FromFlatOpcString(String)	Cria uma nova instância do WordprocessingDocument a partir de uma cadeia no formato OPC Plano numa MemoryStream capacidade expansível.
GetExternalRelationship(String)	Obtém o ExternalRelationship especificado. (Herdado de OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	Obtém o ID de relação da peça. (Herdado de OpenXmlPartContainer)
GetPartById(String)	Obtém a parte subordinada através do ID da relação. (Herdado de OpenXmlPartContainer)
GetPartsCountOfType<T>()	Obtém a contagem de todas as partes do tipo T. (Herdado de OpenXmlPartContainer)
GetPartsOfType<T>()	Enumera todas as partes subordinadas do tipo T especificado desta peça. (Herdado de OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	Obtém todas as partes subordinadas do tipo TpartCollection especificado nesta parte. (Herdado de OpenXmlPartContainer)
GetReferenceRelationship(String)	Obtém a ReferenceRelationship especificada. (Herdado de OpenXmlPartContainer)
Open(Package, OpenSettings)	Cria uma nova instância da classe WordprocessingDocument a partir do pacote especificado.
Open(Package)	Cria uma nova instância da classe WordprocessingDocument a partir 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 a partir do ficheiro especificado.
Open(String, Boolean)	Cria uma nova instância da classe WordprocessingDocument a partir do ficheiro especificado.
OpenClone(Stream, Boolean, OpenSettings)	Abre o pacote OpenXml clonado no fluxo especificado. (Herdado de OpenXmlPackage)
OpenClone(String, Boolean, OpenSettings)	Abre o pacote OpenXml clonado no ficheiro especificado. (Herdado de OpenXmlPackage)
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()	Guarda o conteúdo de todas as partes e relações contidas no pacote OpenXml, se FileOpenAccess for ReadWrite. Algumas plataformas não suportam a gravação devido a limitações no Package, por isso, consulte CanSave no runtime para saber se a gravação completa será suportada sem fechar e eliminar o OpenXmlPackage. (Herdado de OpenXmlPackage)
SaveAs(String)	Guarda o conteúdo de todas as partes e relações contidas no pacote OpenXml no ficheiro especificado. Abre o documento guardado com as mesmas definições que foram utilizadas para abrir este pacote OpenXml. (Herdado de OpenXmlPackage)
ThrowIfObjectDisposed()	Acionado se um objeto for eliminado. (Herdado de OpenXmlPackage)
ToFlatOpcDocument()	Converte um pacote OpenXml no formato OPC num XDocument formato OPC Plano. (Herdado de OpenXmlPackage)
ToFlatOpcDocument(XProcessingInstruction)	Converte um pacote OpenXml no formato OPC num XDocument formato OPC Plano. (Herdado de OpenXmlPackage)
ToFlatOpcString()	Converte um pacote OpenXml no formato OPC em cadeia no formato OPC Plano. (Herdado de OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)	Tente obter a parte subordinada pelo ID da relação. (Herdado de OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)	Valida o pacote. Este método não valida o conteúdo XML em cada parte. (Herdado de OpenXmlPackage)

Métodos de Extensão

GetPackage(OpenXmlPackage)	Obtém a corrente IPackage para o package.
AddPackageEventsFeature(OpenXmlPackage)	Adiciona uma funcionalidade para controlar os eventos de um ciclo de vida de pacotes.
AddParagraphIdFeature(WordprocessingDocument, ParagraphIdOptions)	Adicione a funcionalidade ID de parágrafo, se ainda não estiver registada.
AddParagraphIdGeneratorFeature(WordprocessingDocument)	Adiciona um IParagraphIdGeneratorFeature se ainda não estiver disponível.
AddPartEventsFeature(OpenXmlPackage)	Adiciona uma funcionalidade para controlar os eventos de um pacote que cria ou remove peças.
AddPartRootEventsFeature(OpenXmlPartContainer)	Adiciona uma funcionalidade para controlar eventos para eventos do ciclo de vida do pacote.
AddRandomNumberGeneratorFeature(OpenXmlPackage)	Adicione um gerador de números aleatórios ao pacote.
AddSharedParagraphIdFeature(WordprocessingDocument)	Regista um documento para uma coleção de IDs de parágrafo partilhados.
CreateUnknownElement(OpenXmlPartContainer, String)	Cria uma nova classe OpenXmlUnknownElement com o XML externo.
ToFlatOpcDocument(OpenXmlPackage)	Converte um pacote OpenXml no formato OPC num XDocument formato OPC Plano.
ToFlatOpcString(OpenXmlPackage)	Converte um pacote OpenXml no formato OPC em cadeia no formato OPC Plano.
GetAllParts(OpenXmlPackage)	Percorram partes no OpenXmlPackage por amplitude-primeiro.