Excel.ShapeFill class

Pacote:

excel

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

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
foregroundColor	Representa a cor do primeiro plano de preenchimento de forma no formato de cor HTML, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja")
transparency	Especifica o percentual de transparência do preenchimento como um valor de 0,0 (opaco) a 1,0 (claro). Retorna null se o tipo de forma não dá suporte à transparência ou o preenchimento de forma tiver transparência inconsistente, como com um tipo de preenchimento gradiente.
type	Retorna o tipo de preenchimento da forma. Confira Excel.ShapeFillType detalhes.

Métodos

clear()	Limpa a formatação do preenchimento de um objeto de forma.
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. 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.
setSolidColor(color)	Define a formatação de preenchimento de um formato com uma cor uniforme. Isso altera o tipo de preenchimento para "Sólido".
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.ShapeFill original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeFillData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

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

Excel.RequestContext

foregroundColor

Representa a cor do primeiro plano de preenchimento de forma no formato de cor HTML, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja")

foregroundColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

transparency

Especifica o percentual de transparência do preenchimento como um valor de 0,0 (opaco) a 1,0 (claro). Retorna null se o tipo de forma não dá suporte à transparência ou o preenchimento de forma tiver transparência inconsistente, como com um tipo de preenchimento gradiente.

transparency: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

type

Retorna o tipo de preenchimento da forma. Confira Excel.ShapeFillType detalhes.

readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";

Valor da propriedade

Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

clear()

Limpa a formatação do preenchimento de um objeto de forma.

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Parâmetros

options

Excel.Interfaces.ShapeFillLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.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[]): Excel.ShapeFill;

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

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

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

Excel.ShapeFill

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

Parâmetros

properties

Excel.Interfaces.ShapeFillUpdateData

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

Parâmetros

properties

Excel.ShapeFill

Retornos

void

setSolidColor(color)

Define a formatação de preenchimento de um formato com uma cor uniforme. Isso altera o tipo de preenchimento para "Sólido".

setSolidColor(color: string): void;

Parâmetros

color

string

Uma cadeia de caracteres que representa a cor de preenchimento no formato de cor HTML, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

toJSON(): Excel.Interfaces.ShapeFillData;

Retornos

Excel.Interfaces.ShapeFillData