ExcelScript.TextFrame interface

Paquete:

ExcelScript

Representa el marco de texto de un objeto de forma.

Comentarios

Ejemplos

/**
 * This script creates a star shape with the value from cell A1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the value of A1 from the worksheet named Sheet1.
  const sheet = workbook.getWorksheet("Sheet1");
  const value = sheet.getRange("A1").getValue();

  // Create a Shape object that looks like a 5-pointed star.
  const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);

  // Set the text of star and make sure the shape fits the text.
  const textFrame: ExcelScript.TextFrame = star.getTextFrame();
  textFrame.getTextRange().setText(value.toString());
  textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
}

Métodos

deleteText()	Elimina todo el texto en el marco de texto.
getAutoSizeSetting()	La configuración de ajuste de tamaño automático para el marco de texto. Un marco de texto puede establecerse para ajustar automáticamente el texto al marco de texto, ajustar automáticamente el marco de texto al texto o no realizar ningún cambio de tamaño automático.
getBottomMargin()	Indica el margen inferior, en puntos, del marco de texto.
getHasText()	Especifica si el marco de texto contiene texto.
getHorizontalAlignment()	Indica la alineación horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalAlignment para más información.
getHorizontalOverflow()	Indica el comportamiento de desbordamiento horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalOverflow para más información.
getLeftMargin()	Indica el margen izquierdo, en puntos, del marco de texto.
getOrientation()	Representa el ángulo al que está orientado el texto para el marco de texto. Vea ExcelScript.ShapeTextOrientation para más información.
getReadingOrder()	Representa el orden de lectura del marco de texto, ya sea de izquierda a derecha o de derecha a izquierda. Vea ExcelScript.ShapeTextReadingOrder para más información.
getRightMargin()	Indica el margen derecho, en puntos, del marco de texto.
getTextRange()	Representa el texto que hay unido a una forma en el marco de texto y las propiedades y los métodos de manipulación del texto. Vea ExcelScript.TextRange para más información.
getTopMargin()	Indica el margen superior, en puntos, del marco de texto.
getVerticalAlignment()	Indica la alineación vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalAlignment para más información.
getVerticalOverflow()	Representa el comportamiento de desbordamiento vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalOverflow para más información.
setAutoSizeSetting(autoSizeSetting)	La configuración de ajuste de tamaño automático para el marco de texto. Un marco de texto puede establecerse para ajustar automáticamente el texto al marco de texto, ajustar automáticamente el marco de texto al texto o no realizar ningún cambio de tamaño automático.
setBottomMargin(bottomMargin)	Indica el margen inferior, en puntos, del marco de texto.
setHorizontalAlignment(horizontalAlignment)	Indica la alineación horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalAlignment para más información.
setHorizontalOverflow(horizontalOverflow)	Indica el comportamiento de desbordamiento horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalOverflow para más información.
setLeftMargin(leftMargin)	Indica el margen izquierdo, en puntos, del marco de texto.
setOrientation(orientation)	Representa el ángulo al que está orientado el texto para el marco de texto. Vea ExcelScript.ShapeTextOrientation para más información.
setReadingOrder(readingOrder)	Representa el orden de lectura del marco de texto, ya sea de izquierda a derecha o de derecha a izquierda. Vea ExcelScript.ShapeTextReadingOrder para más información.
setRightMargin(rightMargin)	Indica el margen derecho, en puntos, del marco de texto.
setTopMargin(topMargin)	Indica el margen superior, en puntos, del marco de texto.
setVerticalAlignment(verticalAlignment)	Indica la alineación vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalAlignment para más información.
setVerticalOverflow(verticalOverflow)	Representa el comportamiento de desbordamiento vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalOverflow para más información.

Detalles del método

deleteText()

Elimina todo el texto en el marco de texto.

deleteText(): void;

Devoluciones

void

getAutoSizeSetting()

La configuración de ajuste de tamaño automático para el marco de texto. Un marco de texto puede establecerse para ajustar automáticamente el texto al marco de texto, ajustar automáticamente el marco de texto al texto o no realizar ningún cambio de tamaño automático.

getAutoSizeSetting(): ShapeAutoSize;

Devoluciones

ExcelScript.ShapeAutoSize

getBottomMargin()

Indica el margen inferior, en puntos, del marco de texto.

getBottomMargin(): number;

Devoluciones

number

getHasText()

Especifica si el marco de texto contiene texto.

getHasText(): boolean;

Devoluciones

boolean

getHorizontalAlignment()

Indica la alineación horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalAlignment para más información.

getHorizontalAlignment(): ShapeTextHorizontalAlignment;

Devoluciones

ExcelScript.ShapeTextHorizontalAlignment

getHorizontalOverflow()

Indica el comportamiento de desbordamiento horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalOverflow para más información.

getHorizontalOverflow(): ShapeTextHorizontalOverflow;

Devoluciones

ExcelScript.ShapeTextHorizontalOverflow

getLeftMargin()

Indica el margen izquierdo, en puntos, del marco de texto.

getLeftMargin(): number;

Devoluciones

number

getOrientation()

Representa el ángulo al que está orientado el texto para el marco de texto. Vea ExcelScript.ShapeTextOrientation para más información.

getOrientation(): ShapeTextOrientation;

Devoluciones

ExcelScript.ShapeTextOrientation

getReadingOrder()

Representa el orden de lectura del marco de texto, ya sea de izquierda a derecha o de derecha a izquierda. Vea ExcelScript.ShapeTextReadingOrder para más información.

getReadingOrder(): ShapeTextReadingOrder;

Devoluciones

ExcelScript.ShapeTextReadingOrder

getRightMargin()

Indica el margen derecho, en puntos, del marco de texto.

getRightMargin(): number;

Devoluciones

number

getTextRange()

Representa el texto que hay unido a una forma en el marco de texto y las propiedades y los métodos de manipulación del texto. Vea ExcelScript.TextRange para más información.

getTextRange(): TextRange;

Devoluciones

ExcelScript.TextRange

getTopMargin()

Indica el margen superior, en puntos, del marco de texto.

getTopMargin(): number;

Devoluciones

number

getVerticalAlignment()

Indica la alineación vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalAlignment para más información.

getVerticalAlignment(): ShapeTextVerticalAlignment;

Devoluciones

ExcelScript.ShapeTextVerticalAlignment

getVerticalOverflow()

Representa el comportamiento de desbordamiento vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalOverflow para más información.

getVerticalOverflow(): ShapeTextVerticalOverflow;

Devoluciones

ExcelScript.ShapeTextVerticalOverflow

setAutoSizeSetting(autoSizeSetting)

La configuración de ajuste de tamaño automático para el marco de texto. Un marco de texto puede establecerse para ajustar automáticamente el texto al marco de texto, ajustar automáticamente el marco de texto al texto o no realizar ningún cambio de tamaño automático.

setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;

Parámetros

autoSizeSetting

ExcelScript.ShapeAutoSize

Devoluciones

void

setBottomMargin(bottomMargin)

Indica el margen inferior, en puntos, del marco de texto.

setBottomMargin(bottomMargin: number): void;

Parámetros

bottomMargin

number

Devoluciones

void

setHorizontalAlignment(horizontalAlignment)

Indica la alineación horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalAlignment para más información.

setHorizontalAlignment(
            horizontalAlignment: ShapeTextHorizontalAlignment
        ): void;

Parámetros

horizontalAlignment

ExcelScript.ShapeTextHorizontalAlignment

Devoluciones

void

setHorizontalOverflow(horizontalOverflow)

Indica el comportamiento de desbordamiento horizontal del marco de texto. Vea ExcelScript.ShapeTextHorizontalOverflow para más información.

setHorizontalOverflow(
            horizontalOverflow: ShapeTextHorizontalOverflow
        ): void;

Parámetros

horizontalOverflow

ExcelScript.ShapeTextHorizontalOverflow

Devoluciones

void

setLeftMargin(leftMargin)

Indica el margen izquierdo, en puntos, del marco de texto.

setLeftMargin(leftMargin: number): void;

Parámetros

leftMargin

number

Devoluciones

void

setOrientation(orientation)

Representa el ángulo al que está orientado el texto para el marco de texto. Vea ExcelScript.ShapeTextOrientation para más información.

setOrientation(orientation: ShapeTextOrientation): void;

Parámetros

orientation

ExcelScript.ShapeTextOrientation

Devoluciones

void

setReadingOrder(readingOrder)

Representa el orden de lectura del marco de texto, ya sea de izquierda a derecha o de derecha a izquierda. Vea ExcelScript.ShapeTextReadingOrder para más información.

setReadingOrder(readingOrder: ShapeTextReadingOrder): void;

Parámetros

readingOrder

ExcelScript.ShapeTextReadingOrder

Devoluciones

void

setRightMargin(rightMargin)

Indica el margen derecho, en puntos, del marco de texto.

setRightMargin(rightMargin: number): void;

Parámetros

rightMargin

number

Devoluciones

void

setTopMargin(topMargin)

Indica el margen superior, en puntos, del marco de texto.

setTopMargin(topMargin: number): void;

Parámetros

topMargin

number

Devoluciones

void

setVerticalAlignment(verticalAlignment)

Indica la alineación vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalAlignment para más información.

setVerticalAlignment(
            verticalAlignment: ShapeTextVerticalAlignment
        ): void;

Parámetros

verticalAlignment

ExcelScript.ShapeTextVerticalAlignment

Devoluciones

void

setVerticalOverflow(verticalOverflow)

Representa el comportamiento de desbordamiento vertical del marco de texto. Vea ExcelScript.ShapeTextVerticalOverflow para más información.

setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;

Parámetros

verticalOverflow

ExcelScript.ShapeTextVerticalOverflow

Devoluciones

void