Excel.TextFrame class
Representa o quadro de texto de um objeto shape.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Propriedades
| auto |
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. |
| bottom |
Representa margem inferior, em pontos, do quadro de texto. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| has |
Especifica se o quadro de texto contém texto. |
| horizontal |
Representa o alinhamento horizontal do quadro de texto. Confira |
| horizontal |
Representa o comportamento de excedente horizontal do quadro de texto. Confira |
| left |
Representa margem esquerda, em pontos, do quadro de texto. |
| orientation | Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira |
| reading |
Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Confira |
| right |
Representa margem direita, em pontos, do quadro de texto. |
| text |
Representa o texto que está anexado a uma forma, bem como propriedades e métodos para manipular o texto. Confira |
| top |
Representa margem superior, em pontos, do quadro de texto. |
| vertical |
Representa o alinhamento vertical do quadro de texto. Confira |
| vertical |
Representa o comportamento de excedente vertical do quadro de texto. Confira |
Métodos
| delete |
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 |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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.
autoSizeSetting: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";Valor da propriedade
Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"
Comentários
bottomMargin
Representa margem inferior, em pontos, do quadro de texto.
bottomMargin: number;Valor da propriedade
number
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
hasText
Especifica se o quadro de texto contém texto.
readonly hasText: boolean;Valor da propriedade
boolean
Comentários
horizontalAlignment
Representa o alinhamento horizontal do quadro de texto. Confira Excel.ShapeTextHorizontalAlignment 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
horizontalOverflow
Representa o comportamento de excedente horizontal do quadro de texto. Confira Excel.ShapeTextHorizontalOverflow detalhes.
horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";Valor da propriedade
Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"
Comentários
leftMargin
Representa margem esquerda, em pontos, do quadro de texto.
leftMargin: number;Valor da propriedade
number
Comentários
orientation
Representa o ângulo para o qual o texto é orientado para o quadro de texto. Confira Excel.ShapeTextOrientation 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
readingOrder
Representa a ordem de leitura do quadro de texto, da direita para a esquerda ou da direita para a esquerda. Confira Excel.ShapeTextReadingOrder detalhes.
readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";Valor da propriedade
Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"
Comentários
rightMargin
Representa margem direita, em pontos, do quadro de texto.
rightMargin: number;Valor da propriedade
number
Comentários
textRange
Representa o texto que está anexado a uma forma, bem como propriedades e métodos para manipular o texto. Confira Excel.TextRange detalhes.
readonly textRange: Excel.TextRange;Valor da propriedade
Comentários
topMargin
Representa margem superior, em pontos, do quadro de texto.
topMargin: number;Valor da propriedade
number
Comentários
verticalAlignment
Representa o alinhamento vertical do quadro de texto. Confira Excel.ShapeTextVerticalAlignment detalhes.
verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";Valor da propriedade
Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"
Comentários
verticalOverflow
Representa o comportamento de excedente vertical do quadro de texto. Confira Excel.ShapeTextVerticalOverflow detalhes.
verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";Valor da propriedade
Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"
Comentários
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
Fornece opções para quais propriedades do objeto carregar.
Retornos
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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.TextFrame original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TextFrameData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.TextFrameData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de