Word.DocumentCreated class

Ссылка

Пакет:: word

Объект DocumentCreated — это объект верхнего уровня, созданный Application.CreateDocument. Объект DocumentCreated — это специальный объект Document.

Extends: OfficeExtension.ClientObject

// 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	Возвращает основной объект документа. Текст — это текст, который исключает колонтитулы, сноски, текстовые поля и т. д.
contentControls	Возвращает коллекцию объектов элементов управления содержимым в документе. Сюда входят элементы управления содержимым в тексте документа, верхние колонтитулы, текстовые поля и т. д.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
customXmlParts	Возвращает пользовательские XML-части в документе.
properties	Возвращает свойства документа.
saved	Указывает, сохранены ли изменения, внесенные в документ. Значение true указывает на то, что с момента последнего сохранения в документ не вносились изменения.
sections	Возвращает коллекцию объектов section в документе.
settings	Возвращает параметры надстройки в документе.

Методы

addStyle(name, type)	Добавляет стиль в документ по имени и типу.
addStyle(name, typeString)	Добавляет стиль в документ по имени и типу.
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(saveBehaviorString, 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

Возвращает основной объект документа. Текст — это текст, который исключает колонтитулы, сноски, текстовые поля и т. д.

readonly body: Word.Body;

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

Word.Body

contentControls

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

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

Указывает, сохранены ли изменения, внесенные в документ. Значение 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, typeString)

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

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

Параметры

name: string

Обязательно. Строка, представляющая имя стиля.

typeString: "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)

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

Параметры

propertyNames: string | string[]

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

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

Word.DocumentCreated

load(propertyNamesAndPaths)

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 поддерживает только "Сохранить".

fileName: string

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

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

void

save(saveBehaviorString, fileName)

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

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

Параметры

saveBehaviorString: "Save" | "Prompt"

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

fileName: string

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

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

void

set(properties, options)

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

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

Параметры

properties: Word.Interfaces.DocumentCreatedUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

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

Поделиться через

Word.DocumentCreated class

Комментарии

Примеры

Свойства

Методы

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

body

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

Комментарии

contentControls

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

Комментарии

context

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

customXmlParts

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

Комментарии

properties

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

Комментарии

saved

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

Комментарии

sections

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

Комментарии

settings

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

Комментарии

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

addStyle(name, type)

Параметры

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

Комментарии

addStyle(name, typeString)

Параметры

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

Комментарии

deleteBookmark(name)

Параметры

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

Комментарии

getBookmarkRange(name)

Параметры

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

Комментарии

getBookmarkRangeOrNullObject(name)

Параметры

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

Комментарии

getContentControls(options)

Параметры

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

Комментарии

getStyles()

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

Комментарии

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

open()

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

Комментарии

Примеры

save(saveBehavior, fileName)

Параметры

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

Комментарии

save(saveBehaviorString, fileName)