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

PowerPoint.Hyperlink class

Пакет:
powerpoint

Представляет одну гиперссылку.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: PowerPointApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml

// Gets the hyperlinks found in the first selected slide.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks.load("address,screenTip");
  const hyperlinksCount = hyperlinks.getCount();
  await context.sync();

  console.log(`${hyperlinksCount.value} hyperlinks found in first selected slide:`);
  for (let link of hyperlinks.items) {
    console.log(`Address: "${link.address}" (Screen tip: "${link.screenTip}")`);
  }
});

Свойства

address

Указывает адрес гиперссылки, который может быть URL-адресом, именем файла или путем к файлу или адресом электронной почты со схемой mailto URI.
context

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

Указывает строку, отображаемую при наведении указателя мыши на гиперссылку.
type

Возвращает тип объекта, к которому применяется гиперссылка. Дополнительные сведения см. в разделе PowerPoint.HyperlinkType .

Методы

delete()

Удаляет гиперссылку.
getLinkedShapeOrNullObject()

Возвращает объект PowerPoint.Shape , к которому применяется гиперссылка. Если гиперссылка не относится к типу shapeили находится в домене, который в настоящее время не поддерживает PowerPoint.Shape, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getLinkedTextRangeOrNullObject()

Возвращает объект PowerPoint.TextRange , к которому применяется гиперссылка. Если гиперссылка не относится к типу textRangeили находится в домене, который в настоящее время не поддерживает PowerPoint.TextRange, то этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)

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

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

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

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

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

Указывает адрес гиперссылки, который может быть URL-адресом, именем файла или путем к файлу или адресом электронной почты со схемой mailto URI.

address: string;

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

string

Комментарии

[ Набор API: PowerPointApi 1.6 ]

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

context: RequestContext;

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

PowerPoint.RequestContext

Указывает строку, отображаемую при наведении указателя мыши на гиперссылку.

screenTip: string;

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

string

Комментарии

[ Набор API: PowerPointApi 1.6 ]

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает тип объекта, к которому применяется гиперссылка. Дополнительные сведения см. в разделе PowerPoint.HyperlinkType .

readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";

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

PowerPoint.HyperlinkType | "TextRange" | "Shape"

Комментарии

[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

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

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Удаляет гиперссылку.

delete(): void;

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

void

Комментарии

[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает объект PowerPoint.Shape , к которому применяется гиперссылка. Если гиперссылка не относится к типу shapeили находится в домене, который в настоящее время не поддерживает PowerPoint.Shape, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getLinkedShapeOrNullObject(): PowerPoint.Shape;

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

PowerPoint.Shape

Комментарии

[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает объект PowerPoint.TextRange , к которому применяется гиперссылка. Если гиперссылка не относится к типу textRangeили находится в домене, который в настоящее время не поддерживает PowerPoint.TextRange, то этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;

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

PowerPoint.TextRange

Комментарии

[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

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

load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;

Параметры

options
PowerPoint.Interfaces.HyperlinkLoadOptions

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

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

PowerPoint.Hyperlink

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.Hyperlink

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Hyperlink;

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.Hyperlink

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

toJSON(): PowerPoint.Interfaces.HyperlinkData;

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

PowerPoint.Interfaces.HyperlinkData