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


PowerPoint.HyperlinkScopedCollection class

Представляет коллекцию гиперссылок с заданной областью.

Расширяет

Замечания

[ Набор API: PowerPointApi 1.10 ]

Свойства

context

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

items

Получает загруженные дочерние элементы в этой коллекции.

Методика

getCount()

Возвращает количество гиперссылок в коллекции.

getItemAt(index)

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

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

Подробнее

context

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

context: RequestContext;

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

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: PowerPoint.Hyperlink[];

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

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

getCount()

Возвращает количество гиперссылок в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращает

Количество гиперссылок в коллекции.

Замечания

[ Набор API: PowerPointApi 1.10 ]

getItemAt(index)

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

getItemAt(index: number): PowerPoint.Hyperlink;

Параметры

index

number

Индекс гиперссылки в коллекции.

Возвращает

Гиперссылка по заданному индексу.

Замечания

[ Набор API: PowerPointApi 1.10 ]

load(options)

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

load(options?: PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkScopedCollection;

Параметры

options

PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Возвращает

load(propertyNames)

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

load(propertyNames?: string | string[]): PowerPoint.HyperlinkScopedCollection;

Параметры

propertyNames

string | string[]

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

Возвращает

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkScopedCollection;

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

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

Возвращает

toJSON()

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

toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData;

Возвращает