ExcelScript.TextRange interface

Paquete:

ExcelScript

Contiene el texto que hay unido a una forma, además de las propiedades y los métodos de manipulación del texto.

Comentarios

Ejemplos

/**
 * 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()	Devuelve un ShapeFont objeto que representa los atributos de fuente del intervalo de texto.
getSubstring(start, length)	Devuelve un objeto TextRange para la subcadena en el rango especificado.
getText()	Indica el contenido de texto sin formato del intervalo de texto.
setText(text)	Indica el contenido de texto sin formato del intervalo de texto.

Detalles del método

getFont()

Devuelve un ShapeFont objeto que representa los atributos de fuente del intervalo de texto.

getFont(): ShapeFont;

Devoluciones

ExcelScript.ShapeFont

Ejemplos

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

Devuelve un objeto TextRange para la subcadena en el rango especificado.

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

Parámetros

start

number

Índice de base cero del primer carácter que se obtiene del intervalo de texto.

length

number

Opcional. Número de caracteres que se devolverán en el nuevo intervalo de texto. Si se omite length, se devolverán todos los caracteres desde el principio hasta el final del último párrafo del intervalo de texto.

Devoluciones

ExcelScript.TextRange

getText()

Indica el contenido de texto sin formato del intervalo de texto.

getText(): string;

Devoluciones

string

Ejemplos

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

Indica el contenido de texto sin formato del intervalo de texto.

setText(text: string): void;

Parámetros

text

string

Devoluciones

void