PowerPoint.TextRange class
Enthält den Text, der mit einer Form verknüpft ist, sowie Eigenschaften und Methoden für das Bearbeiten des Texts.
- Extends
Hinweise
[ API-Satz: PowerPointApi 1.4 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
Eigenschaften
context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
font | Gibt ein |
paragraph |
Stellt das Absatzformat des Textbereichs dar. Weitere Informationen finden Sie unter PowerPoint.ParagraphFormat . |
text | Stellt den unformatierten Textinhalt des Textbereichs dar. |
Methoden
get |
Gibt ein |
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 Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;
Eigenschaftswert
font
Gibt ein ShapeFont
-Objekt zurück, das die Schriftartattribute für den Textbereich darstellt.
readonly font: PowerPoint.ShapeFont;
Eigenschaftswert
Hinweise
[ API-Satz: PowerPointApi 1.4 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
paragraphFormat
Stellt das Absatzformat des Textbereichs dar. Weitere Informationen finden Sie unter PowerPoint.ParagraphFormat .
readonly paragraphFormat: PowerPoint.ParagraphFormat;
Eigenschaftswert
Hinweise
text
Stellt den unformatierten Textinhalt des Textbereichs dar.
text: string;
Eigenschaftswert
string
Hinweise
Details zur Methode
getSubstring(start, length)
Gibt ein TextRange
-Objekt für die Teilzeichenfolge im angegebenen Bereich zurück.
getSubstring(start: number, length?: number): PowerPoint.TextRange;
Parameter
- start
-
number
Der nullbasierte Index des ersten Zeichens, das aus dem Textbereich abgerufen werden soll.
- length
-
number
Optional. Die Anzahl der Zeichen, die im neuen Textbereich zurückgegeben werden sollen. Wenn length nicht angegeben wird, werden alle Zeichen vom Anfang bis zum Ende des letzten Absatzes des Textbereichs zurückgegeben.
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.TextRangeLoadOptions): PowerPoint.TextRange;
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.TextRange;
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.TextRange;
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.stringify
ruft wiederum die toJSON
-Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche PowerPoint.TextRange
Objekt ein API-Objekt ist, gibt die toJSON
Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.TextRangeData
) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): PowerPoint.Interfaces.TextRangeData;
Gibt zurück
Office Add-ins