PowerPoint.Hyperlink class
Stellt einen einzelnen Hyperlink dar.
- Extends
Hinweise
[ API-Satz: PowerPointApi 1.6 ]
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:`);
for (let link of hyperlinks.items) {
console.log(`Address: "${link.address}" (Screen tip: "${link.screenTip}")`);
}
});
Eigenschaften
| address | Gibt die Adresse des Links an, bei der es sich um eine URL, einen Dateinamen oder Dateipfad oder eine E-Mail-Adresse mit dem |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| screen |
Gibt die Zeichenfolge an, die beim Zeigen auf den Link angezeigt wird. |
| type | Gibt den Typ des Objekts zurück, auf das der Link angewendet wird. Weitere Informationen finden Sie unter PowerPoint.HyperlinkType . |
Methoden
| delete() | Löscht den Link. |
| get |
Gibt das PowerPoint.Shape-Objekt zurück, auf das der Link angewendet wird. Wenn der Link nicht vom Typ |
| get |
Gibt das PowerPoint.TextRange-Objekt zurück, auf das der Link angewendet wird. Wenn der Link nicht vom Typ |
| 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
address
Gibt die Adresse des Links an, bei der es sich um eine URL, einen Dateinamen oder Dateipfad oder eine E-Mail-Adresse mit dem mailto URI-Schema handeln kann.
address: string;Eigenschaftswert
string
Hinweise
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
screenTip
Gibt die Zeichenfolge an, die beim Zeigen auf den Link angezeigt wird.
screenTip: string;Eigenschaftswert
string
Hinweise
type
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt den Typ des Objekts zurück, auf das der Link angewendet wird. Weitere Informationen finden Sie unter PowerPoint.HyperlinkType .
readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape";Eigenschaftswert
PowerPoint.HyperlinkType | "TextRange" | "Shape"
Hinweise
Details zur Methode
delete()
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Löscht den Link.
delete(): void;Gibt zurück
void
Hinweise
getLinkedShapeOrNullObject()
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt das PowerPoint.Shape-Objekt zurück, auf das der Link angewendet wird. Wenn der Link nicht vom Typ shapeist oder sich in einer Domäne befindet, die powerPoint.Shape derzeit nicht unterstützt, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getLinkedShapeOrNullObject(): PowerPoint.Shape;Gibt zurück
Hinweise
getLinkedTextRangeOrNullObject()
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt das PowerPoint.TextRange-Objekt zurück, auf das der Link angewendet wird. Wenn der Link nicht vom Typ textRangeist oder sich in einer Domäne befindet, die powerPoint.TextRange derzeit nicht unterstützt, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getLinkedTextRangeOrNullObject(): PowerPoint.TextRange;Gibt zurück
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.HyperlinkLoadOptions): PowerPoint.Hyperlink;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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.Hyperlink;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?: {
select?: string;
expand?: string;
}): PowerPoint.Hyperlink;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen 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 das Objekt übergeben wird.) Während das ursprüngliche PowerPoint.Hyperlink Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.HyperlinkData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): PowerPoint.Interfaces.HyperlinkData;