Compartir a través de

PowerPoint.Hyperlink class

Paquete:
powerpoint

Representa un solo hipervínculo.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.6 ]

Ejemplos

// 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}")`);
  }
});

Propiedades

address

Especifica la dirección del hipervínculo, que puede ser una dirección URL, un nombre de archivo o una ruta de acceso de archivo, o una dirección de correo electrónico con el mailto esquema de URI.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
screenTip

Especifica la cadena que se muestra al mantener el puntero sobre el hipervínculo.
type

Devuelve el tipo de objeto al que se aplica el hipervínculo. Vea PowerPoint.HyperlinkType para obtener más información.

Métodos

delete()

Elimina el hipervínculo.
getLinkedShapeOrNullObject()

Devuelve el objeto PowerPoint.Shape al que se aplica el hipervínculo. Si el hipervínculo no es de tipo shape, o está dentro de un dominio que no admite actualmente un PowerPoint.Shape, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getLinkedTextRangeOrNullObject()

Devuelve el objeto PowerPoint.TextRange al que se aplica el hipervínculo. Si el hipervínculo no es de tipo textRange, o está dentro de un dominio que no admite actualmente un PowerPoint.TextRange, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.Hyperlink es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.HyperlinkData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

Especifica la dirección del hipervínculo, que puede ser una dirección URL, un nombre de archivo o una ruta de acceso de archivo, o una dirección de correo electrónico con el mailto esquema de URI.

address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: PowerPointApi 1.6 ]

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

PowerPoint.RequestContext

Especifica la cadena que se muestra al mantener el puntero sobre el hipervínculo.

screenTip: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: PowerPointApi 1.6 ]

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve el tipo de objeto al que se aplica el hipervínculo. Vea PowerPoint.HyperlinkType para obtener más información.

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

Valor de propiedad

PowerPoint.HyperlinkType | "TextRange" | "Shape"

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Detalles del método

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Elimina el hipervínculo.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve el objeto PowerPoint.Shape al que se aplica el hipervínculo. Si el hipervínculo no es de tipo shape, o está dentro de un dominio que no admite actualmente un PowerPoint.Shape, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getLinkedShapeOrNullObject(): PowerPoint.Shape;

Devoluciones

PowerPoint.Shape

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve el objeto PowerPoint.TextRange al que se aplica el hipervínculo. Si el hipervínculo no es de tipo textRange, o está dentro de un dominio que no admite actualmente un PowerPoint.TextRange, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;

Devoluciones

PowerPoint.TextRange

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options
PowerPoint.Interfaces.HyperlinkLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

PowerPoint.Hyperlink

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

PowerPoint.Hyperlink

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

PowerPoint.Hyperlink

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.Hyperlink es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.HyperlinkData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): PowerPoint.Interfaces.HyperlinkData;

Devoluciones

PowerPoint.Interfaces.HyperlinkData