Word.DocumentCreated class

Пакет:

word

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

Расширяет

OfficeExtension.ClientObject

Замечания

[ Набор API: WordApi 1.3 ]

Примеры

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

Замечания

[ Набор API: WordApiHiddenDocument 1.3 ]

contentControls

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

readonly contentControls: Word.ContentControlCollection;

Стоимость недвижимости

Word.ContentControlCollection

Замечания

[ Набор API: WordApiHiddenDocument 1.3 ]

context

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

context: RequestContext;

Стоимость недвижимости

Word.RequestContext

customXmlParts

Возвращает пользовательские XML-части в документе.

readonly customXmlParts: Word.CustomXmlPartCollection;

Стоимость недвижимости

Word.CustomXmlPartCollection

Замечания

[ Набор API: WordApiHiddenDocument 1.4 ]

properties

Возвращает свойства документа.

readonly properties: Word.DocumentProperties;

Стоимость недвижимости

Word.DocumentProperties

Замечания

[ Набор API: WordApiHiddenDocument 1.3 ]

saved

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

readonly saved: boolean;

Стоимость недвижимости

boolean

Замечания

[ Набор API: WordApiHiddenDocument 1.3 ]

sections

Возвращает коллекцию Section объектов в документе.

readonly sections: Word.SectionCollection;

Стоимость недвижимости

Word.SectionCollection

Замечания

[ Набор API: WordApiHiddenDocument 1.3 ]

settings

Возвращает параметры надстройки в документе.

readonly settings: Word.SettingCollection;

Стоимость недвижимости

Word.SettingCollection

Замечания

[ Набор API: WordApiHiddenDocument 1.4 ]

Подробнее о методе

addStyle(name, type)

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

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

Параметры

name

string

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

type

Word.StyleType

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

Возвращает

Word.Style

Замечания

[ Набор API: WordApiHiddenDocument 1.5 ]

addStyle(name, type)

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

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

Параметры

name

string

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

type

"Character" | "List" | "Paragraph" | "Table"

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

Возвращает

Word.Style

Замечания

[ Набор API: WordApiHiddenDocument 1.5 ]

deleteBookmark(name)

Удаляет закладку, если она существует, из документа.

deleteBookmark(name: string): void;

Параметры

name

string

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

Возвращает

void

Замечания

[ Набор API: WordApiHiddenDocument 1.4 ]

getBookmarkRange(name)

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

getBookmarkRange(name: string): Word.Range;

Параметры

name

string

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

Возвращает

Word.Range

Замечания

[ Набор API: WordApiHiddenDocument 1.4 ]

getBookmarkRangeOrNullObject(name)

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

getBookmarkRangeOrNullObject(name: string): Word.Range;

Параметры

name

string

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

Возвращает

Word.Range

Замечания

[ Набор API: WordApiHiddenDocument 1.4 ]

getContentControls(options)

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

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

Параметры

options

Word.ContentControlOptions

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

Возвращает

Word.ContentControlCollection

Замечания

[ Набор API: WordApiHiddenDocument 1.5 ]

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

getStyles()

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

getStyles(): Word.StyleCollection;

Возвращает

Word.StyleCollection

Замечания

[ Набор API: WordApiHiddenDocument 1.5 ]

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

Замечания

[ Набор API: WordApiHiddenDocument 1.5 ]

Вставка не поддерживается, если вставляемый документ содержит элемент 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

Замечания

[ Набор API: WordApi 1.3 ]

Примеры

// 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

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

Возвращает

void

Замечания

[ Набор API: WordApiHiddenDocument 1.3 ]

Примечание. Параметры saveBehavior и fileName появились в WordApiHiddenDocument 1.5.

save(saveBehavior, fileName)

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

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

Параметры

saveBehavior

"Save" | "Prompt"

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

fileName

string

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

Возвращает

void

Замечания

[ Набор API: WordApiHiddenDocument 1.3 ]

Примечание. Параметры saveBehavior и fileName появились в WordApiHiddenDocument 1.5.

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