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`	Читання	Повертає колекцію, яка представляє список task pane add-ins.
`CustomDocumentProperties`	`CustomDocumentProperties`	Читання	Повертає колекцію, яка представляє всі користувацькі властивості документа.
`ProtectionType`	`ProtectionType`	Читання	Отримує поточний активний тип захисту документа.
`Sections`	`SectionCollection`	Читання	Повертає колекцію, яка представляє всі розділи в документі.
`FirstSection`	`Section`	Читання	Отримує перший розділ у документі.
`LastSection`	`Section`	Читання	Отримує останній розділ у документі.
`ViewOptions`	`ViewOptions`	Читання	Надає параметри для керування тим, як документ відображається у Microsoft Word.
`WriteProtection`	`WriteProtection`	Читання	Надає доступ до параметрів захисту документа від запису.
`CompatibilityOptions`	`CompatibilityOptions`	Читання	Надає доступ до параметрів сумісності документа (тобто до налаштувань користувача, введених на вкладці Compatibility діалогового вікна Options у Word).
`MailMergeSettings`	`MailMergeSettings`	Читання/Запис	Отримує або задає об’єкт, який містить усю інформацію mail merge для документа.
`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()`	Видаляє всі макроси (проєкт VBA), а також панелі інструментів та налаштування команд з документа.
`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)`	Повертає Nth дочірній вузол, який відповідає вказаному типу.
`SelectNodes(xpath: string)`	Вибирає список вузлів, що відповідають виразу XPath.
`SelectSingleNode(xpath: string)`	Вибирає перший вузол, що відповідає виразу 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)`	Утилітний метод, який перетворює значення enum типу вузла у рядок, зрозумілий користувачеві.

Дивіться також

Aspose.Words for .NET — Enterprise API Reference