ExcelScript.TextFrame interface
Representa a moldura de texto de um objeto de forma.
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
delete |
Exclui todo o texto no quadro de texto. |
get |
As definições de dimensionamento automático para a moldura 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. |
get |
Representa margem inferior, em pontos, do quadro de texto. |
get |
Especifica se a moldura de texto contém texto. |
get |
Representa o alinhamento horizontal do quadro de texto. Veja |
get |
Representa o comportamento de excedente horizontal do quadro de texto. Veja |
get |
Representa margem esquerda, em pontos, do quadro de texto. |
get |
Representa o ângulo para o qual o texto é orientado para a moldura de texto. Veja |
get |
Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Veja |
get |
Representa margem direita, em pontos, do quadro de texto. |
get |
Representa o texto que está anexado a uma forma, bem como propriedades e métodos para manipular o texto. Veja |
get |
Representa margem superior, em pontos, do quadro de texto. |
get |
Representa o alinhamento vertical do quadro de texto. Veja |
get |
Representa o comportamento de excedente vertical do quadro de texto. Veja |
set |
As definições de dimensionamento automático para a moldura 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. |
set |
Representa margem inferior, em pontos, do quadro de texto. |
set |
Representa o alinhamento horizontal do quadro de texto. Veja |
set |
Representa o comportamento de excedente horizontal do quadro de texto. Veja |
set |
Representa margem esquerda, em pontos, do quadro de texto. |
set |
Representa o ângulo para o qual o texto é orientado para a moldura de texto. Veja |
set |
Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Veja |
set |
Representa margem direita, em pontos, do quadro de texto. |
set |
Representa margem superior, em pontos, do quadro de texto. |
set |
Representa o alinhamento vertical do quadro de texto. Veja |
set |
Representa o comportamento de excedente vertical do quadro de texto. Veja |
Detalhes do método
deleteText()
Exclui todo o texto no quadro de texto.
deleteText(): void;
Retornos
void
getAutoSizeSetting()
As definições de dimensionamento automático para a moldura 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
getBottomMargin()
Representa margem inferior, em pontos, do quadro de texto.
getBottomMargin(): number;
Retornos
number
getHasText()
Especifica se a moldura de texto contém texto.
getHasText(): boolean;
Retornos
boolean
getHorizontalAlignment()
Representa o alinhamento horizontal do quadro de texto. Veja ExcelScript.ShapeTextHorizontalAlignment
para obter detalhes.
getHorizontalAlignment(): ShapeTextHorizontalAlignment;
Retornos
getHorizontalOverflow()
Representa o comportamento de excedente horizontal do quadro de texto. Veja ExcelScript.ShapeTextHorizontalOverflow
para obter detalhes.
getHorizontalOverflow(): ShapeTextHorizontalOverflow;
Retornos
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 a moldura de texto. Veja ExcelScript.ShapeTextOrientation
para obter detalhes.
getOrientation(): ShapeTextOrientation;
Retornos
getReadingOrder()
Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Veja ExcelScript.ShapeTextReadingOrder
para obter detalhes.
getReadingOrder(): ShapeTextReadingOrder;
Retornos
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. Veja ExcelScript.TextRange
para obter detalhes.
getTextRange(): TextRange;
Retornos
getTopMargin()
Representa margem superior, em pontos, do quadro de texto.
getTopMargin(): number;
Retornos
number
getVerticalAlignment()
Representa o alinhamento vertical do quadro de texto. Veja ExcelScript.ShapeTextVerticalAlignment
para obter detalhes.
getVerticalAlignment(): ShapeTextVerticalAlignment;
Retornos
getVerticalOverflow()
Representa o comportamento de excedente vertical do quadro de texto. Veja ExcelScript.ShapeTextVerticalOverflow
para obter detalhes.
getVerticalOverflow(): ShapeTextVerticalOverflow;
Retornos
setAutoSizeSetting(autoSizeSetting)
As definições de dimensionamento automático para a moldura 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. Veja ExcelScript.ShapeTextHorizontalAlignment
para obter detalhes.
setHorizontalAlignment(
horizontalAlignment: ShapeTextHorizontalAlignment
): void;
Parâmetros
- horizontalAlignment
- ExcelScript.ShapeTextHorizontalAlignment
Retornos
void
setHorizontalOverflow(horizontalOverflow)
Representa o comportamento de excedente horizontal do quadro de texto. Veja ExcelScript.ShapeTextHorizontalOverflow
para obter 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 a moldura de texto. Veja ExcelScript.ShapeTextOrientation
para obter 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. Veja ExcelScript.ShapeTextReadingOrder
para obter 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. Veja ExcelScript.ShapeTextVerticalAlignment
para obter detalhes.
setVerticalAlignment(
verticalAlignment: ShapeTextVerticalAlignment
): void;
Parâmetros
- verticalAlignment
- ExcelScript.ShapeTextVerticalAlignment
Retornos
void
setVerticalOverflow(verticalOverflow)
Representa o comportamento de excedente vertical do quadro de texto. Veja ExcelScript.ShapeTextVerticalOverflow
para obter detalhes.
setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;
Parâmetros
- verticalOverflow
- ExcelScript.ShapeTextVerticalOverflow
Retornos
void