Partager via

PowerPoint.Hyperlink class

Paquet:
powerpoint

Représente un lien hypertexte unique.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : PowerPointApi 1.6 ]

Exemples

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

Propriétés

address

Spécifie l’adresse du lien hypertexte, qui peut être une URL, un nom de fichier ou un chemin d’accès de fichier, ou une adresse e-mail avec le schéma d’URI mailto .
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
screenTip

Spécifie la chaîne affichée lorsque vous pointez sur le lien hypertexte.
type

Retourne le type d’objet auquel le lien hypertexte est appliqué. Pour plus d’informations , voir PowerPoint.HyperlinkType .

Méthodes

delete()

Supprime le lien hypertexte.
getLinkedShapeOrNullObject()

Renvoie l’objet PowerPoint.Shape auquel le lien hypertexte est appliqué. Si le lien hypertexte n’est pas de type shape, ou s’il se trouve dans un domaine qui ne prend pas actuellement en charge powerPoint.Shape, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getLinkedTextRangeOrNullObject()

Renvoie l’objet PowerPoint.TextRange auquel le lien hypertexte est appliqué. Si le lien hypertexte n’est pas de type textRange, ou s’il se trouve dans un domaine qui ne prend pas actuellement en charge powerPoint.TextRange, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.Hyperlink est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.HyperlinkDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

Spécifie l’adresse du lien hypertexte, qui peut être une URL, un nom de fichier ou un chemin d’accès de fichier, ou une adresse e-mail avec le schéma d’URI mailto .

address: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : PowerPointApi 1.6 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

PowerPoint.RequestContext

Spécifie la chaîne affichée lorsque vous pointez sur le lien hypertexte.

screenTip: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : PowerPointApi 1.6 ]

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne le type d’objet auquel le lien hypertexte est appliqué. Pour plus d’informations , voir PowerPoint.HyperlinkType .

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

Valeur de propriété

PowerPoint.HyperlinkType | "TextRange" | "Shape"

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

Détails de la méthode

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Supprime le lien hypertexte.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Renvoie l’objet PowerPoint.Shape auquel le lien hypertexte est appliqué. Si le lien hypertexte n’est pas de type shape, ou s’il se trouve dans un domaine qui ne prend pas actuellement en charge powerPoint.Shape, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getLinkedShapeOrNullObject(): PowerPoint.Shape;

Retours

PowerPoint.Shape

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Renvoie l’objet PowerPoint.TextRange auquel le lien hypertexte est appliqué. Si le lien hypertexte n’est pas de type textRange, ou s’il se trouve dans un domaine qui ne prend pas actuellement en charge powerPoint.TextRange, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;

Retours

PowerPoint.TextRange

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

options
PowerPoint.Interfaces.HyperlinkLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

PowerPoint.Hyperlink

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

PowerPoint.Hyperlink

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

PowerPoint.Hyperlink

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.Hyperlink est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.HyperlinkDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.HyperlinkData;

Retours

PowerPoint.Interfaces.HyperlinkData