Compartilhar via

PowerPoint.Hyperlink class

Pacote:
powerpoint

Representa uma única hiperligação.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.6 ]

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:`);
  for (let link of hyperlinks.items) {
    console.log(`Address: "${link.address}" (Screen tip: "${link.screenTip}")`);
  }
});

Propriedades

address

Especifica o endereço da hiperligação, que pode ser um URL, um nome de ficheiro ou caminho de ficheiro ou um endereço de e-mail com o mailto esquema de URI.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
screenTip

Especifica a cadeia apresentada ao pairar o cursor sobre a hiperligação.
type

Devolve o tipo de objeto ao qual a hiperligação é aplicada. Veja PowerPoint.HyperlinkType para obter detalhes.

Métodos

delete()

Elimina a hiperligação.
getLinkedShapeOrNullObject()

Devolve o objeto PowerPoint.Shape ao qual a hiperligação é aplicada. Se a hiperligação não for do tipo shapeou se estiver num domínio que não suporta atualmente um PowerPoint.Shape, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getLinkedTextRangeOrNullObject()

Devolve o objeto PowerPoint.TextRange ao qual a hiperligação é aplicada. Se a hiperligação não for do tipo textRangeou estiver num domínio que não suporta atualmente um PowerPoint.TextRange, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.Hyperlink é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.HyperlinkData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

Especifica o endereço da hiperligação, que pode ser um URL, um nome de ficheiro ou caminho de ficheiro ou um endereço de e-mail com o mailto esquema de URI.

address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi 1.6 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

Especifica a cadeia apresentada ao pairar o cursor sobre a hiperligação.

screenTip: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi 1.6 ]

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve o tipo de objeto ao qual a hiperligação é aplicada. Veja PowerPoint.HyperlinkType para obter detalhes.

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

Valor da propriedade

PowerPoint.HyperlinkType | "TextRange" | "Shape"

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Detalhes do método

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Elimina a hiperligação.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve o objeto PowerPoint.Shape ao qual a hiperligação é aplicada. Se a hiperligação não for do tipo shapeou se estiver num domínio que não suporta atualmente um PowerPoint.Shape, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getLinkedShapeOrNullObject(): PowerPoint.Shape;

Retornos

PowerPoint.Shape

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve o objeto PowerPoint.TextRange ao qual a hiperligação é aplicada. Se a hiperligação não for do tipo textRangeou estiver num domínio que não suporta atualmente um PowerPoint.TextRange, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;

Retornos

PowerPoint.TextRange

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 as propriedades do objeto a carregar.

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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

PowerPoint.Hyperlink

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.Hyperlink é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.HyperlinkData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.HyperlinkData;

Retornos

PowerPoint.Interfaces.HyperlinkData