Класс Aspose::Words::Document

Document class

Представляет документ Word. Чтобы узнать больше, посетите статью документации Working with Document.

class Document : public Aspose::Words::DocumentBase,
                 public Aspose::Words::ISectionAttrSource,
                 public Aspose::Words::IWatermarkProvider

Методы

Метод	Описание
Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя.
AcceptAllRevisions()	Принимает все отслеживаемые изменения в документе.
AcceptEnd(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя для обхода конца документа.
AcceptStart(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя для обхода начала документа.
AppendChild(T)
AppendDocument(const System::SharedPtr<Aspose::Words::Document>&, Aspose::Words::ImportFormatMode)	Добавляет указанный документ в конец этого документа.
AppendDocument(const System::SharedPtr<Aspose::Words::Document>&, Aspose::Words::ImportFormatMode, const System::SharedPtr<Aspose::Words::ImportFormatOptions>&)	Добавляет указанный документ в конец этого документа.
Cleanup()	Очищает документ от неиспользуемых стилей и списков.
Cleanup(const System::SharedPtr<Aspose::Words::CleanupOptions>&)	Очищает документ от неиспользуемых стилей и списков в зависимости от заданных CleanupOptions.
Clone()	Выполняет глубокое копирование Document.
Clone(bool)	Создаёт дубликат узла.
Compare(const System::SharedPtr<Aspose::Words::Document>&, const System::String&, System::DateTime)	Сравнивает этот документ с другим документом, создавая изменения в виде количества правок и форматных ревизий Revision.
Compare(const System::SharedPtr<Aspose::Words::Document>&, const System::String&, System::DateTime, const System::SharedPtr<Aspose::Words::Comparing::CompareOptions>&)	Сравнивает этот документ с другим документом, создавая изменения в виде количества правок и форматных ревизий Revision. Позволяет задавать параметры сравнения с помощью CompareOptions.
CopyStylesFromTemplate(const System::String&)	Копирует стили из указанного шаблона в документ.
CopyStylesFromTemplate(const System::SharedPtr<Aspose::Words::Document>&)	Копирует стили из указанного шаблона в документ.
Document()	Создаёт пустой документ Word.
Document(const System::String&)	Открывает существующий документ из файла. Автоматически определяет формат файла.
Document(const System::String&, const System::SharedPtr<Aspose::Words::Loading::LoadOptions>&)	Открывает существующий документ из файла. Позволяет указывать дополнительные параметры, такие как пароль шифрования.
Document(const System::SharedPtr<System::IO::Stream>&)	Открывает существующий документ из потока. Автоматически определяет формат файла.
Document(const System::SharedPtr<System::IO::Stream>&, const System::SharedPtr<Aspose::Words::Loading::LoadOptions>&)	Открывает существующий документ из потока. Позволяет указывать дополнительные параметры, такие как пароль шифрования.
Document(std::istream&)
Document(std::istream&, const System::SharedPtr<Aspose::Words::Loading::LoadOptions>&)
EnsureMinimum()	Если документ не содержит разделов, создаёт один раздел с одним абзацем.
ExpandTableStylesToDirectFormatting()	Преобразует форматирование, указанное в стилях таблиц, в прямое форматирование таблиц в документе.
ExtractPages(int32_t, int32_t, const System::SharedPtr<Aspose::Words::PageExtractOptions>&)	Возвращает объект Document, представляющий указанный диапазон страниц и заданные параметры извлечения страниц.
ExtractPages(int32_t, int32_t)	Возвращает объект Document, представляющий указанный диапазон страниц.
get_AttachedTemplate()	Получает или задаёт полный путь к шаблону, прикреплённому к документу.
get_AutomaticallyUpdateStyles()	Получает или задаёт флаг, указывающий, обновляются ли стили в документе для соответствия стилям прикреплённого шаблона каждый раз при открытии документа в MS Word.
get_BackgroundShape() const	Получает или задает форму фона документа. Может быть null.
get_Bibliography()	Получает объект Bibliography, который представляет список источников, доступных в документе.
get_BuiltInDocumentProperties() const	Возвращает коллекцию, представляющую все встроенные свойства документа.
get_CompatibilityOptions()	Обеспечивает доступ к параметрам совместимости документа (то есть к пользовательским настройкам, введённым на вкладке Compatibility диалогового окна Options в Word).
get_Compliance()	Получает версию соответствия OOXML, определённую из содержимого загруженного документа. Имеет смысл только для документов OOXML.
get_Count()	Возвращает количество непосредственных дочерних элементов этого узла.
get_CustomDocumentProperties()	Возвращает коллекцию, представляющую все пользовательские свойства документа.
get_CustomNodeId() const	Указывает пользовательский идентификатор узла.
get_CustomXmlParts() const	Получает или задает коллекцию частей хранилища пользовательских XML‑данных.
get_DefaultTabStop()	Получает или задает интервал (в пунктах) между стандартными табуляциями.
get_DigitalSignatures() const	Получает коллекцию цифровых подписей этого документа и их результаты проверки.
get_Document() const override	Получает текущий экземпляр.
get_EndnoteOptions()	Предоставляет параметры, управляющие нумерацией и размещением концевых сносок в этом документе.
get_FieldOptions()	Получает объект FieldOptions, представляющий параметры управления обработкой полей в документе.
get_FirstChild() const	Возвращает первого дочернего узла.
get_FirstSection()	Получает первый раздел в документе.
get_FontInfos() const	Обеспечивает доступ к свойствам шрифтов, используемых в этом документе.
get_FontSettings() const	Получает или задает настройки шрифтов документа.
get_FootnoteOptions()	Предоставляет параметры, управляющие нумерацией и размещением сносок в этом документе.
get_FootnoteSeparators() const	Обеспечивает доступ к разделителям сносок/концевых сносок, определённым в документе.
get_Frameset() const	Возвращает экземпляр Frameset, если этот документ представляет страницу с фреймами.
get_GlossaryDocument() const	Получает или задает глоссарий внутри этого документа или шаблона. Глоссарий — это хранилище записей AutoText, AutoCorrect и Building Block, определённых в документе.
get_GrammarChecked()	Возвращает true, если документ был проверен на грамматику.
get_HasChildNodes()	Возвращает true, если у этого узла есть дочерние узлы.
get_HasMacros()	Возвращает true, если в документе есть проект VBA (макросы).
get_HasRevisions()	Возвращает true, если в документе есть отслеживаемые изменения.
get_HyphenationOptions()	Обеспечивает доступ к параметрам переноса слов в документе.
get_IncludeTextboxesFootnotesEndnotesInStat()	Указывает, включать ли текстовые поля, сноски и концевые сноски в статистику подсчёта слов.
get_IsComposite() override	Возвращает true, поскольку этот узел может иметь дочерние узлы.
get_JustificationMode()	Получает или задает корректировку межсимвольного интервала документа.
get_LastChild() const	Возвращает последнего дочернего узла.
get_LastSection()	Получает последний раздел в документе.
get_LayoutOptions() const	Получает объект LayoutOptions, который представляет параметры управления процессом компоновки этого документа.
get_Lists() const	Предоставляет доступ к форматированию списков, используемому в документе.
get_MailMerge()	Возвращает объект MailMerge, который представляет функциональность слияния почты для документа.
get_MailMergeSettings()	Получает или задает объект, содержащий всю информацию о слиянии почты для документа.
get_NextNode() const
get_NextSibling()	Возвращает узел, непосредственно следующий за этим узлом.
get_NodeChangingCallback()	Вызывается, когда узел вставляется или удаляется в документе.
get_NodeType() const override	Возвращает Document.
get_OriginalFileName() const	Получает исходное имя файла документа.
get_OriginalLoadFormat() const	Получает формат исходного документа, загруженного в этот объект.
get_PackageCustomParts() const	Получает или задает коллекцию пользовательских частей (произвольного содержимого), связанных с пакетом OOXML с помощью «неизвестных связей».
get_PageColor()	Получает или задает цвет страницы документа. Это свойство является упрощённой версией BackgroundShape.
get_PageCount()	Получает количество страниц в документе, рассчитанное последней операцией компоновки страниц.
get_ParentNode()	Возвращает непосредственного родителя этого узла.
get_PreviousSibling()	Возвращает узел, непосредственно предшествующий этому узлу.
get_PrevNode() const
get_ProtectionType()	Получает текущий активный тип защиты документа.
get_PunctuationKerning()	Указывает, применяется ли кернинг к латинскому тексту и пунктуации.
get_Range()	Возвращает объект Range, представляющий часть документа, содержащуюся в этом узле.
get_ReadabilityStatistics()	Предоставляет информацию о показателе читаемости документа.
get_RemovePersonalInformation()	Получает или задает флаг, указывающий, что Microsoft Word будет удалять всю пользовательскую информацию из комментариев, правок и свойств документа при сохранении.
get_ResourceLoadingCallback() const	Позволяет управлять тем, как загружаются внешние ресурсы.
get_Revisions()	Получает коллекцию ревизий (отслеживаемых изменений), существующих в этом документе.
get_RevisionsView() const	Получает или задает значение, указывающее, работать ли с оригинальной или исправленной версией документа.
get_Sections()	Возвращает коллекцию, представляющую все разделы в документе.
get_ShadeFormData()	Указывает, включать ли серую заливку в полях формы.
get_ShowGrammaticalErrors()	Указывает, отображать ли грамматические ошибки в этом документе.
get_ShowSpellingErrors()	Указывает, отображать ли орфографические ошибки в этом документе.
get_SpellingChecked()	Возвращает true, если документ был проверен на орфографию.
get_Styles() const	Возвращает коллекцию стилей, определённых в документе.
get_Theme()	Получает объект Theme для этого документа.
get_TrackRevisions()	True, если изменения отслеживаются, когда этот документ редактируется в Microsoft Word.
get_Variables()	Возвращает коллекцию переменных, добавленных в документ или шаблон.
get_VbaProject() const	Получает или задает VbaProject.
get_VersionsCount()	Получает количество версий документа, сохранённых в DOC‑документе.
get_ViewOptions()	Предоставляет параметры для управления тем, как документ отображается в Microsoft Word.
get_WarningCallback() const	Вызывается во время различных процедур обработки документа, когда обнаруживается проблема, которая может привести к потере точности данных или форматирования.
get_Watermark()	Предоставляет доступ к водяному знаку документа.
get_WebExtensionTaskPanes() const	Возвращает коллекцию, представляющую список надстроек панели задач.
get_WriteProtection()	Предоставляет доступ к параметрам защиты документа от записи.
GetAncestor(Aspose::Words::NodeType)	Получает первого предка указанного NodeType.
GetAncestorOf()
GetChild(Aspose::Words::NodeType, int32_t, bool)	Возвращает N‑й дочерний узел, соответствующий указанному типу.
GetChildNodes(Aspose::Words::NodeType, bool)	Возвращает живую коллекцию дочерних узлов, соответствующих указанному типу.
GetEnumerator() override	Обеспечивает поддержку итерации в стиле foreach по дочерним узлам этого узла.
GetPageInfo(int32_t)	Получает размер страницы, ориентацию и другую информацию о странице, которая может быть полезна для печати или визуализации.
GetText() override	Получает текст этого узла и всех его дочерних узлов.
GetType() const override
ImportNode(const System::SharedPtr<Aspose::Words::Node>&, bool)	Импортирует узел из другого документа в текущий документ.
ImportNode(const System::SharedPtr<Aspose::Words::Node>&, bool, Aspose::Words::ImportFormatMode)	Импортирует узел из другого документа в текущий документ с параметром для управления форматированием.
ImportNode(const System::SharedPtr<Aspose::Words::Node>&, bool, Aspose::Words::ImportFormatMode, const System::SharedPtr<Aspose::Words::ImportFormatOptions>&)	Импортирует узел из другого документа в текущий документ с параметром для управления форматированием.
IndexOf(const System::SharedPtr<Aspose::Words::Node>&)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
InsertAfter(T, const System::SharedPtr<Aspose::Words::Node>&)
InsertBefore(T, const System::SharedPtr<Aspose::Words::Node>&)
Is(const System::TypeInfo&) const override
IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&)
JoinRunsWithSameFormatting()	Объединяет последовательности с одинаковым форматированием во всех абзацах документа.
NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Получает следующий узел согласно алгоритму обхода дерева в порядке предобхода.
static NodeTypeToString(Aspose::Words::NodeType)	Вспомогательный метод, преобразующий значение перечисления типа узла в удобочитаемую строку.
NormalizeFieldTypes()	Изменяет значения типа поля FieldType у FieldStart, FieldSeparator, FieldEnd во всём документе, чтобы они соответствовали типам полей, содержащимся в кодах полей.
PrependChild(T)
PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Получает предыдущий узел согласно алгоритму обхода дерева в порядке предобхода.
Protect(Aspose::Words::ProtectionType)	Защищает документ от изменений без изменения существующего пароля или назначает случайный пароль.
Protect(Aspose::Words::ProtectionType, const System::String&)	Защищает документ от изменений и при желании задаёт пароль защиты.
RemoveAllChildren()	Удаляет все дочерние узлы текущего узла.
RemoveBlankPages()	Удаляет пустые страницы из документа.
RemoveChild(T)
RemoveCustomizations()	Удаляет настройки панелей инструментов и клавиатурных команд из документа.
RemoveExternalSchemaReferences()	Удаляет внешние ссылки на XML‑схемы из этого документа.
RemoveMacros()	Удаляет все макросы (VBA‑проект), а также панели инструментов и настройки команд из документа.
RemoveSmartTags()	Удаляет все дочерние узлы SmartTag текущего узла.
RenderToScale(int32_t, const System::SharedPtr<System::Drawing::Graphics>&, float, float, float)	Отрисовывает страницу документа в объект Graphics с указанным масштабом.
RenderToSize(int32_t, const System::SharedPtr<System::Drawing::Graphics>&, float, float, float, float)	Отрисовывает страницу документа в объект Graphics с указанным размером.
Save(const System::String&)	Сохраняет документ в файл. Автоматически определяет формат сохранения по расширению.
Save(const System::String&, Aspose::Words::SaveFormat)	Сохраняет документ в файл в указанном формате.
Save(const System::String&, const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)	Сохраняет документ в файл, используя указанные параметры сохранения.
Save(const System::SharedPtr<System::IO::Stream>&, Aspose::Words::SaveFormat)	Сохраняет документ в поток, используя указанный формат.
Save(const System::SharedPtr<System::IO::Stream>&, const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)	Сохраняет документ в поток, используя указанные параметры сохранения.
Save(std::basic_ostream<CharType, Traits>&, Aspose::Words::SaveFormat)
Save(std::basic_ostream<CharType, Traits>&, System::SharedPtr<Aspose::Words::Saving::SaveOptions>)
SelectNodes(const System::String&)	Выбирает список узлов, соответствующих XPath-выражению.
SelectSingleNode(const System::String&)	Выбирает первый Node, который соответствует выражению XPath.
set_AttachedTemplate(const System::String&)	Сеттер для Aspose::Words::Document::get_AttachedTemplate.
set_AutomaticallyUpdateStyles(bool)	Сеттер для Aspose::Words::Document::get_AutomaticallyUpdateStyles.
set_BackgroundShape(const System::SharedPtr<Aspose::Words::Drawing::Shape>&)	Сеттер для Aspose::Words::DocumentBase::get_BackgroundShape.
set_CustomNodeId(int32_t)	Сеттер для Aspose::Words::Node::get_CustomNodeId.
set_CustomXmlParts(const System::SharedPtr<Aspose::Words::Markup::CustomXmlPartCollection>&)	Сеттер для Aspose::Words::Document::get_CustomXmlParts.
set_DefaultTabStop(double)	Сеттер для Aspose::Words::Document::get_DefaultTabStop.
set_FontSettings(const System::SharedPtr<Aspose::Words::Fonts::FontSettings>&)	Сеттер для Aspose::Words::Document::get_FontSettings.
set_GlossaryDocument(const System::SharedPtr<Aspose::Words::BuildingBlocks::GlossaryDocument>&)	Сеттер для Aspose::Words::Document::get_GlossaryDocument.
set_GrammarChecked(bool)	Сеттер для Aspose::Words::Document::get_GrammarChecked.
set_IncludeTextboxesFootnotesEndnotesInStat(bool)	Сеттер для Aspose::Words::Document::get_IncludeTextboxesFootnotesEndnotesInStat.
set_JustificationMode(Aspose::Words::Settings::JustificationMode)	Сеттер для Aspose::Words::Document::get_JustificationMode.
set_MailMergeSettings(const System::SharedPtr<Aspose::Words::Settings::MailMergeSettings>&)	Сеттер для Aspose::Words::Document::get_MailMergeSettings.
set_NextNode(const System::SharedPtr<Aspose::Words::Node>&)
set_NodeChangingCallback(const System::SharedPtr<Aspose::Words::INodeChangingCallback>&)	Вызывается, когда узел вставляется или удаляется в документе.
set_PackageCustomParts(const System::SharedPtr<Aspose::Words::Markup::CustomPartCollection>&)	Сеттер для Aspose::Words::Document::get_PackageCustomParts.
set_PageColor(System::Drawing::Color)	Сеттер для Aspose::Words::DocumentBase::get_PageColor.
set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&)
set_PunctuationKerning(bool)	Сеттер для Aspose::Words::Document::get_PunctuationKerning.
set_RemovePersonalInformation(bool)	Сеттер для Aspose::Words::Document::get_RemovePersonalInformation.
set_ResourceLoadingCallback(const System::SharedPtr<Aspose::Words::Loading::IResourceLoadingCallback>&)	Позволяет управлять тем, как загружаются внешние ресурсы.
set_RevisionsView(Aspose::Words::RevisionsView)	Сеттер для Aspose::Words::Document::get_RevisionsView.
set_ShadeFormData(bool)	Сеттер для Aspose::Words::Document::get_ShadeFormData.
set_ShowGrammaticalErrors(bool)	Сеттер для Aspose::Words::Document::get_ShowGrammaticalErrors.
set_ShowSpellingErrors(bool)	Сеттер для Aspose::Words::Document::get_ShowSpellingErrors.
set_SpellingChecked(bool)	Сеттер для Aspose::Words::Document::get_SpellingChecked.
set_TrackRevisions(bool)	Сеттер для Aspose::Words::Document::get_TrackRevisions.
set_VbaProject(const System::SharedPtr<Aspose::Words::Vba::VbaProject>&)	Сеттер для Aspose::Words::Document::get_VbaProject.
set_WarningCallback(const System::SharedPtr<Aspose::Words::IWarningCallback>&)	Сеттер для Aspose::Words::DocumentBase::get_WarningCallback.
SetParent(const System::SharedPtr<Aspose::Words::Node>&)
SetTemplateWeakPtr(uint32_t) override
StartTrackRevisions(const System::String&, System::DateTime)	Автоматически начинает помечать все последующие изменения, которые вы вносите в документ программно, как изменения ревизий.
StartTrackRevisions(const System::String&)	Автоматически начинает помечать все последующие изменения, которые вы вносите в документ программно, как изменения ревизий.
StopTrackRevisions()	Останавливает автоматическое помечание изменений документа как ревизий.
ToString(Aspose::Words::SaveFormat)	Экспортирует содержимое узла в строку в указанном формате.
ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
static Type()
UnlinkFields()	Отвязывает поля во всём документе.
Unprotect()	Снимает защиту с документа независимо от пароля.
Unprotect(const System::String&)	Снимает защиту с документа, если указан правильный пароль.
UpdateActualReferenceMarks()	Обновляет свойство ActualReferenceMark всех сносок и концевых сносок в документе.
UpdateFields()	Обновляет значения полей во всём документе.
UpdateListLabels()	Обновляет метки списков для всех элементов списка в документе.
UpdatePageLayout()	Перестраивает разметку страниц документа.
UpdateTableLayout()	Реализует более ранний подход к перерасчёту ширины столбцов таблицы, который имеет известные проблемы.
UpdateThumbnail(const System::SharedPtr<Aspose::Words::Rendering::ThumbnailGeneratingOptions>&)	Обновляет Thumbnail документа в соответствии с указанными параметрами.
UpdateThumbnail()	Обновляет Thumbnail документа, используя параметры по умолчанию.
UpdateWordCount()	Обновляет свойства подсчёта слов в документе.
UpdateWordCount(bool)	Обновляет свойства подсчёта слов в документе, при необходимости обновляет свойство Lines.

Примечания

Объект Document является центральным объектом в библиотеке Aspose.Words.

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

Используйте одну из перегрузок метода Save, чтобы сохранить документ в любом из форматов SaveFormat.

Чтобы отрисовать страницы документа непосредственно на объект Graphics, используйте метод RenderToScale() или RenderToSize().

Чтобы распечатать документ, используйте один из методов Print().

MailMerge is the Aspose.Words’s reporting engine that allows to populate reports designed in Microsoft Word with data from various data sources quickly and easily. The data can be from a or an array of values. MailMerge will go through the records found in the data source and insert them into mail merge fields in the document growing it as necessary.

Document stores document-wide information such as Styles, BuiltInDocumentProperties, CustomDocumentProperties, lists and macros. Most of these objects are accessible via the corresponding properties of the Document.

Объект Document является корневым узлом дерева, которое содержит все остальные узлы документа. Дерево реализует шаблон Composite и во многих отношениях похоже на XmlDocument. Содержимое документа может свободно изменяться программно:

The nodes of the document can be accessed via typed collections, for example Sections, ParagraphCollection etc.
The nodes of the document can be selected by their node type using GetChildNodes() or using an XPath query with SelectNodes() or SelectSingleNode().
Content nodes can be added or removed from anywhere in the document using InsertBefore1(), InsertAfter1(), RemoveChild``1() and other methods provided by the base class CompositeNode.
The formatting attributes of each node can be changed via the properties of that node.

Рассмотрите возможность использования DocumentBuilder, который упрощает задачу программного создания или заполнения дерева документа.

Объект Document может содержать только объекты Section.

В Microsoft Word корректный документ должен содержать как минимум один раздел.

См. также

Aspose::Words::ConvertUtil class Aspose::Words::DocumentBase класс