Excel.TextFrame class

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.

autoSizeSetting: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

bottomMargin: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Especifica se a moldura de texto contém texto.

readonly hasText: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Representa o alinhamento horizontal do quadro de texto. Veja Excel.ShapeTextHorizontalAlignment para obter detalhes.

horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Representa o comportamento de excedente horizontal do quadro de texto. Veja Excel.ShapeTextHorizontalOverflow para obter detalhes.

horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

leftMargin: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Representa o ângulo para o qual o texto é orientado para a moldura de texto. Veja Excel.ShapeTextOrientation para obter detalhes.

orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Veja Excel.ShapeTextReadingOrder para obter detalhes.

readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

rightMargin: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly textRange: Excel.TextRange;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

topMargin: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Representa o alinhamento vertical do quadro de texto. Veja Excel.ShapeTextVerticalAlignment para obter detalhes.

verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Representa o comportamento de excedente vertical do quadro de texto. Veja Excel.ShapeTextVerticalOverflow para obter detalhes.

verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exclui todo o texto no quadro de texto.

deleteText(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.getItem("Textbox");
    textbox.textFrame.deleteText();
    await context.sync();
});

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.TextFrame;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TextFrame;

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.TextFrame): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.TextFrame é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TextFrameData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.TextFrameData;

Retornos