PowerPoint.TextRange class

Paket:: powerpoint

Enthält den Text, der mit einer Form verknüpft ist, sowie Eigenschaften und Methoden für das Bearbeiten des Texts.

Extends: OfficeExtension.ClientObject

Hinweise

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 `ShapeFont` -Objekt zurück, das die Schriftartattribute für den Textbereich darstellt.
hyperlinks	Gibt eine Auflistung von Links zurück, die in diesem `TextRange`vorhanden sind.
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.
paragraphFormat	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 `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.
text	Stellt den unformatierten Textinhalt des Textbereichs dar.

Methoden

getParentTextFrame()	Gibt das übergeordnete PowerPoint.TextFrame-Objekt zurück, das dieses `TextRange`enthält.
getSubstring(start, length)	Gibt ein `TextRange` -Objekt für die Teilzeichenfolge im angegebenen Bereich zurück.
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(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(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.
setHyperlink(options)	Legt einen Link für diesen `TextRange` mit den angegebenen Optionen fest. Dadurch werden alle vorhandenen Links zu diesem `TextRange`gelöscht.
setSelected()	Wählt dies `TextRange` in der aktuellen Ansicht aus.
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.

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

PowerPoint.RequestContext

font

Gibt ein ShapeFont -Objekt zurück, das die Schriftartattribute für den Textbereich darstellt.

readonly font: PowerPoint.ShapeFont;

Eigenschaftswert

PowerPoint.ShapeFont

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();
});

hyperlinks

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 eine Auflistung von Links zurück, die in diesem TextRangevorhanden sind.

readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;

Eigenschaftswert

PowerPoint.HyperlinkScopedCollection

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

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

[ API-Satz: PowerPointApi 1.5 ]

paragraphFormat

Stellt das Absatzformat des Textbereichs dar. Weitere Informationen finden Sie unter PowerPoint.ParagraphFormat .

readonly paragraphFormat: PowerPoint.ParagraphFormat;

Eigenschaftswert

PowerPoint.ParagraphFormat

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

// Gets navigational (complex) properties of the selected text range.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
  await context.sync();

  console.log("Font properties of selected text range:");
  console.log(`\tallCaps: ${textRange.font.allCaps}`);
  console.log(`\tbold: ${textRange.font.bold}`);
  console.log(`\tcolor: ${textRange.font.color}`);
  console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
  console.log(`\titalic: ${textRange.font.italic}`);
  console.log(`\tname: ${textRange.font.name}`);
  console.log(`\tsize: ${textRange.font.size}`);
  console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
  console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
  console.log(`\tsubscript: ${textRange.font.subscript}`);
  console.log(`\tsuperscript: ${textRange.font.superscript}`);
  console.log(`\tunderline: ${textRange.font.underline}`);

  console.log("Paragraph format properties of selected text range:");
  console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
  console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
});

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

[ API-Satz: PowerPointApi 1.5 ]

text

Stellt den unformatierten Textinhalt des Textbereichs dar.

text: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Details zur Methode

getParentTextFrame()

Gibt das übergeordnete PowerPoint.TextFrame-Objekt zurück, das dieses TextRangeenthält.

getParentTextFrame(): PowerPoint.TextFrame;

Gibt zurück

PowerPoint.TextFrame

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

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

PowerPoint.TextRange

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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

options: PowerPoint.Interfaces.TextRangeLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

PowerPoint.TextRange

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

PowerPoint.TextRange

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

PowerPoint.TextRange

setHyperlink(options)

Hinweis

Legt einen Link für diesen TextRange mit den angegebenen Optionen fest. Dadurch werden alle vorhandenen Links zu diesem TextRangegelöscht.

setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;

Parameter

options: PowerPoint.HyperlinkAddOptions

Optional. Die Optionen für den Link.

Gibt zurück

PowerPoint.Hyperlink

Das neu erstellte PowerPoint.Hyperlink-Objekt .

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

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

PowerPoint.Interfaces.TextRangeData

Feedback

War diese Seite hilfreich?

Freigeben über

PowerPoint.TextRange class

Hinweise

Beispiele

Eigenschaften

Methoden

Details zur Eigenschaft

context

Eigenschaftswert

font

Eigenschaftswert

Hinweise

Beispiele

hyperlinks

Eigenschaftswert

Hinweise

length

Eigenschaftswert

Hinweise

paragraphFormat

Eigenschaftswert

Hinweise

Beispiele

start

Eigenschaftswert

Hinweise

text

Eigenschaftswert

Hinweise

Details zur Methode

getParentTextFrame()

Gibt zurück

Hinweise

getSubstring(start, length)

Parameter

Gibt zurück

Hinweise

load(options)

Parameter

Gibt zurück

load(propertyNames)

Parameter

Gibt zurück

load(propertyNamesAndPaths)

Parameter

Gibt zurück

setHyperlink(options)

Parameter

Gibt zurück

Hinweise

setSelected()

Gibt zurück

Hinweise

Beispiele

toJSON()

Gibt zurück

Feedback