ExcelScript.TextRange interface

Paket:

ExcelScript

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

Hinweise

Beispiele

/**
 * This script adds text to a shape.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a hexagon shape in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const hexagon = sheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
  
  // Set the text of the shape.
  const hexText: ExcelScript.TextRange = hexagon.getTextFrame().getTextRange();
  hexText.setText("Forest");
}

Methoden

getFont()	Gibt ein ShapeFont -Objekt zurück, das die Schriftartattribute für den Textbereich darstellt.
getSubstring(start, length)	Gibt ein TextRange-Objekt für die Teilzeichenfolge im angegebenen Bereich zurück.
getText()	Stellt den unformatierten Textinhalt des Textbereichs dar.
setText(text)	Stellt den unformatierten Textinhalt des Textbereichs dar.

Details zur Methode

getFont()

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

getFont(): ShapeFont;

Gibt zurück

ExcelScript.ShapeFont

Beispiele

/**
 * This sample sets the font of a shape to be bold. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first shape in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const shape = sheet.getShapes()[0];

  // Get the text font from the shape.
  const text: ExcelScript.TextRange = shape.getTextFrame().getTextRange();
  const shapeTextFont: ExcelScript.ShapeFont = text.getFont();

  // Set the font to be bold.
  shapeTextFont.setBold(true);
}

getSubstring(start, length)

Gibt ein TextRange-Objekt für die Teilzeichenfolge im angegebenen Bereich zurück.

getSubstring(start: number, length?: number): 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

ExcelScript.TextRange

getText()

Stellt den unformatierten Textinhalt des Textbereichs dar.

getText(): string;

Gibt zurück

string

Beispiele

/**
 * This script writes all the text from the workbook's geometric shapes in a new worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a new worksheet.
  const shapeTextSheet = workbook.addWorksheet("ShapeText");
  let shapeTextValues: string[][] = [];

  // Get the text from every geometric shape in every worksheet.
  workbook.getWorksheets().forEach((sheet) => {
    sheet.getShapes().forEach((shape) => {
      if (shape.getType() === ExcelScript.ShapeType.geometricShape)
      shapeTextValues.push([
        sheet.getName(),
        shape.getGeometricShapeType().toString(),
        shape.getTextFrame().getTextRange().getText()]);
    });
  });

  // Add the text to the new worksheet.
  const range = shapeTextSheet.getRangeByIndexes(
    0,
    0, 
    shapeTextValues.length, 
    shapeTextValues[0].length);
  range.setValues(shapeTextValues);
}

setText(text)

Stellt den unformatierten Textinhalt des Textbereichs dar.

setText(text: string): void;

Parameter

text

string

Gibt zurück

void