Document

Обзор

Document — это класс в Aspose.Words FOSS для .NET. Наследуется от: DocumentBase, ISectionAttrSource, IWatermarkProvider.

Конструкторы класса Document позволяют разработчикам создать новый пустой документ или загрузить существующий из пути к файлу, потока или с пользовательскими параметрами загрузки.

Этот класс предоставляет 63 метода для работы с объектами Document в программах .NET. Доступные методы включают: Accept, AcceptAllRevisions, AcceptEnd, AcceptStart, AppendChild, AppendDocument, Cleanup, Clone, CopyStylesFromTemplate, CreateNavigator, Document, EnsureMinimum и ещё 36 методов. Все публичные члены доступны любой .NET-приложению после установки пакета Aspose.Words FOSS для .NET. Свойства: AttachedTemplate, AutomaticallyUpdateStyles, BackgroundShape, Bibliography, BuiltInDocumentProperties, CompatibilityOptions и ещё 62.

Свойства

Имя:	Тип:	Доступ	Описание:
`AttachedTemplate`	`string`	Чтение/запись	Получает или задает полный путь к шаблону, присоединённому к документу.
`AutomaticallyUpdateStyles`	`bool`	Чтение/запись	Получает или задает флаг, указывающий, обновляются ли стили в документе, чтобы соответствовать стилям в присоединённом шаблоне каждый раз при открытии документа в MS Word.
`ShadeFormData`	`bool`	Чтение/запись	Указывает, включать ли серое затенение полей формы.
`TrackRevisions`	`bool`	Чтение/запись	True, если изменения отслеживаются при редактировании этого документа в Microsoft Word.
`ShowGrammaticalErrors`	`bool`	Чтение/запись	Указывает, отображать ли грамматические ошибки в этом документе.
`ShowSpellingErrors`	`bool`	Чтение/запись	Указывает, следует ли отображать орфографические ошибки в этом документе.
`SpellingChecked`	`bool`	Чтение/запись	Возвращает true, если документ был проверен на орфографию.
`GrammarChecked`	`bool`	Чтение/запись	Возвращает true, если документ был проверен на грамматику.
`PunctuationKerning`	`bool`	Чтение/запись	Указывает, применяется ли кернинг как к латинскому тексту, так и к пунктуации.
`NodeType`	`NodeType`	Чтение	Возвращает Document.
`BuiltInDocumentProperties`	`BuiltInDocumentProperties`	Чтение	Возвращает коллекцию, представляющую все встроенные свойства документа.
`WebExtensionTaskPanes`	`TaskPaneCollection`	Чтение	Возвращает коллекцию, представляющую список надстроек панели задач.
`CustomDocumentProperties`	`CustomDocumentProperties`	Чтение	Возвращает коллекцию, представляющую все пользовательские свойства документа.
`ProtectionType`	`ProtectionType`	Чтение	Получает текущий активный тип защиты документа.
`Sections`	`SectionCollection`	Чтение	Возвращает коллекцию, представляющую все разделы в документе.
`FirstSection`	`Section`	Чтение	Получает первый раздел в документе.
`LastSection`	`Section`	Чтение	Получает последний раздел в документе.
`ViewOptions`	`ViewOptions`	Чтение	Предоставляет параметры для управления тем, как документ отображается в Microsoft Word.
`WriteProtection`	`WriteProtection`	Чтение	Обеспечивает доступ к параметрам защиты документа от записи.
`CompatibilityOptions`	`CompatibilityOptions`	Чтение	Обеспечивает доступ к параметрам совместимости документа (то есть к пользовательским настройкам, указанным во вкладке «Совместимость» диалогового окна «Параметры» в Word).
`MailMergeSettings`	`MailMergeSettings`	Чтение/запись	Получает или задает объект, содержащий всю информацию слияния писем для документа.
`HyphenationOptions`	`HyphenationOptions`	Чтение	Обеспечивает доступ к настройкам переноса слов в документе.
`HasRevisions`	`bool`	Чтение	Возвращает true, если в документе есть какие-либо отслеживаемые изменения.
`HasMacros`	`bool`	Чтение	Возвращает true, если документ содержит проект VBA (макросы).
`Watermark`	`Watermark`	Чтение	Предоставляет доступ к водяному знаку документа.
`VersionsCount`	`int`	Чтение	Получает количество версий документа, которое было сохранено в документе DOC.
`DefaultTabStop`	`double`	Чтение/запись	Получает или задает интервал (в пунктах) между стандартными табуляторами.
`Theme`	`Theme`	Чтение	Получает объект `Theme` для этого документа.
`CustomXmlParts`	`CustomXmlPartCollection`	Чтение/запись	Получает или задает коллекцию пользовательских XML частей хранения данных.
`PackageCustomParts`	`CustomPartCollection`	Чтение/запись	Получает или задает коллекцию пользовательских частей (произвольного содержимого), которые связаны с пакетом OOXML с помощью “unknown relationships”.
`Variables`	`VariableCollection`	Чтение	Возвращает коллекцию переменных, добавленных в документ или шаблон.
`GlossaryDocument`	`GlossaryDocument`	Чтение/запись	Получает или задает документ глоссария внутри этого документа или шаблона.
`OriginalFileName`	`string`	Чтение	Получает исходное имя файла документа.
`OriginalLoadFormat`	`LoadFormat`	Чтение	Получает формат оригинального документа, загруженного в этот объект.
`Compliance`	`OoxmlCompliance`	Чтение	Получает версию соответствия OOXML, определённую из содержимого загруженного документа.
`DigitalSignatures`	`DigitalSignatureCollection`	Чтение	Получает коллекцию цифровых подписей для этого документа и их результаты проверки.
`FontSettings`	`FontSettings`	Чтение/запись	Получает или задает параметры шрифта документа.
`Bibliography`	`Bibliography.Bibliography`	Чтение	Получает объект Bibliography, представляющий список источников, доступных в документе.
`Frameset`	`Frameset`	Чтение	Возвращает экземпляр Frameset, если этот документ представляет страницу с фреймами.
`IncludeTextboxesFootnotesEndnotesInStat`	`bool`	Чтение/запись	Указывает, следует ли включать текстовые поля, сноски и концевые сноски в статистику подсчёта слов.
`Revisions`	`RevisionCollection`	Чтение	Получает коллекцию ревизий (отслеживаемых изменений), которые существуют в этом документе.
`RevisionsView`	`RevisionsView`	Чтение/запись	Получает или задает значение, указывающее, работать ли с оригинальной или исправленной версией документа.
`JustificationMode`	`JustificationMode`	Чтение/запись	Получает или задает настройку межсимвольного интервала документа.
`FootnoteOptions`	`FootnoteOptions`	Чтение	Предоставляет параметры, управляющие нумерацией и размещением сносок в этом документе.
`EndnoteOptions`	`EndnoteOptions`	Чтение	Предоставляет параметры, управляющие нумерацией и расположением сносок в этом документе.
`FieldOptions`	`FieldOptions`	Чтение	Получает объект FieldOptions, представляющий параметры для управления обработкой полей в документе.
`RemovePersonalInformation`	`bool`	Чтение/запись	Получает или задает флаг, указывающий, что Microsoft Word будет удалять всю пользовательскую информацию из комментариев, исправлений и свойств документа при сохранении документа.
`VbaProject`	`VbaProject`	Чтение/запись	Получает или задает VbaProject.
`Document`	`DocumentBase`	Чтение	Получает этот экземпляр.
`NodeChangingCallback`	`INodeChangingCallback`	Чтение/запись	Вызывается, когда узел вставляется или удаляется в документе.
`ResourceLoadingCallback`	`IResourceLoadingCallback`	Чтение/запись	Позволяет управлять тем, как загружаются внешние ресурсы.
`FontInfos`	`FontInfoCollection`	Чтение	Предоставляет доступ к свойствам шрифтов, используемых в этом документе.
`Styles`	`StyleCollection`	Чтение	Возвращает коллекцию стилей, определённых в документе.
`Lists`	`ListCollection`	Чтение	Обеспечивает доступ к форматированию списков, используемому в документе.
`WarningCallback`	`IWarningCallback`	Чтение/запись	Вызывается в процессе различных процедур обработки документа, когда обнаруживается проблема, которая может привести к потере точности данных или форматирования.
`FootnoteSeparators`	`FootnoteSeparatorCollection`	Чтение	Обеспечивает доступ к разделителям сносок/конечных сносок, определённым в документе.
`BackgroundShape`	`Shape`	Чтение/запись	Получает или задает форму фона документа.
`PageColor`	`Color`	Чтение/запись	Получает или задает цвет страницы документа.
`IsComposite`	`bool`	Чтение	Возвращает true, так как этот узел может иметь дочерние узлы.
`HasChildNodes`	`bool`	Чтение	Возвращает true, если у этого узла есть дочерние узлы.
`FirstChild`	`Node`	Чтение	Получает первого дочернего узла.
`LastChild`	`Node`	Чтение	Получает последний дочерний элемент узла.
`Count`	`int`	Чтение	Получает количество непосредственных дочерних элементов этого узла.
`ParentNode`	`CompositeNode`	Чтение	Получает непосредственного родителя этого узла.
`PreviousSibling`	`Node`	Чтение	Получает узел, непосредственно предшествующий этому узлу.
`NextSibling`	`Node`	Чтение	Получает узел, непосредственно следующий за этим узлом.
`Range`	`Range`	Чтение	Возвращает объект Range, представляющий часть документа, содержащуюся в этом узле.
`CustomNodeId`	`int`	Чтение/запись	Указывает пользовательский идентификатор узла.

Методы

Сигнатура	Описание:
`Document()`	Создаёт или загружает документ.
`Document(fileName: string)`	Открывает существующий документ из файла.
`Document(fileName: string, loadOptions: LoadOptions)`	Открывает существующий документ из файла.
`Document(stream: Stream)`	Вызывает Document(stream) у этого экземпляра Document.
`Document(stream: Stream, loadOptions: LoadOptions)`	Вызывает Document(stream, loadOptions) у этого экземпляра Document.
`Clone()`	Выполняет глубокое копирование документа.
`Accept(visitor: DocumentVisitor)`	Вызывает VisitDocumentStart, затем вызывает Accept для всех дочерних узлов документа и вызывает VisitDocumentEnd в конце.
`AcceptStart(visitor: DocumentVisitor)`	Принимает посетителя для посещения начала документа.
`AcceptEnd(visitor: DocumentVisitor)`	Принимает посетителя для посещения конца документа.
`AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode)`	Добавляет указанный документ в конец этого документа.
`AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode, importFormatOptions: ImportFormatOptions)`	Добавляет указанный документ в конец данного документа.
`Save(fileName: string)`	Сохраняет документ.
`Save(fileName: string, saveFormat: SaveFormat)`	Сохраняет документ в файл в указанном формате.
`Save(fileName: string, saveOptions: SaveOptions)`	Сохраняет документ в файл, используя указанные параметры сохранения.
`Save(stream: Stream, saveFormat: SaveFormat)`	Перегрузки позволяют сохранять документ в файл или поток, при необходимости указывая формат сохранения или детальные параметры сохранения
`Save(stream: Stream, saveOptions: SaveOptions)`	Вызывает Save(stream, saveOptions) у данного экземпляра Document.
`Save(response: HttpResponse, fileName: string, contentDisposition: ContentDisposition, saveOptions: SaveOptions)`	Отправляет документ в браузер клиента.
`EnsureMinimum()`	Если документ не содержит разделов, создаётся один раздел с одним абзацем.
`AcceptAllRevisions()`	Принимает все отслеживаемые изменения в документе.
`Protect(type: ProtectionType)`	Защищает документ от изменений.
`Protect(type: ProtectionType, password: string)`	Защищает документ от изменений и при желании задает пароль защиты.
`Unprotect()`	Снимает защиту с документа.
`Unprotect(password: string)`	Снимает защиту с документа, если указан правильный пароль.
`UpdateTableLayout()`	Реализует более ранний подход к пересчёту ширины столбцов таблицы, который имеет известные проблемы.
`UpdateListLabels()`	Обновляет метки списков для всех элементов списка в документе.
`UpdateActualReferenceMarks()`	Обновляет свойство ActualReferenceMark всех сносок и концевых сносок в документе.
`RemoveMacros()`	Удаляет все макросы (the VBA project), а также панели инструментов и пользовательские настройки команд из документа.
`UpdateFields()`	Обновляет значения полей во всём документе.
`UnlinkFields()`	Разрывает ссылки полей во всём документе.
`NormalizeFieldTypes()`	Изменяет значения типов полей FieldType для FieldStart, FieldSeparator, FieldEnd во всём документе так, чтобы они соответствовали типам полей, содержащимся в кодах полей.
`JoinRunsWithSameFormatting()`	Объединяет участки текста с одинаковым форматированием во всех абзацах документа.
`ExpandTableStylesToDirectFormatting()`	Преобразует форматирование, указанное в стилях таблиц, в прямое форматирование таблиц в документе.
`Cleanup()`	Удаляет неиспользуемые стили и списки из документа.
`Cleanup(options: CleanupOptions)`	Удаляет неиспользуемые стили и списки из документа в зависимости от заданного CleanupOptions.
`RemoveExternalSchemaReferences()`	Удаляет внешние ссылки на схему XML из этого документа.
`StartTrackRevisions(author: string, dateTime: DateTime)`	Запускает автоматическое помечивание всех дальнейших изменений, которые вы вносите в документ программно, как изменения ревизий.
`StartTrackRevisions(author: string)`	Запускает автоматическое помечивание всех дальнейших изменений, которые вы вносите в документ программно, как изменения ревизий.
`StopTrackRevisions()`	Останавливает автоматическое помечивание изменений документа как ревизий.
`CopyStylesFromTemplate(template: string)`	Копирует стили из указанного шаблона в документ.
`CopyStylesFromTemplate(template: Document)`	Копирует стили из указанного шаблона в документ.
`ImportNode(srcNode: Node, isImportChildren: bool)`	Импортирует узел из другого документа в текущий документ.
`GetText()`	Получает текст этого узла и всех его дочерних элементов.
`GetChildNodes(nodeType: NodeType, isDeep: bool)`	Возвращает коллекцию дочерних узлов, соответствующих указанному типу.
`GetChild(nodeType: NodeType, index: int, isDeep: bool)`	Возвращает N-й дочерний узел, соответствующий указанному типу.
`SelectNodes(xpath: string)`	Выбирает список узлов, соответствующих выражению XPath.
`SelectSingleNode(xpath: string)`	Выбирает первый Node, соответствующий выражению XPath.
`GetEnumerator()`	Обеспечивает поддержку итерации в стиле foreach по дочерним узлам этого узла.
`AppendChild(newChild: T)`	Добавляет указанный узел в конец списка дочерних узлов этого узла.
`PrependChild(newChild: T)`	Добавляет указанный узел в начало списка дочерних узлов этого узла.
`InsertAfter(newChild: T, refChild: Node)`	Вставляет указанный узел сразу после указанного узла-ссылки.
`InsertBefore(newChild: T, refChild: Node)`	Вставляет указанный узел сразу перед указанным узлом-ссылкой.
`RemoveChild(oldChild: T)`	Удаляет указанный дочерний узел.
`RemoveAllChildren()`	Удаляет все дочерние узлы текущего узла.
`RemoveSmartTags()`	Удаляет все SmartTag потомковые узлы текущего узла.
`IndexOf(child: Node)`	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
`CreateNavigator()`	Создаёт навигатор, который можно использовать для обхода и чтения узлов.
`GetAncestor(ancestorType: Type)`	Получает первого предка указанного типа объекта.
`GetAncestorOf()`	Вызывает GetAncestorOf у этого экземпляра Document.
`Remove()`	Удаляет себя из родительского элемента.
`NextPreOrder(rootNode: Node)`	Получает следующий узел в соответствии с алгоритмом обхода дерева в порядке предобхода.
`PreviousPreOrder(rootNode: Node)`	Получает предыдущий узел в соответствии с алгоритмом обхода дерева в порядке предобхода.
`ToString(saveFormat: SaveFormat)`	Экспортирует содержимое узла в строку в указанном формате.
`NodeTypeToString(nodeType: NodeType)`	Вспомогательный метод, который преобразует значение перечисления типа узла в удобочитаемую строку.

См. также:

Aspose.Words for .NET — Enterprise API Reference