Удалить часть документа из пакета
В этом разделе показано, как программно удалить часть документа (файл) из документа Wordprocessing с помощью классов в пакете 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.
Элемент Settings
В следующем тексте из спецификации ISO/IEC 29500 представлен элемент settings в пакете PresentationML
.
Этот элемент задает параметры, применяемые к документу WordprocessingML. Этот элемент является корневым элементом части "Параметры документа" в документе WordprocessingML.
Пример. Рассмотрим следующий фрагмент WordprocessingML для части параметров документа:
<w:settings>
<w:defaultTabStop w:val="720" />
<w:characterSpacingControl w:val="dontCompress" />
</w:settings>
Элемент settings включает в себя все параметры этого документа. В данном случае применяются два параметра: автоматическое приращение позиции табуляции на 0,5 дюйма с использованием элемента defaultTabStop и отсутствие сжатия пробелов на уровне символов с использованием элемента characterSpacingControl.
© ISO/IEC 29500: 2016
Механизм работы примера кода
После открытия документа в инструкции using
в качестве WordprocessingDocument объекта создается ссылка на DocumentSettingsPart
часть.
Можно проверить, существует ли эта часть, и, если она существует, можно удалить ее из пакета. В этом случае settings.xml
часть удаляется из пакета.
MainDocumentPart? mainPart = wordDoc.MainDocumentPart;
if (mainPart is not null && mainPart.DocumentSettingsPart is not null)
{
mainPart.DeletePart(mainPart.DocumentSettingsPart);
}
Пример кода
Ниже приведен полный пример кода на языках C# и Visual Basic.
// To remove a document part from a package.
static void RemovePart(string document)
{
using (WordprocessingDocument wordDoc = WordprocessingDocument.Open(document, true))
{
MainDocumentPart? mainPart = wordDoc.MainDocumentPart;
if (mainPart is not null && mainPart.DocumentSettingsPart is not null)
{
mainPart.DeletePart(mainPart.DocumentSettingsPart);
}
}
}