ExcelScript.TextRange interface

Pacote:

ExcelScript

Contém o texto que é anexado a uma forma, bem como propriedades e métodos para manipular o texto.

Comentários

Exemplos

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

Métodos

getFont()	Devolve um ShapeFont objeto que representa os atributos do tipo de letra para o intervalo de texto.
getSubstring(start, length)	Retorna um objeto TextRange para a subcadeia de caracteres no intervalo especificado.
getText()	Representa o conteúdo de texto sem formatação do intervalo de texto.
setText(text)	Representa o conteúdo de texto sem formatação do intervalo de texto.

Detalhes do método

getFont()

Devolve um ShapeFont objeto que representa os atributos do tipo de letra para o intervalo de texto.

getFont(): ShapeFont;

Retornos

ExcelScript.ShapeFont

Exemplos

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

Retorna um objeto TextRange para a subcadeia de caracteres no intervalo especificado.

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

Parâmetros

start

number

O índice baseado em zero do primeiro caráter a obter a partir do intervalo de texto.

length

number

Opcional. O número de carateres a devolver no novo intervalo de texto. Se o comprimento for omitido, todos os carateres do início ao fim do último parágrafo do intervalo de texto serão devolvidos.

Retornos

ExcelScript.TextRange

getText()

Representa o conteúdo de texto sem formatação do intervalo de texto.

getText(): string;

Retornos

string

Exemplos

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

Representa o conteúdo de texto sem formatação do intervalo de texto.

setText(text: string): void;

Parâmetros

text

string

Retornos

void