ExcelScript.TextFrame interface

Pacote:

ExcelScript

Representa o quadro de texto de um objeto shape.

Comentários

Exemplos

/**
 * 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()	Exclui todo o texto no quadro de texto.
getAutoSizeSetting()	As configurações de dimensionamento automático para o quadro de texto. Um quadro de texto pode ser configurado para ajustar automaticamente o texto ao quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não executar qualquer dimensionamento automático.
getBottomMargin()	Representa margem inferior, em pontos, do quadro de texto.
getHasText()	Especifica se o quadro de texto contém texto.
getHorizontalAlignment()	Representa o alinhamento horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalAlignment detalhes.
getHorizontalOverflow()	Representa o comportamento de excedente horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalOverflow detalhes.
getLeftMargin()	Representa margem esquerda, em pontos, do quadro de texto.
getOrientation()	Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira ExcelScript.ShapeTextOrientation detalhes.
getReadingOrder()	Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Confira ExcelScript.ShapeTextReadingOrder detalhes.
getRightMargin()	Representa margem direita, em pontos, do quadro de texto.
getTextRange()	Representa o texto que está anexado a uma forma, bem como propriedades e métodos para manipular o texto. Confira ExcelScript.TextRange detalhes.
getTopMargin()	Representa margem superior, em pontos, do quadro de texto.
getVerticalAlignment()	Representa o alinhamento vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalAlignment detalhes.
getVerticalOverflow()	Representa o comportamento de excedente vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalOverflow detalhes.
setAutoSizeSetting(autoSizeSetting)	As configurações de dimensionamento automático para o quadro de texto. Um quadro de texto pode ser configurado para ajustar automaticamente o texto ao quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não executar qualquer dimensionamento automático.
setBottomMargin(bottomMargin)	Representa margem inferior, em pontos, do quadro de texto.
setHorizontalAlignment(horizontalAlignment)	Representa o alinhamento horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalAlignment detalhes.
setHorizontalOverflow(horizontalOverflow)	Representa o comportamento de excedente horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalOverflow detalhes.
setLeftMargin(leftMargin)	Representa margem esquerda, em pontos, do quadro de texto.
setOrientation(orientation)	Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira ExcelScript.ShapeTextOrientation detalhes.
setReadingOrder(readingOrder)	Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Confira ExcelScript.ShapeTextReadingOrder detalhes.
setRightMargin(rightMargin)	Representa margem direita, em pontos, do quadro de texto.
setTopMargin(topMargin)	Representa margem superior, em pontos, do quadro de texto.
setVerticalAlignment(verticalAlignment)	Representa o alinhamento vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalAlignment detalhes.
setVerticalOverflow(verticalOverflow)	Representa o comportamento de excedente vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalOverflow detalhes.

Detalhes do método

deleteText()

Exclui todo o texto no quadro de texto.

deleteText(): void;

Retornos

void

getAutoSizeSetting()

As configurações de dimensionamento automático para o quadro de texto. Um quadro de texto pode ser configurado para ajustar automaticamente o texto ao quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não executar qualquer dimensionamento automático.

getAutoSizeSetting(): ShapeAutoSize;

Retornos

ExcelScript.ShapeAutoSize

getBottomMargin()

Representa margem inferior, em pontos, do quadro de texto.

getBottomMargin(): number;

Retornos

number

getHasText()

Especifica se o quadro de texto contém texto.

getHasText(): boolean;

Retornos

boolean

getHorizontalAlignment()

Representa o alinhamento horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalAlignment detalhes.

getHorizontalAlignment(): ShapeTextHorizontalAlignment;

Retornos

ExcelScript.ShapeTextHorizontalAlignment

getHorizontalOverflow()

Representa o comportamento de excedente horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalOverflow detalhes.

getHorizontalOverflow(): ShapeTextHorizontalOverflow;

Retornos

ExcelScript.ShapeTextHorizontalOverflow

getLeftMargin()

Representa margem esquerda, em pontos, do quadro de texto.

getLeftMargin(): number;

Retornos

number

getOrientation()

Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira ExcelScript.ShapeTextOrientation detalhes.

getOrientation(): ShapeTextOrientation;

Retornos

ExcelScript.ShapeTextOrientation

getReadingOrder()

Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Confira ExcelScript.ShapeTextReadingOrder detalhes.

getReadingOrder(): ShapeTextReadingOrder;

Retornos

ExcelScript.ShapeTextReadingOrder

getRightMargin()

Representa margem direita, em pontos, do quadro de texto.

getRightMargin(): number;

Retornos

number

getTextRange()

Representa o texto que está anexado a uma forma, bem como propriedades e métodos para manipular o texto. Confira ExcelScript.TextRange detalhes.

getTextRange(): TextRange;

Retornos

ExcelScript.TextRange

getTopMargin()

Representa margem superior, em pontos, do quadro de texto.

getTopMargin(): number;

Retornos

number

getVerticalAlignment()

Representa o alinhamento vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalAlignment detalhes.

getVerticalAlignment(): ShapeTextVerticalAlignment;

Retornos

ExcelScript.ShapeTextVerticalAlignment

getVerticalOverflow()

Representa o comportamento de excedente vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalOverflow detalhes.

getVerticalOverflow(): ShapeTextVerticalOverflow;

Retornos

ExcelScript.ShapeTextVerticalOverflow

setAutoSizeSetting(autoSizeSetting)

As configurações de dimensionamento automático para o quadro de texto. Um quadro de texto pode ser configurado para ajustar automaticamente o texto ao quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não executar qualquer dimensionamento automático.

setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;

Parâmetros

autoSizeSetting

ExcelScript.ShapeAutoSize

Retornos

void

setBottomMargin(bottomMargin)

Representa margem inferior, em pontos, do quadro de texto.

setBottomMargin(bottomMargin: number): void;

Parâmetros

bottomMargin

number

Retornos

void

setHorizontalAlignment(horizontalAlignment)

Representa o alinhamento horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalAlignment detalhes.

setHorizontalAlignment(
            horizontalAlignment: ShapeTextHorizontalAlignment
        ): void;

Parâmetros

horizontalAlignment

ExcelScript.ShapeTextHorizontalAlignment

Retornos

void

setHorizontalOverflow(horizontalOverflow)

Representa o comportamento de excedente horizontal do quadro de texto. Confira ExcelScript.ShapeTextHorizontalOverflow detalhes.

setHorizontalOverflow(
            horizontalOverflow: ShapeTextHorizontalOverflow
        ): void;

Parâmetros

horizontalOverflow

ExcelScript.ShapeTextHorizontalOverflow

Retornos

void

setLeftMargin(leftMargin)

Representa margem esquerda, em pontos, do quadro de texto.

setLeftMargin(leftMargin: number): void;

Parâmetros

leftMargin

number

Retornos

void

setOrientation(orientation)

Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira ExcelScript.ShapeTextOrientation detalhes.

setOrientation(orientation: ShapeTextOrientation): void;

Parâmetros

orientation

ExcelScript.ShapeTextOrientation

Retornos

void

setReadingOrder(readingOrder)

Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Confira ExcelScript.ShapeTextReadingOrder detalhes.

setReadingOrder(readingOrder: ShapeTextReadingOrder): void;

Parâmetros

readingOrder

ExcelScript.ShapeTextReadingOrder

Retornos

void

setRightMargin(rightMargin)

Representa margem direita, em pontos, do quadro de texto.

setRightMargin(rightMargin: number): void;

Parâmetros

rightMargin

number

Retornos

void

setTopMargin(topMargin)

Representa margem superior, em pontos, do quadro de texto.

setTopMargin(topMargin: number): void;

Parâmetros

topMargin

number

Retornos

void

setVerticalAlignment(verticalAlignment)

Representa o alinhamento vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalAlignment detalhes.

setVerticalAlignment(
            verticalAlignment: ShapeTextVerticalAlignment
        ): void;

Parâmetros

verticalAlignment

ExcelScript.ShapeTextVerticalAlignment

Retornos

void

setVerticalOverflow(verticalOverflow)

Representa o comportamento de excedente vertical do quadro de texto. Confira ExcelScript.ShapeTextVerticalOverflow detalhes.

setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;

Parâmetros

verticalOverflow

ExcelScript.ShapeTextVerticalOverflow

Retornos

void