PowerPoint.Hyperlink class

Pacote:
powerpoint

Representa um único hiperlink.

Extends
OfficeExtension.ClientObject

Comentários

Conjunto de APIs: PowerPointApi 1.6

Usada por

Exemplos

// 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${hyperlinksCount.value === 0 ? "." : ":"}`,
  );
  for (let link of hyperlinks.items) {
    console.log(`Address: "${link.address}" (screen tip: "${link.screenTip}").`);
  }
});

Propriedades

address

Especifica o endereço do hiperlink, que pode ser uma URL, um nome de arquivo ou caminho de arquivo ou um endereço de email com o mailto esquema de URI.
context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
screenTip

Especifica a cadeia de caracteres exibida ao passar o mouse sobre o hiperlink.
type

Retorna o tipo de objeto ao qual o hiperlink é aplicado. Consulte PowerPoint.HyperlinkType para obter detalhes.

Métodos

delete()

Exclui o hiperlink.
getLinkedShapeOrNullObject()

Retorna o objeto PowerPoint.Shape ao qual o hiperlink é aplicado. Se o hiperlink não for do tipo shape, ou estiver dentro de um domínio que atualmente não dá suporte a um PowerPoint.Shape, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getLinkedTextRangeOrNullObject()

Retorna o objeto PowerPoint.TextRange ao qual o hiperlink é aplicado. Se o hiperlink não for do tipo textRange, ou estiver dentro de um domínio que atualmente não dá suporte a um PowerPoint.TextRange, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original PowerPoint.Hyperlink é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.HyperlinkData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

Detalhes da propriedade

Especifica o endereço do hiperlink, que pode ser uma URL, um nome de arquivo ou caminho de arquivo ou um endereço de email com o mailto esquema de URI.

address: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: PowerPointApi 1.6

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

Especifica a cadeia de caracteres exibida ao passar o mouse sobre o hiperlink.

screenTip: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: PowerPointApi 1.6

Retorna o tipo de objeto ao qual o hiperlink é aplicado. Consulte PowerPoint.HyperlinkType para obter detalhes.

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

Valor da propriedade

PowerPoint.HyperlinkType | "TextRange" | "Shape"

Comentários

Conjunto de APIs: PowerPointApi 1.10

Detalhes do método

Exclui o hiperlink.

delete(): void;

Retornos

void

Comentários

Conjunto de APIs: PowerPointApi 1.10

Exemplos

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

// Deletes the first hyperlink found in the selected text on the current slide.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange().load("text");
  let hyperlink: PowerPoint.Hyperlink = textRange.hyperlinks.getItemAt(0).load("address,screenTip");
  try {
    await context.sync();
  } catch {
    console.warn(
      "Confirm that you have at least one slide and you've selected a contiguous range of text containing at least one hyperlink on the active slide.",
    );
    return;
  }

  console.log(
    `About to delete first link "${hyperlink.address}" (screen tip: "${hyperlink.screenTip}") found in the selected text "${textRange.text}".`,
  );

  hyperlink.delete();

  console.log(`Deleted first link found in the selected text "${textRange.text}".`);
});

Retorna o objeto PowerPoint.Shape ao qual o hiperlink é aplicado. Se o hiperlink não for do tipo shape, ou estiver dentro de um domínio que atualmente não dá suporte a um PowerPoint.Shape, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getLinkedShapeOrNullObject(): PowerPoint.Shape;

Retornos

PowerPoint.Shape

Comentários

Conjunto de APIs: PowerPointApi 1.10

Retorna o objeto PowerPoint.TextRange ao qual o hiperlink é aplicado. Se o hiperlink não for do tipo textRange, ou estiver dentro de um domínio que atualmente não dá suporte a um PowerPoint.TextRange, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;

Retornos

PowerPoint.TextRange

Comentários

Conjunto de APIs: PowerPointApi 1.10

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options
PowerPoint.Interfaces.HyperlinkLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

PowerPoint.Hyperlink

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

PowerPoint.Hyperlink

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

PowerPoint.Hyperlink

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original PowerPoint.Hyperlink é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.HyperlinkData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.HyperlinkData;

Retornos

PowerPoint.Interfaces.HyperlinkData