Compartilhar via

Excel.TextFrame class

  • Referência
Pacote:
excel

Representa a moldura de texto de um objeto de forma.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

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.
bottomMargin

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

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

Especifica se a moldura de texto contém texto.
horizontalAlignment

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

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

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

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

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.
rightMargin

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

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.
topMargin

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

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

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

Métodos

deleteText()

Exclui todo o texto no quadro de texto.
load(options)

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

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

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

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)

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

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 Excel.TextFrame original é 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.

Detalhes da propriedade

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.

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

Valor da propriedade

Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

bottomMargin

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

bottomMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

context

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

Excel.RequestContext

hasText

Especifica se a moldura de texto contém texto.

readonly hasText: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

horizontalAlignment

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

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

horizontalOverflow

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

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

Valor da propriedade

Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

leftMargin

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

leftMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

orientation

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

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

readingOrder

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

Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

rightMargin

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

rightMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

textRange

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

Excel.TextRange

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

topMargin

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

topMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

verticalAlignment

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

Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

verticalOverflow

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

Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

deleteText()

Exclui todo o texto no quadro de texto.

deleteText(): void;

Retornos

void

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();
});

load(options)

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

options
Excel.Interfaces.TextFrameLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.TextFrame

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.TextFrame

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.TextFrame

set(properties, options)

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

properties
Excel.Interfaces.TextFrameUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Excel.TextFrame): void;

Parâmetros

properties
Excel.TextFrame

Retornos

void

toJSON()

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 Excel.TextFrame original é 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

Excel.Interfaces.TextFrameData