PowerPoint.Hyperlink class
Stellt einen einzelnen Hyperlink dar.
- Extends
Hinweise
Verwendet von
- PowerPoint.HyperlinkCollection: hinzufügen, getItemAt, Elemente
- PowerPoint.HyperlinkScopedCollection: getItemAt, Elemente
- PowerPoint.Shape: setHyperlink
- PowerPoint.TextRange: setHyperlink
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
| address | Gibt die Adresse des Links an, bei der es sich um eine URL, einen Dateinamen, einen Dateipfad oder eine E-Mail-Adresse mit dem |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| screen |
Gibt die Zeichenfolge an, die angezeigt wird, wenn der Mauszeiger über den Link bewegt wird. |
| type | Gibt den Objekttyp zurück, auf den der Link angewendet wird. Weitere Informationen finden Sie unter PowerPoint.HyperlinkType . |
Methoden
| delete() | Löscht den Hyperlink. |
| get |
Gibt das PowerPoint.Shape-Objekt zurück, auf das der Link angewendet wird. Wenn der Hyperlink nicht vom Typ |
| get |
Gibt das PowerPoint.TextRange-Objekt zurück, auf das der Link angewendet wird. Wenn der Hyperlink 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, einen Dateipfad oder eine E-Mail-Adresse mit dem mailto URI-Schema handeln kann.
address: string;
Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;
Eigenschaftswert
screenTip
Gibt die Zeichenfolge an, die angezeigt wird, wenn der Mauszeiger über den Link bewegt wird.
screenTip: string;
Eigenschaftswert
string
Hinweise
type
Gibt den Objekttyp zurück, auf den 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()
Löscht den Hyperlink.
delete(): void;
Gibt zurück
void
Hinweise
Beispiele
// 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()
Gibt das PowerPoint.Shape-Objekt zurück, auf das der Link angewendet wird. Wenn der Hyperlink nicht vom Typ shapeist oder sich in einer Domäne befindet, die PowerPoint.Shape derzeit nicht unterstützt, gibt diese Methode ein Objekt mit seiner isNullObject Eigenschaft auf truezurück. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getLinkedShapeOrNullObject(): PowerPoint.Shape;
Gibt zurück
Hinweise
getLinkedTextRangeOrNullObject()
Gibt das PowerPoint.TextRange-Objekt zurück, auf das der Link angewendet wird. Wenn der Hyperlink nicht vom Typ textRangeist oder sich in einer Domäne befindet, die derzeit keine PowerPoint.TextRange unterstützt, dann gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. 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 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.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 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.Hyperlink Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.HyperlinkData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): PowerPoint.Interfaces.HyperlinkData;