PowerPoint.Hyperlink class
Représente un seul lien hypertexte.
- Extends
Remarques
Utilisateur
- PowerPoint.HyperlinkCollection : add, getItemAt, items
- PowerPoint.HyperlinkScopedCollection : getItemAt, items
- PowerPoint.Shape : setHyperlink
- PowerPoint.TextRange : setHyperlink
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${hyperlinksCount.value === 0 ? "." : ":"}`,
);
for (let link of hyperlinks.items) {
console.log(`Address: "${link.address}" (screen tip: "${link.screenTip}").`);
}
});
Propriétés
| address | Indique l’adresse du lien hypertexte (qui peut être une URL, un nom de fichier ou un chemin d’accès au fichier, ou une adresse e-mail avec le schéma de l’URI |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| screen |
Spécifie la chaîne affichée lorsque vous pointez sur le lien hypertexte. |
| type | Renvoie le type d’objet auquel le lien hypertexte est appliqué. Pour plus d’informations , consultez PowerPoint.HyperlinkType . |
Méthodes
| delete() | Supprime le lien hypertexte. |
| get |
Renvoie l’objet PowerPoint.Shape auquel le lien hypertexte est appliqué. Si le lien hypertexte n’est pas de type |
| get |
Renvoie l’objet PowerPoint.TextRange auquel le lien hypertexte est appliqué. Si le lien hypertexte n’est pas de type |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
address
Indique l’adresse du lien hypertexte (qui peut être une URL, un nom de fichier ou un chemin d’accès au fichier, ou une adresse e-mail avec le schéma de l’URI mailto ).
address: string;
Valeur de propriété
string
Remarques
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;
Valeur de propriété
screenTip
Spécifie la chaîne affichée lorsque vous pointez sur le lien hypertexte.
screenTip: string;
Valeur de propriété
string
Remarques
type
Renvoie le type d’objet auquel le lien hypertexte est appliqué. Pour plus d’informations , consultez PowerPoint.HyperlinkType .
readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";
Valeur de propriété
PowerPoint.HyperlinkType | "TextRange" | "Shape"
Remarques
Détails de la méthode
delete()
Supprime le lien hypertexte.
delete(): void;
Retours
void
Remarques
Jeu d’API : PowerPointApi 1.10
Exemples
// 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}".`);
});
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 en charge actuellement un PowerPoint.Shape, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getLinkedShapeOrNullObject(): PowerPoint.Shape;
Retours
Remarques
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 en charge actuellement un PowerPoint.TextRange, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;
Retours
Remarques
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(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;
Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
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(propertyNames?: string | string[]): PowerPoint.Hyperlink;
Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
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.
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
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 simple (typé ) PowerPoint.Interfaces.HyperlinkDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): PowerPoint.Interfaces.HyperlinkData;