PowerPoint.HyperlinkCollection class
Stellt eine Sammlung von Links dar.
- Extends
Hinweise
Verwendet von
Beispiele
// 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}").`);
}
});
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| add(target, options) | Fügt dem angegebenen Ziel einen Link mit den angegebenen Optionen hinzu. Wenn das Ziel bereits Links enthält, werden diese gelöscht. Der neue Link kann an beliebiger Stelle in der Sammlung angezeigt werden und es ist nicht garantiert, dass er am Ende hinzugefügt wird. |
| get |
Ruft die Anzahl der Hyperlinks in der Sammlung ab. |
| get |
Ruft einen Hyperlink unter Verwendung seines Nullindexes in der Sammlung ab. Löst eine |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: PowerPoint.Hyperlink[];Eigenschaftswert
Details zur Methode
add(target, options)
Fügt dem angegebenen Ziel einen Link mit den angegebenen Optionen hinzu. Wenn das Ziel bereits Links enthält, werden diese gelöscht. Der neue Link kann an beliebiger Stelle in der Sammlung angezeigt werden und es ist nicht garantiert, dass er am Ende hinzugefügt wird.
add(target: TextRange | Shape, options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;Parameter
- target
Das Ziel, dem der Link hinzugefügt werden soll. Kann PowerPoint.TextRange oder PowerPoint.Shape sein.
- options
- PowerPoint.HyperlinkAddOptions
Optional. Die Optionen für den Hyperlink.
Gibt zurück
Das neu erstellte PowerPoint.Hyperlink-Objekt .
Hinweise
getCount()
Ruft die Anzahl der Hyperlinks in der Sammlung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Die Anzahl der Links in der Sammlung.
Hinweise
getItemAt(index)
Ruft einen Hyperlink unter Verwendung seines Nullindexes in der Sammlung ab. Löst eine InvalidArgument Ausnahme aus, wenn der Index außerhalb des zulässigen Bereichs liegt.
getItemAt(index: number): PowerPoint.Hyperlink;Parameter
- index
-
number
Der Index des Links in der Sammlung.
Gibt zurück
Der Hyperlink am angegebenen Index.
Hinweise
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;Parameter
- options
-
PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche PowerPoint.HyperlinkCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.HyperlinkCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;