ExcelScript.TextRange interface

包:

ExcelScript

包含附加到形状上的文本，以及用于操作文本的属性和方法。

注解

示例

/**
 * 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");
}

方法

getFont()	返回一个 ShapeFont 对象，该对象代表文本区域的字体属性。
getSubstring(start, length)	返回给定区域内子字符串的 TextRange 对象。
getText()	表示文本范围的纯文本内容。
setText(text)	表示文本范围的纯文本内容。

方法详细信息

getFont()

返回一个 ShapeFont 对象，该对象代表文本区域的字体属性。

getFont(): ShapeFont;

返回

ExcelScript.ShapeFont

示例

/**
 * 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)

返回给定区域内子字符串的 TextRange 对象。

getSubstring(start: number, length?: number): TextRange;

参数

start

number

要从文本范围获取的第一个字符的从零开始的索引。

length

number

可选。 在新文本区域中要返回的字符数。 如果省略 length，则将返回从文本范围最后一段的开头到末尾的所有字符。

返回

ExcelScript.TextRange

getText()

表示文本范围的纯文本内容。

getText(): string;

返回

string

示例

/**
 * 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)

表示文本范围的纯文本内容。

setText(text: string): void;

参数

text

string

返回

void