Excel.RangeFill class

Código de cores HTML que representa a cor do fundo, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja")

color: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

O padrão de um intervalo. Veja Excel.FillPattern para obter detalhes. LinearGradient e RectangularGradient não são compatíveis. Um null valor indica que todo o intervalo não tem uma definição de padrão uniforme.

pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

O código de cores HTML que representa a cor do padrão de intervalo, na forma #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").

patternColor: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Especifica um duplo que ilumina ou escurece uma cor de padrão para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes patternTintAndShade .

patternTintAndShade: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Especifica um duplo que ilumina ou escurece uma cor para o preenchimento do intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que o intervalo não tem definições uniformes tintAndShade .

tintAndShade: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Redefine a tela de fundo do intervalo.

clear(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.clear();
    await context.sync(); 
});

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.RangeFillLoadOptions): Excel.RangeFill;

Parâmetros

Retornos

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

Parâmetros

Retornos

Exemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.load('color');
    await context.sync();
    console.log(rangeFill.color);
});

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

Parâmetros

Retornos

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

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.RangeFill): void;

Parâmetros

Retornos

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

toJSON(): Excel.Interfaces.RangeFillData;

Retornos