Word.ShadowFormat class
Representa a formatação de sombra para uma forma ou texto no Word.
- Extends
Comentários
Propriedades
| blur | Especifica o nível de desfocagem para um formato de sombra como um valor entre 0,0 e 100,0. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| foreground |
Devolve um |
| is |
Especifica se o objeto ou a formatação aplicada ao mesmo está visível. |
| obscured |
|
| offsetX | Especifica o deslocamento horizontal (em pontos) da sombra da forma. Um valor positivo desloca a sombra para a direita da forma; um valor negativo desloca para a esquerda. |
| offsetY | Especifica o deslocamento vertical (em pontos) da sombra da forma. Um valor positivo desloca a sombra para a parte superior da forma; um valor negativo desloca-o para a parte inferior. |
| rotate |
Especifica se pretende rodar a sombra ao rodar a forma. |
| size | Especifica a largura da sombra. |
| style | Especifica o tipo de formatação de sombra a aplicar a uma forma. |
| transparency | Especifica o grau de transparência da sombra como um valor entre 0,0 (opaco) e 1,0 (claro). |
| type | Especifica o tipo de sombra da forma. |
Métodos
| increment |
Altera o desvio horizontal da sombra pelo número de pontos. Incrementar o número de pontos a ajustar. |
| increment |
Altera o deslocamento vertical da sombra pelo número especificado de pontos. Incrementar o número de pontos a ajustar. |
| 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
blur
Especifica o nível de desfocagem para um formato de sombra como um valor entre 0,0 e 100,0.
blur: 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
foregroundColor
Devolve um ColorFormat objeto que representa a cor de primeiro plano para o preenchimento, linha ou sombra.
readonly foregroundColor: Word.ColorFormat;
Valor da propriedade
Comentários
isVisible
Especifica se o objeto ou a formatação aplicada ao mesmo está visível.
isVisible: boolean;
Valor da propriedade
boolean
Comentários
obscured
true Especifica se a sombra da forma aparece preenchida e ocultada pela forma, mesmo que a forma não tenha preenchimento, false se a sombra não tiver preenchimento e o contorno da sombra ficar visível através da forma se a forma não tiver preenchimento.
obscured: boolean;
Valor da propriedade
boolean
Comentários
offsetX
Especifica o deslocamento horizontal (em pontos) da sombra da forma. Um valor positivo desloca a sombra para a direita da forma; um valor negativo desloca para a esquerda.
offsetX: number;
Valor da propriedade
number
Comentários
offsetY
Especifica o deslocamento vertical (em pontos) da sombra da forma. Um valor positivo desloca a sombra para a parte superior da forma; um valor negativo desloca-o para a parte inferior.
offsetY: number;
Valor da propriedade
number
Comentários
rotateWithShape
Especifica se pretende rodar a sombra ao rodar a forma.
rotateWithShape: boolean;
Valor da propriedade
boolean
Comentários
size
Especifica a largura da sombra.
size: number;
Valor da propriedade
number
Comentários
style
Especifica o tipo de formatação de sombra a aplicar a uma forma.
style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";
Valor da propriedade
Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"
Comentários
transparency
Especifica o grau de transparência da sombra como um valor entre 0,0 (opaco) e 1,0 (claro).
transparency: number;
Valor da propriedade
number
Comentários
type
Especifica o tipo de sombra da forma.
type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";
Valor da propriedade
Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"
Comentários
Detalhes do método
incrementOffsetX(increment)
Altera o desvio horizontal da sombra pelo número de pontos. Incrementar o número de pontos a ajustar.
incrementOffsetX(increment: number): void;
Parâmetros
- increment
-
number
Retornos
void
Comentários
incrementOffsetY(increment)
Altera o deslocamento vertical da sombra pelo número especificado de pontos. Incrementar o número de pontos a ajustar.
incrementOffsetY(increment: number): void;
Parâmetros
- increment
-
number
Retornos
void
Comentários
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.ShadowFormatLoadOptions): Word.ShadowFormat;
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.ShadowFormat;
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.ShadowFormat;
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.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.ShadowFormatUpdateData
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.ShadowFormat): void;
Parâmetros
- properties
- Word.ShadowFormat
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.ShadowFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ShadowFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.ShadowFormatData;
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.ShadowFormat;
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.ShadowFormat;