Word.ShapeFill class

Pacote:

word

Representa a formatação de preenchimento de um objeto de forma.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Propriedades

backgroundColor	Especifica a cor de fundo do preenchimento da forma. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
foregroundColor	Especifica a cor de primeiro plano do preenchimento da forma. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.
transparency	Especifica a percentagem de transparência do preenchimento como um valor de 0,0 (opaco) a 1,0 (claro). Devolve null se o tipo de forma não suportar transparência ou se o preenchimento da forma tiver transparência inconsistente, tal como com um tipo de preenchimento com gradação de cor.
type	Retorna o tipo de preenchimento da forma. Veja Word.ShapeFillType para obter detalhes.

Métodos

clear()	Limpa a formatação de preenchimento desta forma e define-a como Word.ShapeFillType.NoFill;
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.
setSolidColor(color)	Define a formatação de preenchimento de um formato com uma cor uniforme. Esta ação altera o tipo de preenchimento para Word.ShapeFillType.Solid.
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.ShapeFill é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ShapeFillData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
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.
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.

Detalhes da propriedade

backgroundColor

Especifica a cor de fundo do preenchimento da forma. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.

backgroundColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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

Word.RequestContext

foregroundColor

Especifica a cor de primeiro plano do preenchimento da forma. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.

foregroundColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

transparency

Especifica a percentagem de transparência do preenchimento como um valor de 0,0 (opaco) a 1,0 (claro). Devolve null se o tipo de forma não suportar transparência ou se o preenchimento da forma tiver transparência inconsistente, tal como com um tipo de preenchimento com gradação de cor.

transparency: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

type

Retorna o tipo de preenchimento da forma. Veja Word.ShapeFillType para obter detalhes.

readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";

Valor da propriedade

Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Detalhes do método

clear()

Limpa a formatação de preenchimento desta forma e define-a como Word.ShapeFillType.NoFill;

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.ShapeFillLoadOptions): Word.ShapeFill;

Parâmetros

options

Word.Interfaces.ShapeFillLoadOptions

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

Retornos

Word.ShapeFill

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.ShapeFill;

Parâmetros

propertyNames

string | string[]

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

Retornos

Word.ShapeFill

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.ShapeFill;

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

Word.ShapeFill

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.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Word.Interfaces.ShapeFillUpdateData

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.ShapeFill): void;

Parâmetros

properties

Word.ShapeFill

Retornos

void

setSolidColor(color)

Define a formatação de preenchimento de um formato com uma cor uniforme. Esta ação altera o tipo de preenchimento para Word.ShapeFillType.Solid.

setSolidColor(color: string): void;

Parâmetros

color

string

Uma cadeia que representa a cor de primeiro plano de preenchimento. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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.ShapeFill é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ShapeFillData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.ShapeFillData;

Retornos

Word.Interfaces.ShapeFillData

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.ShapeFill;

Retornos

Word.ShapeFill

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.ShapeFill;

Retornos

Word.ShapeFill