Добавить новую часть документа в пакет
В этом разделе показано, как использовать классы в пакете SDK Open XML для Office для программного добавления части документа (файла) в текстовый документ.
Пакеты и части документов
Документ Open XML хранится в виде пакета, формат которого определяется стандартом ISO/IEC 29500. Пакет может содержать несколько частей, между которыми существуют связи. Связь между частями определяет категорию документа. Документ может быть определен как текстовый, если его элемент связи пакета содержит связь с основной частью документа. Если элемент связи пакета содержит связь с частью презентации, документ может быть определен как документ презентации. Если элемент связи пакета содержит связь с частью книги, документ определяется как электронная таблица. В данном практическом руководстве рассматривается пакет текстового документа.
Получение объекта WordprocessingDocument
Код начинается с открытия файла пакета, передав имя файла одному из перегруженных OpenWordprocessingDocument методов объекта , который принимает строку и логическое значение, указывающее, следует ли открыть файл для редактирования или для доступа только для чтения. В этом случае логическое значение true
указывает, что файл должен быть открыт в режиме чтения и записи.
using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))
В версии 3.0.0+ Close() метод был удален в пользу использования инструкции using.
Это гарантирует, что Dispose() метод автоматически вызывается при достижении закрывающей фигурной скобки. Блок, следующий за инструкцией using, создает область для объекта, создаваемого или именуемого в инструкции using.
WordprocessingDocument Так как класс в пакете SDK open XML автоматически сохраняет и закрывает объект в рамках его IDisposable реализации, а так как Dispose() вызывается автоматически при выходе из блока, не нужно явно вызывать Save() или Dispose() до тех пор, пока вы используете инструкцию using
.
Структура документа WordProcessingML
Базовая структура WordProcessingML
документа состоит из document
элементов и body
, за которыми следует один или несколько элементов уровня блока, таких как p
, который представляет абзац. Абзац содержит один или несколько r
элементов. Представляет r
собой область текста с общим набором свойств, таких как форматирование. Выполнение содержит один или несколько t
элементов. Элемент t
содержит диапазон текста. В следующем примере кода показана разметка WordprocessingML
для документа, содержащего текст "Пример текста".
<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
<w:body>
<w:p>
<w:r>
<w:t>Example text.</w:t>
</w:r>
</w:p>
</w:body>
</w:document>
С помощью пакета SDK Open XML можно создавать структуру документа и содержимое с помощью строго типизированных классов, соответствующих WordprocessingML
элементам. Эти классы находятся в пространстве имен. В следующей таблице перечислены имена классов, которые соответствуют document
элементам , body
, p
, r
и t
.
Элемент WordprocessingML | Класс пакета SDK Open XML | Описание |
---|---|---|
<document/> |
Document | Корневой элемент основной части документа. |
<body/> |
Body | Контейнер для структур уровня блокировки, таких как абзацы, таблицы, примечания и других элементов, описанных в спецификации ISO/IEC 29500. |
<p/> |
Paragraph | Абзац. |
<r/> |
Run | Прогон. |
<t/> |
Text | Диапазон текста. |
Дополнительные сведения об общей структуре частей и элементов документа WordprocessingML см. в разделе Структура документа WordprocessingML.
Принцип работы примера кода
После открытия документа для редактирования в инструкции using
в качестве WordprocessingDocument объекта код создает ссылку на MainDocumentPart
часть и добавляет новую настраиваемую XML-часть. Затем он считывает содержимое внешнего файла, содержащего пользовательский XML-код, и записывает его в CustomXmlPart
часть.
Примечание.
Чтобы использовать новую часть документа добавьте ссылку на часть документа в части связи.
MainDocumentPart mainPart = wordDoc.MainDocumentPart ?? wordDoc.AddMainDocumentPart();
CustomXmlPart myXmlPart = mainPart.AddCustomXmlPart(CustomXmlPartType.CustomXml);
using (FileStream stream = new FileStream(fileName, FileMode.Open))
{
myXmlPart.FeedData(stream);
}
Пример кода
В следующем коде добавляется новая часть документа, которая содержит XML из внешнего файла, а затем эта часть заполняется. Чтобы вызвать метод в программе AddCustomXmlPart
, используйте следующий пример, который изменяет файл, добавляя в него новую часть документа.
string document = args[0];
string fileName = args[1];
AddNewPart(args[0], args[1]);
Примечание.
Перед запуском программы измените расширение файла Word с .docx на .zip и просмотрите содержимое ZIP-файла. Затем снова измените расширение на .docx и запустите программу. После запуска программы снова измените расширение файла, чтобы .zip и просмотреть его содержимое. Вы увидите дополнительную папку с именем customXML. Эта папка содержит XML-файл, представляющий добавленную часть
Ниже приведен полный пример кода на языках C# и Visual Basic.
static void AddNewPart(string document, string fileName)
{
using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))
{
MainDocumentPart mainPart = wordDoc.MainDocumentPart ?? wordDoc.AddMainDocumentPart();
CustomXmlPart myXmlPart = mainPart.AddCustomXmlPart(CustomXmlPartType.CustomXml);
using (FileStream stream = new FileStream(fileName, FileMode.Open))
{
myXmlPart.FeedData(stream);
}
}
}