PowerPoint.HyperlinkCollection class
Représente une collection de liens hypertexte.
- S' étend
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
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthode
| add(target, options) | Ajoute un lien hypertexte vers la cible spécifiée avec les options spécifiées. Si la cible contient déjà des liens hypertexte, ils sont supprimés. Le nouveau lien hypertexte peut apparaître n’importe où dans la collection et il n’est pas garanti qu’il soit ajouté à la fin. |
| get |
Obtient le nombre de liens hypertexte dans la collection. |
| get |
Obtient un lien hypertexte à l’aide de son index de base zéro dans la collection. Lève une |
| 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é
context
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 la propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: PowerPoint.Hyperlink[];Valeur de la propriété
Détails de la méthode
add(target, options)
Ajoute un lien hypertexte vers la cible spécifiée avec les options spécifiées. Si la cible contient déjà des liens hypertexte, ils sont supprimés. Le nouveau lien hypertexte peut apparaître n’importe où dans la collection et il n’est pas garanti qu’il soit ajouté à la fin.
add(target: TextRange | Shape, options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;Paramètres
- target
Cible à laquelle ajouter le lien hypertexte. Il peut s’agir d’un fichier PowerPoint.TextRange ou d’un fichier PowerPoint.Shape.
- options
- PowerPoint.HyperlinkAddOptions
Facultatif. Options du lien hypertexte.
Retourne
Objet PowerPoint.Hyperlink nouvellement créé.
Remarques
getCount()
Obtient le nombre de liens hypertexte dans la collection.
getCount(): OfficeExtension.ClientResult<number>;Retourne
OfficeExtension.ClientResult<number>
Nombre de liens hypertexte dans la collection.
Remarques
getItemAt(index)
Obtient un lien hypertexte à l’aide de son index de base zéro dans la collection. Lève une InvalidArgument exception si l’index est hors limites.
getItemAt(index: number): PowerPoint.Hyperlink;Paramètres
- index
-
number
Index du lien hypertexte dans la collection.
Retourne
Lien hypertexte à l’index donné.
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.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;Paramètres
- options
-
PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Fournit des options pour les propriétés de l’objet à charger.
Retourne
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.HyperlinkCollection;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.
Retourne
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?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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.
Retourne
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.HyperlinkCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.HyperlinkCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;