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 |
| length | Ruft die Länge des Bereichs ab, den dieser darstellt, oder legt diese |
| paragraph |
Stellt das Absatzformat des Textbereichs dar. Weitere Informationen finden Sie unter PowerPoint.ParagraphFormat . |
| start | Ruft einen nullbasierten Index relativ zum übergeordneten Textrahmen für die Startposition des Bereichs ab, den dieser darstellt, oder legt diesen |
| text | Stellt den unformatierten Textinhalt des Textbereichs dar. |
Methoden
| get |
Gibt das übergeordnete PowerPoint.TextFrame-Objekt zurück, das dieses |
| 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 " |
| set |
Wählt dies |
| 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();
});
length
Ruft die Länge des Bereichs ab, den dieser darstellt, oder legt diese TextRange fest. Löst eine InvalidArgument Ausnahme aus, wenn sie mit einem negativen Wert festgelegt wird oder wenn der Wert größer als die Länge des verfügbaren Texts vom Ausgangspunkt ist.
length: number;Eigenschaftswert
number
Hinweise
paragraphFormat
Stellt das Absatzformat des Textbereichs dar. Weitere Informationen finden Sie unter PowerPoint.ParagraphFormat .
readonly paragraphFormat: PowerPoint.ParagraphFormat;Eigenschaftswert
Hinweise
start
Ruft einen nullbasierten Index relativ zum übergeordneten Textrahmen für die Startposition des Bereichs ab, den dieser darstellt, oder legt diesen TextRange fest. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert festgelegt wird oder wenn der Wert größer als die Textlänge ist.
start: number;Eigenschaftswert
number
Hinweise
text
Stellt den unformatierten Textinhalt des Textbereichs dar.
text: string;Eigenschaftswert
string
Hinweise
Details zur Methode
getParentTextFrame()
Gibt das übergeordnete PowerPoint.TextFrame-Objekt zurück, das dieses TextRangeenthält.
getParentTextFrame(): PowerPoint.TextFrame;Gibt zurück
Hinweise
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
setSelected()
Wählt dies TextRange in der aktuellen Ansicht aus.
setSelected(): void;Gibt zurück
void
Hinweise
[ API-Satz: PowerPointApi 1.5 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Selects the first 10 characters of the selected shape.
await PowerPoint.run(async (context) => {
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
await context.sync();
if (shapeCount.value !== 1) {
console.warn("You must select only one shape with text in it.");
return;
}
const shape: PowerPoint.Shape = shapes.getItemAt(0);
const textFrame: PowerPoint.TextFrame = shape.textFrame.load("textRange,hasText");
await context.sync();
if (textFrame.hasText != true) {
console.warn("You must select only one shape with text in it.");
return;
}
const textRange: PowerPoint.TextRange = textFrame.textRange;
textRange.load("text");
await context.sync();
if (textRange.text.length < 10) {
console.warn("You must select only one shape with at least 10 characters in it.");
return;
}
const textRange10 = textRange.getSubstring(0, 10);
textRange10.setSelected();
await context.sync();
});
...
// Sets the range selection to the range that was saved previously.
await PowerPoint.run(async (context) => {
const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedTextSlideSelection[0]);
const shape1: PowerPoint.Shape = slide1.shapes.getItem(savedTextShapeSelection[0]);
const textRange: PowerPoint.TextRange = shape1.textFrame.textRange.getSubstring(savedTextTextRangeStart, savedTextTextRangeLength);
textRange.setSelected();
await context.sync();
});
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.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