Word.Source class

Пакет:

word

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
isCited	Возвращает значение , Source если объект был указан в документе.
tag	Возвращает тег источника.
xml	Возвращает XML-представление источника.

Методы

delete()	Удаляет Source объект .
getFieldByName(name)	Возвращает значение поля в объекте литературы Source .
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Source объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.SourceData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

context

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

context: RequestContext;

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

Word.RequestContext

isCited

Возвращает значение , Source если объект был указан в документе.

readonly isCited: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

tag

Возвращает тег источника.

readonly tag: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

xml

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

readonly xml: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

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

delete()

Удаляет Source объект .

delete(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

getFieldByName(name)

Возвращает значение поля в объекте литературы Source .

getFieldByName(name: string): OfficeExtension.ClientResult<string>;

Параметры

name

string

Имя извлекаемого поля.

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

OfficeExtension.ClientResult<string>

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

load(options)

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

load(options?: Word.Interfaces.SourceLoadOptions): Word.Source;

Параметры

options

Word.Interfaces.SourceLoadOptions

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

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

Word.Source

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.Source

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.Source

toJSON()

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

toJSON(): Word.Interfaces.SourceData;

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

Word.Interfaces.SourceData

track()

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

track(): Word.Source;

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

Word.Source

untrack()

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

untrack(): Word.Source;

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

Word.Source