Word.TextFrame class
Representa a moldura de texto de um objeto de forma.
- Extends
Comentários
[ Conjunto de API: WordApiDesktop 1.2 ]
Propriedades
| auto |
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. |
| bottom |
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. |
| has |
Especifica se a moldura de texto contém texto. |
| left |
Representa margem esquerda, em pontos, do quadro de texto. |
| no |
Devolve Verdadeiro se o texto na moldura de texto não for rodado quando a forma for rodada. |
| orientation | Representa o ângulo para o qual o texto é orientado para a moldura de texto. Veja |
| right |
Representa margem direita, em pontos, do quadro de texto. |
| top |
Representa margem superior, em pontos, do quadro de texto. |
| vertical |
Representa o alinhamento vertical do quadro de texto. Veja |
| word |
Determina se as linhas quebram automaticamente para se ajustarem ao texto dentro da forma. |
Métodos
| 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. 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 |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar |
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: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";Valor da propriedade
Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"
Comentários
bottomMargin
Representa margem inferior, em pontos, do quadro de texto.
bottomMargin: number;Valor da propriedade
number
Comentários
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
hasText
Especifica se a moldura de texto contém texto.
readonly hasText: boolean;Valor da propriedade
boolean
Comentários
leftMargin
Representa margem esquerda, em pontos, do quadro de texto.
leftMargin: number;Valor da propriedade
number
Comentários
noTextRotation
Devolve Verdadeiro se o texto na moldura de texto não for rodado quando a forma for rodada.
noTextRotation: boolean;Valor da propriedade
boolean
Comentários
orientation
Representa o ângulo para o qual o texto é orientado para a moldura de texto. Veja Word.ShapeTextOrientation para obter detalhes.
orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";Valor da propriedade
Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"
Comentários
rightMargin
Representa margem direita, em pontos, do quadro de texto.
rightMargin: number;Valor da propriedade
number
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. Veja Word.ShapeTextVerticalAlignment para obter detalhes.
verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";Valor da propriedade
Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"
Comentários
wordWrap
Determina se as linhas quebram automaticamente para se ajustarem ao texto dentro da forma.
wordWrap: boolean;Valor da propriedade
boolean
Comentários
Detalhes do método
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?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame;Parâmetros
Fornece opções para as propriedades do objeto a 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[]): Word.TextFrame;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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;
}): Word.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
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
- Word.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: Word.TextFrame): void;Parâmetros
- properties
- Word.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 original Word.TextFrame é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TextFrameData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.TextFrameData;Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
track(): Word.TextFrame;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.
untrack(): Word.TextFrame;