Word.DocumentCreated class

Объект DocumentCreated — это объект верхнего уровня, созданный с помощью Application.createDocument. Объект DocumentCreated — это особый Document объект.

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  const externalDoc: Word.DocumentCreated = context.application.createDocument(externalDocument);
  await context.sync();

  if (!Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.3")) {
    console.warn("The WordApiHiddenDocument 1.3 requirement set isn't supported on this client so can't proceed. Try this action on a platform that supports this requirement set.");
    return;
  }

  const externalDocBody: Word.Body = externalDoc.body;
  externalDocBody.load("text");
  await context.sync();

  // Insert the external document's text at the beginning of the current document's body.
  const externalDocBodyText = externalDocBody.text;
  const currentDocBody: Word.Body = context.document.body;
  currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
  await context.sync();
});

Свойства

body	Получает `Body` объект документа. Основной текст — это текст, который исключает верхние, нижние колонтитулы, сноски, текстовые поля и т. д.
contentControls	Получает коллекцию `ContentControl` объектов в документе. Сюда входят элементы управления содержимым в основном тексте документа, верхних и нижних колонтитулах, текстовых полях и т. д.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
customXmlParts	Получает пользовательские части XML в документе.
properties	Получает свойства документа.
saved	Указывает, сохранены ли изменения, внесенные в документ. Значение "of" `true` означает, что документ не изменился с момента сохранения.
sections	Получает коллекцию `Section` объектов в документе.
settings	Получает параметры надстройки в документе.

Методы

addStyle(name, type)	Добавляет стиль в документ по имени и типу.
addStyle(name, type)	Добавляет стиль в документ по имени и типу.
deleteBookmark(name)	Удаляет закладку (если она есть) из документа.
getBookmarkRange(name)	Получает диапазон закладки. Выдает ошибку, `ItemNotFound` если закладки нет.
getBookmarkRangeOrNullObject(name)	Получает диапазон закладки. Если закладки не существует, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getContentControls(options)	Получает поддерживаемые в настоящее время элементы управления содержимым в документе.
getStyles()	Получает объект, `StyleCollection` представляющий весь набор стилей документа.
insertFileFromBase64(base64File, insertLocation, insertFileOptions)	Вставляет документ в целевой документ в определенном месте с дополнительными свойствами. Верхние, нижние колонтитулы, подложки и другие свойства разделов копируются по умолчанию.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
open()	Открытие документа.
save(saveBehavior, fileName)	Сохраняет документ.
save(saveBehavior, fileName)	Сохраняет документ.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.DocumentCreated` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.DocumentCreatedData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

body

Получает Body объект документа. Основной текст — это текст, который исключает верхние, нижние колонтитулы, сноски, текстовые поля и т. д.

readonly body: Word.Body;

Значение свойства

Word.Body

contentControls

Получает коллекцию ContentControl объектов в документе. Сюда входят элементы управления содержимым в основном тексте документа, верхних и нижних колонтитулах, текстовых полях и т. д.

readonly contentControls: Word.ContentControlCollection;

Значение свойства

Word.ContentControlCollection

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

customXmlParts

Получает пользовательские части XML в документе.

readonly customXmlParts: Word.CustomXmlPartCollection;

Значение свойства

Word.CustomXmlPartCollection

properties

Получает свойства документа.

readonly properties: Word.DocumentProperties;

Значение свойства

Word.DocumentProperties

saved

Указывает, сохранены ли изменения, внесенные в документ. Значение "of" true означает, что документ не изменился с момента сохранения.

readonly saved: boolean;

Значение свойства

boolean

sections

Получает коллекцию Section объектов в документе.

readonly sections: Word.SectionCollection;

Значение свойства

Word.SectionCollection

settings

Получает параметры надстройки в документе.

readonly settings: Word.SettingCollection;

Значение свойства

Word.SettingCollection

addStyle(name, type)

Добавляет стиль в документ по имени и типу.

addStyle(name: string, type: Word.StyleType): Word.Style;

Параметры

name: string

Строка, представляющая имя стиля.

type: Word.StyleType

Тип стиля, включая символ, список, абзац или таблицу.

Возвращаемое значение

Word.Style

addStyle(name, type)

Добавляет стиль в документ по имени и типу.

addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

Параметры

name: string

Строка, представляющая имя стиля.

type: "Character" | "List" | "Paragraph" | "Table"

Тип стиля, включая символ, список, абзац или таблицу.

Возвращаемое значение

Word.Style

deleteBookmark(name)

Удаляет закладку (если она есть) из документа.

deleteBookmark(name: string): void;

Параметры

name: string

Имя закладки без учета регистра.

Возвращаемое значение

void

getBookmarkRange(name)

Получает диапазон закладки. Выдает ошибку, ItemNotFound если закладки нет.

getBookmarkRange(name: string): Word.Range;

Параметры

name: string

Имя закладки без учета регистра.

Возвращаемое значение

Word.Range

getBookmarkRangeOrNullObject(name)

Получает диапазон закладки. Если закладки не существует, этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getBookmarkRangeOrNullObject(name: string): Word.Range;

Параметры

name: string

Имя закладки без учета регистра. Поддерживаются только буквы и цифры и символы подчеркивания. Оно должно начинаться с буквы, но если вы хотите пометить закладку как скрытую, начинайте имя с символа подчеркивания. Имя не может содержать больше 40 символов.

Возвращаемое значение

Word.Range

getContentControls(options)

Получает поддерживаемые в настоящее время элементы управления содержимым в документе.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Параметры

options: Word.ContentControlOptions

Необязательный параметр. Параметры, определяющие, какие элементы управления содержимым возвращаются.

Возвращаемое значение

Word.ContentControlCollection

Важно: Если в параметре options указаны определенные типы, возвращаются только элементы управления содержимым поддерживаемых типов. Имейте в виду, что будет создано исключение при использовании методов общего Word. ContentControl, не относящиеся к определенному типу. Со временем могут поддерживаться дополнительные типы управления содержимым. Поэтому надстройка должна запрашивать и обрабатывать определенные типы элементов управления содержимым.

getStyles()

Получает объект, StyleCollection представляющий весь набор стилей документа.

getStyles(): Word.StyleCollection;

Возвращаемое значение

Word.StyleCollection

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

Вставляет документ в целевой документ в определенном месте с дополнительными свойствами. Верхние, нижние колонтитулы, подложки и другие свойства разделов копируются по умолчанию.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;

Параметры

base64File: string

Содержимое файла .docx в кодировке Base64.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Значение должно быть : replace, startили end.

insertFileOptions: Word.InsertFileOptions

Необязательный параметр. Дополнительные свойства, которые следует импортировать в целевой документ.

Возвращаемое значение

Word.SectionCollection

Вставка не поддерживается, если вставляемый документ содержит элемент ActiveX (скорее всего, в поле формы). Рассмотрите возможность замены такого поля формы элементом управления содержимым или другим подходящим для вашего сценария параметром.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated;

Параметры

options: Word.Interfaces.DocumentCreatedLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Word.DocumentCreated

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.DocumentCreated;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Word.DocumentCreated

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.DocumentCreated;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Word.DocumentCreated

open()

Открытие документа.

open(): void;

Возвращаемое значение

void

Примеры

// Create and open a new document in a new tab or window.
await Word.run(async (context) => {
    const externalDoc = context.application.createDocument();
    await context.sync();

    externalDoc.open();
    await context.sync();
});

save(saveBehavior, fileName)

Сохраняет документ.

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

Параметры

saveBehavior: Word.SaveBehavior

Необязательный параметр. DocumentCreated только поддерживает save.

fileName: string

Необязательный параметр. Имя файла (исключить расширение файла). Вступает в силу только для нового документа.

Возвращаемое значение

void

save(saveBehavior, fileName)

Сохраняет документ.

save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;

Параметры

saveBehavior: "Save" | "Prompt"

Необязательный параметр. DocumentCreated только поддерживает save.

fileName: string

Необязательный параметр. Имя файла (исключить расширение файла). Вступает в силу только для нового документа.

Возвращаемое значение

void

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.DocumentCreatedUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Word.DocumentCreated): void;

Параметры

properties: Word.DocumentCreated

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.DocumentCreated объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.DocumentCreatedData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.DocumentCreatedData;

Возвращаемое значение

Word.Interfaces.DocumentCreatedData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.DocumentCreated;

Возвращаемое значение

Word.DocumentCreated

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.DocumentCreated;

Возвращаемое значение

Word.DocumentCreated

Комментарии

Используется

Примеры

Свойства

Методы

Сведения о свойстве

body

Значение свойства

Комментарии

contentControls

Значение свойства

Комментарии

context

Значение свойства

customXmlParts

Значение свойства

Комментарии

properties

Значение свойства

Комментарии

saved

Значение свойства

Комментарии

sections

Значение свойства

Комментарии

settings

Значение свойства

Комментарии

Сведения о методе

addStyle(name, type)

Параметры

Возвращаемое значение

Комментарии

addStyle(name, type)

Параметры

Возвращаемое значение

Комментарии

deleteBookmark(name)

Параметры

Возвращаемое значение

Комментарии

getBookmarkRange(name)

Параметры

Возвращаемое значение

Комментарии

getBookmarkRangeOrNullObject(name)

Параметры

Возвращаемое значение

Комментарии

getContentControls(options)

Параметры

Возвращаемое значение

Комментарии

getStyles()

Возвращаемое значение

Комментарии

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

Параметры

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

open()

Возвращаемое значение

Комментарии

Примеры

save(saveBehavior, fileName)

Параметры

Возвращаемое значение

Комментарии

save(saveBehavior, fileName)