WordprocessingDocument Класс

Определение

Пространство имен:

DocumentFormat.OpenXml.Packaging

Сборка:

DocumentFormat.OpenXml.dll

Пакет:

DocumentFormat.OpenXml v3.0.1

Определяет WordprocessingDocument — OpenXmlPackage представляет документ Word.

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)

Наследование

Object

OpenXmlPartContainer

OpenXmlPackage

WordprocessingDocument

Реализации

ISupportedRelationship<MainDocumentPart> ISupportedRelationship<ThumbnailPart>

Примеры

В следующем примере показано, как применить стиль "Заголовок3" к первому абзацу в существующем текстовом документе. Чтобы запустить пример кода, создайте текстовый файл и напишите в нем текст. После выполнения примера кода изучите текст в файле. Вы заметили, что стиль первого абзаца изменен на "Заголовок3".

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  

Свойства

AutoSave	Возвращает значение, указывающее, следует ли сохранять части при удалении. (Унаследовано от OpenXmlPackage)
CompressionOption	Возвращает или задает уровень сжатия для содержимого новой части. (Унаследовано от OpenXmlPackage)
CoreFilePropertiesPart	Возвращает элемент CoreFilePropertiesPart объекта WordprocessingDocument.
CustomFilePropertiesPart	Возвращает элемент CustomFilePropertiesPart объекта WordprocessingDocument.
DataPartReferenceRelationships	Возвращает все DataPartReferenceRelationship связи. (Унаследовано от OpenXmlPartContainer)
DataParts	Возвращает все DataPart части в пакете документа. (Унаследовано от OpenXmlPackage)
DigitalSignatureOriginPart	Возвращает digitalSignatureOriginPart объекта WordprocessingDocument.
DocumentType	Возвращает тип объекта WordprocessingDocument.
ExtendedFilePropertiesPart	Возвращает extendedFilePropertiesPart объекта WordprocessingDocument.
ExternalRelationships	Возвращает все внешние связи. Связи гиперссылки не включаются. Используйте свойство HyperlinkRelationship для перечисления связей гиперссылки. (Унаследовано от OpenXmlPartContainer)
Features	Возвращает функции, связанные с этой частью.
FileOpenAccess	Возвращает параметр FileAccess для документа. Текущие параметры доступа для операций ввода-вывода: Чтение, Запись или ReadWrite. (Унаследовано от OpenXmlPackage)
HyperlinkRelationships	Возвращает все связи гиперссылок. (Унаследовано от OpenXmlPartContainer)
LabelInfoPart	Возвращает элемент LabelInfoPart объекта WordprocessingDocument, доступный только в Office2021.
MainDocumentPart	Возвращает mainDocumentPart объекта WordprocessingDocument.
MarkupCompatibilityProcessSettings	Возвращает параметры совместимости разметки, применяемые во время загрузки. (Унаследовано от OpenXmlPackage)
MaxCharactersInPart	Возвращает значение, указывающее максимально допустимое количество символов в части Open XML. Нулевое значение (0) указывает на отсутствие ограничений на размер части. Значение, отличное от нуля, указывает максимальный размер в символах. (Унаследовано от OpenXmlPackage)
Package	Возвращает пакет документа. (Унаследовано от OpenXmlPackage)
PackageProperties	Возвращает свойства пакета. (Унаследовано от OpenXmlPackage)
PartExtensionProvider	Возвращает часть PartExtensionProvider, которая обеспечивает сопоставление между ContentType и расширением части. (Унаследовано от OpenXmlPackage)
Parts	Возвращает все части, являющиеся целевыми объектами связи этой части. (Унаследовано от OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart	Возвращает элемент QuickAccessToolbarCustomizationsPart объекта WordprocessingDocument.
RibbonAndBackstageCustomizationsPart	Возвращает элемент RibbonAndBackstageCustomizationsPart объекта WordprocessingDocument, доступный только в Office2010.
RibbonExtensibilityPart	Возвращает элемент RibbonExtensibilityPart объекта WordprocessingDocument.
RootPart	Возвращает корневую часть пакета. (Унаследовано от OpenXmlPackage)
StrictRelationshipFound	Возвращает значение, указывающее, содержит ли этот пакет переходные связи, преобразованные из Strict. (Унаследовано от OpenXmlPackage)
ThumbnailPart	Возвращает элемент ThumbnailPart объекта WordprocessingDocument.
WebExTaskpanesPart	Возвращает элемент WebExTaskpanesPart объекта WordprocessingDocument, доступный только в Office2013.

Методы

AddAnnotation(Object)	Добавляет объект в список заметок этого PartContainer. (Унаследовано от OpenXmlPartContainer)
AddCoreFilePropertiesPart()	Добавляет coreFilePropertiesPart в Объект WordprocessingDocument.
AddCustomFilePropertiesPart()	Добавляет элемент CustomFilePropertiesPart в объект WordprocessingDocument.
AddDigitalSignatureOriginPart()	Добавляет DigitalSignatureOriginPart в Объект WordprocessingDocument.
AddExtendedFilePropertiesPart()	Добавляет extendedFilePropertiesPart в Объект WordprocessingDocument.
AddExtendedPart(String, String, String)	Добавляет расширенную часть ( часть для конкретного приложения ). (Унаследовано от OpenXmlPartContainer)
AddExtendedPart(String, String, String, String)	Добавляет расширенную часть ( часть для конкретного приложения ). (Унаследовано от OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	Добавляет внешнюю связь. Не добавляйте связи гиперссылки с помощью этого метода. Вместо этого используйте AddHyperlinkRelationship(). (Унаследовано от OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	Добавляет внешнюю связь. Не добавляйте связи гиперссылки с помощью этого метода. Вместо этого используйте AddHyperlinkRelationship(). (Унаследовано от OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	Добавляет новое отношение гиперссылки. (Унаследовано от OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	Добавляет новое отношение гиперссылки. (Унаследовано от OpenXmlPartContainer)
AddLabelInfoPart()	Добавляет labelInfoPart в WordprocessingDocument. Эта часть доступна только в Office2021.
AddMainDocumentPart()	Создает MainDocumentPart и добавляет его в этот документ.
AddNewPart<T>()	Добавляет новую часть типа T. (Унаследовано от OpenXmlPartContainer)
AddNewPart<T>(String)	Добавляет новую часть типа T. (Унаследовано от OpenXmlPartContainer)
AddNewPart<T>(String, String)	Добавляет новую часть типа T.
AddPart<T>(T)	Добавляет указанную часть в документ. Используйте возвращаемую часть для работы с частью, добавленной в документ. (Унаследовано от OpenXmlPackage)
AddPart<T>(T, String)	Добавляет часть в документ с заданным идентификатором связи (ID). Должен использовать возвращаемую часть для работы с частью, добавленной в документ (Унаследовано от OpenXmlPartContainer)
AddQuickAccessToolbarCustomizationsPart()	Добавляет quickAccessToolbarCustomizationsPart в Объект WordprocessingDocument.
AddRibbonAndBackstageCustomizationsPart()	Добавляет элемент RibbonAndBackstageCustomizationsPart в Объект WordprocessingDocument. Эта часть доступна только в Office2010.
AddRibbonExtensibilityPart()	Добавляет элемент RibbonExtensibilityPart в объект WordprocessingDocument.
AddWebExTaskpanesPart()	Добавляет элемент WebExTaskpanesPart в WordprocessingDocument. Эта часть доступна только в Office2013.
Annotation(Type)	Получите первый объект заметки указанного типа из этого объекта PartContainer. (Унаследовано от OpenXmlPartContainer)
Annotation<T>()	Получите первый объект заметки указанного типа из этого объекта PartContainer. (Унаследовано от OpenXmlPartContainer)
Annotations(Type)	Возвращает коллекцию заметок указанного типа для этого PartContainer. (Унаследовано от OpenXmlPartContainer)
Annotations<T>()	Возвращает коллекцию заметок указанного типа для этого PartContainer. (Унаследовано от OpenXmlPartContainer)
ChangeDocumentType(WordprocessingDocumentType)	Изменяет тип документа.
ChangeIdOfPart(OpenXmlPart, String)	Изменяет идентификатор отношения части. (Унаследовано от OpenXmlPartContainer)
Clone()	Создает редактируемый клон этого пакета OpenXml, открытый в с расширяемой MemoryStream емкостью и использующий OpenSettings по умолчанию. (Унаследовано от OpenXmlPackage)
Clone(Package)	Создает клон этого пакета OpenXml, открытого в указанном экземпляре Package. Клон будет открыт с помощью того же openSettings, что и этот пакет OpenXml. (Унаследовано от OpenXmlPackage)
Clone(Package, OpenSettings)	Создает клон этого пакета OpenXml, открытого в указанном экземпляре Package. (Унаследовано от OpenXmlPackage)
Clone(Stream)	Создает клон этого пакета OpenXml, открытого в заданном потоке. Клонированные пакеты OpenXml открываются с теми же параметрами, например FileOpenAccess и OpenSettings, что и этот пакет OpenXml. (Унаследовано от OpenXmlPackage)
Clone(Stream, Boolean)	Создает клон этого пакета OpenXml, открытого в заданном потоке. Клонированные пакеты OpenXml открываются с помощью того же openSettings, что и этот пакет OpenXml. (Унаследовано от OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)	Создает клон этого пакета OpenXml, открытого в заданном потоке. (Унаследовано от OpenXmlPackage)
Clone(String)	Создает клон этого пакета OpenXml, открытого из заданного файла (который будет создан путем клонирования этого пакета OpenXml). Клонированные пакеты OpenXml открываются с теми же параметрами, например FileOpenAccess и OpenSettings, что и этот пакет OpenXml. (Унаследовано от OpenXmlPackage)
Clone(String, Boolean)	Создает клон этого пакета OpenXml, открытого из заданного файла (который будет создан путем клонирования этого пакета OpenXml). Клонированные пакеты OpenXml открываются с помощью того же openSettings, что и этот пакет OpenXml. (Унаследовано от OpenXmlPackage)
Clone(String, Boolean, OpenSettings)	Создает клон этого пакета OpenXml, открытого из заданного файла (который будет создан путем клонирования этого пакета OpenXml). (Унаследовано от OpenXmlPackage)
Close()	Сохраняет и закрывает пакет OpenXml и все потоки базовых частей. (Унаследовано от OpenXmlPackage)
Create(Package, WordprocessingDocumentType)	Создает новый экземпляр класса WordprocessingDocument из указанного пакета.
Create(Package, WordprocessingDocumentType, Boolean)	Создает новый экземпляр класса WordprocessingDocument из указанного пакета.
Create(Stream, WordprocessingDocumentType)	Создает новый экземпляр класса WordprocessingDocument из потока ввода-вывода.
Create(Stream, WordprocessingDocumentType, Boolean)	Создает новый экземпляр класса WordprocessingDocument из потока ввода-вывода.
Create(String, WordprocessingDocumentType)	Создает новый экземпляр класса WordprocessingDocument из указанного файла.
Create(String, WordprocessingDocumentType, Boolean)	Создает новый экземпляр класса WordprocessingDocument из указанного файла.
CreateClone(Package)	Создает новый экземпляр OpenXmlPackage в указанном экземпляре Package. (Унаследовано от OpenXmlPackage)
CreateClone(Stream)	Создает новый openXmlPackage в заданном потоке. (Унаследовано от OpenXmlPackage)
CreateClone(String)	Создает новый пакет OpenXml для заданного файла. (Унаследовано от OpenXmlPackage)
CreateFromTemplate(String)	Создает редактируемый объект WordprocessingDocument из шаблона, открытого в MemoryStream с расширяемой емкостью. Шаблон будет присоединен к объекту WordprocessingDocument.
CreateFromTemplate(String, Boolean)	Создает редактируемый объект WordprocessingDocument из шаблона, открытого в MemoryStream с расширяемой емкостью.
CreateMediaDataPart(MediaDataPartType)	Создает новую MediaDataPart часть в пакете документа. (Унаследовано от OpenXmlPackage)
CreateMediaDataPart(String)	Создает новую MediaDataPart часть в пакете документа. (Унаследовано от OpenXmlPackage)
CreateMediaDataPart(String, String)	Создает новую MediaDataPart часть в пакете документа. (Унаследовано от OpenXmlPackage)
CreateRelationshipToPart(OpenXmlPart)	Добавляет в эту часть связь для указанной части. (Унаследовано от OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart, String)	Добавляет в эту часть связь для указанной части. (Унаследовано от OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	Удаляет указанную внешнюю связь. (Унаследовано от OpenXmlPartContainer)
DeleteExternalRelationship(String)	Удаляет указанный объект ExternalRelationship. (Унаследовано от OpenXmlPartContainer)
DeletePart(DataPart)	Удаляет указанный DataPart объект из пакета документа. (Унаследовано от OpenXmlPackage)
DeletePart(OpenXmlPart)	Удаляет указанную часть корневого слоя пакета. (Унаследовано от OpenXmlPartContainer)
DeletePart(String)	Удаляет указанную дочернюю часть из этой части. (Унаследовано от OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	Удаляет из документа все части, которые находятся в переданной коллекции. (Унаследовано от OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()	Рекурсивно удаляет из пакета все части с указанным типом. (Унаследовано от OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)	Удаляет указанную ссылку. (Унаследовано от OpenXmlPartContainer)
DeleteReferenceRelationship(String)	Удаляет указанную ссылку. (Унаследовано от OpenXmlPartContainer)
Dispose()	Очищает и сохраняет содержимое, закрывает документ и освобождает все ресурсы. (Унаследовано от OpenXmlPackage)
Dispose(Boolean)	Очищает и сохраняет содержимое, закрывает документ и освобождает все ресурсы. (Унаследовано от OpenXmlPackage)
FromFlatOpcDocument(XDocument)	Создает новый редактируемый экземпляр WordprocessingDocument из XDocument в формате неструктурированного OPC, открытого MemoryStreamв .
FromFlatOpcDocument(XDocument, Package)	Создает экземпляр WordprocessingDocument на основе XDocument в формате неструктурированного OPC.
FromFlatOpcDocument(XDocument, Stream, Boolean)	Создает экземпляр WordprocessingDocument на основе XDocument в формате неструктурированного OPC.
FromFlatOpcDocument(XDocument, String, Boolean)	Создает экземпляр WordprocessingDocument на основе XDocument в формате неструктурированного OPC.
FromFlatOpcString(String)	Создает новый экземпляр WordprocessingDocument из строки в формате неструктурированного OPC в MemoryStream с расширяемой емкостью.
FromFlatOpcString(String, Package)	Создает экземпляр WordprocessingDocument из строки в формате Неструктурированного OPC.
FromFlatOpcString(String, Stream, Boolean)	Создает экземпляр WordprocessingDocument из строки в формате Неструктурированного OPC в
FromFlatOpcString(String, String, Boolean)	Создает экземпляр WordprocessingDocument из строки в формате Неструктурированного OPC.
GetExternalRelationship(String)	Возвращает указанное значение ExternalRelationship. (Унаследовано от OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	Возвращает идентификатор отношения части. (Унаследовано от OpenXmlPartContainer)
GetPartById(String)	Получает дочернюю часть через идентификатор связи. (Унаследовано от OpenXmlPartContainer)
GetPartsCountOfType<T>()	Возвращает количество всех частей типа T. (Унаследовано от OpenXmlPartContainer)
GetPartsOfType<T>()	Перечисляет все дочерние части указанного типа T этой части. (Унаследовано от OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	Возвращает все дочерние части указанного типа T в partCollection эту часть. (Унаследовано от OpenXmlPartContainer)
GetReferenceRelationship(String)	Возвращает указанный объект ReferenceRelationship. (Унаследовано от OpenXmlPartContainer)
Open(Package)	Создает новый экземпляр класса WordprocessingDocument из указанного пакета.
Open(Package, OpenSettings)	Создает новый экземпляр класса WordprocessingDocument из указанного пакета.
Open(Stream, Boolean)	Создает новый экземпляр класса WordprocessingDocument из потока ввода-вывода.
Open(Stream, Boolean, OpenSettings)	Создает новый экземпляр класса WordprocessingDocument из потока ввода-вывода.
Open(String, Boolean)	Создает новый экземпляр класса WordprocessingDocument из указанного файла.
Open(String, Boolean, OpenSettings)	Создает новый экземпляр класса WordprocessingDocument из указанного файла.
OpenClone(Stream, Boolean, OpenSettings)	Открывает клонированные пакеты OpenXml в заданном потоке. (Унаследовано от OpenXmlPackage)
OpenClone(String, Boolean, OpenSettings)	Открывает клонированные пакеты OpenXml в заданном файле. (Унаследовано от OpenXmlPackage)
RemoveAnnotations(Type)	Удаляет заметки указанного типа из этого PartContainer. (Унаследовано от OpenXmlPartContainer)
RemoveAnnotations<T>()	Удаляет заметки указанного типа из этого PartContainer. (Унаследовано от OpenXmlPartContainer)
Save()	Сохраняет содержимое всех частей и связей, содержащихся в пакете OpenXml, если FileOpenAccess имеет значение ReadWrite. Некоторые платформы не поддерживают сохранение из-за ограничений в Package, поэтому запросите CanSave во время выполнения, чтобы узнать, будет ли поддерживаться полное сохранение без закрытия и удаления OpenXmlPackage. (Унаследовано от OpenXmlPackage)
SaveAs(String)	Сохраняет содержимое всех частей и связей, содержащихся в пакете OpenXml, в указанный файл. Открывает сохраненный документ, используя те же параметры, которые использовались для открытия этого пакета OpenXml. (Унаследовано от OpenXmlPackage)
ThrowIfObjectDisposed()	Возникает, если объект удален. (Унаследовано от OpenXmlPackage)
ToFlatOpcDocument()	Преобразует пакет OpenXml в формате OPC в неструктурированном XDocument формате OPC. (Унаследовано от OpenXmlPackage)
ToFlatOpcDocument(XProcessingInstruction)	Преобразует пакет OpenXml в формате OPC в неструктурированном XDocument формате OPC. (Унаследовано от OpenXmlPackage)
ToFlatOpcString()	Преобразует пакет OpenXml в формате OPC в строку в формате неструктурированного OPC. (Унаследовано от OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)	Попробуйте получить часть дочернего элемента по идентификатору связи. (Унаследовано от OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)	Проверяет пакет. Этот метод не проверяет XML-содержимое в каждой части. (Унаследовано от OpenXmlPackage)

Методы расширения

GetPackage(OpenXmlPackage)	Возвращает текущий для IPackagepackage.
AddPackageEventsFeature(OpenXmlPackage)	Добавляет функцию для отслеживания событий жизненного цикла пакета.
AddParagraphIdFeature(WordprocessingDocument, ParagraphIdOptions)	Добавьте функцию идентификатора абзаца, если она еще не зарегистрирована.
AddParagraphIdGeneratorFeature(WordprocessingDocument)	Добавляет , IParagraphIdGeneratorFeature если он еще недоступен.
AddPartEventsFeature(OpenXmlPackage)	Добавляет функцию для отслеживания событий пакета, создающего или удаляющего части.
AddPartRootEventsFeature(OpenXmlPartContainer)	Добавляет функцию для отслеживания событий жизненного цикла пакета.
AddRandomNumberGeneratorFeature(OpenXmlPackage)	Добавьте генератор случайных чисел в пакет.
AddSharedParagraphIdFeature(WordprocessingDocument)	Регистрирует документ для коллекции идентификаторов общего абзаца.
CreateUnknownElement(OpenXmlPartContainer, String)	Создает класс OpenXmlUnknownElement с помощью внешнего XML-кода.
ToFlatOpcDocument(OpenXmlPackage)	Преобразует пакет OpenXml в формате OPC в неструктурированном XDocument формате OPC.
ToFlatOpcString(OpenXmlPackage)	Преобразует пакет OpenXml в формате OPC в строку в формате неструктурированного OPC.
GetAllParts(OpenXmlPackage)	Обход частей в ширину OpenXmlPackage по ширине.