Excel.ConditionalFormat class
Um objeto que encapsula o intervalo, o formato, a regra e outras propriedades de um formato condicional. Para saber mais sobre o modelo de objeto de formatação condicional, leia Aplicar formatação condicional a intervalos do Excel.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.6]
Propriedades
| cell |
Retorna as propriedades de formato condicional do valor da célula se o formato condicional atual é um |
| cell |
Retorna as propriedades de formato condicional do valor da célula se o formato condicional atual é um |
| color |
Retorna as propriedades de formato condicional da escala de cores se o formato condicional atual for um |
| color |
Retorna as propriedades de formato condicional da escala de cores se o formato condicional atual for um |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| custom | Retorna as propriedades de formato condicional personalizadas se o formato condicional atual for um tipo personalizado. |
| custom |
Retorna as propriedades de formato condicional personalizadas se o formato condicional atual for um tipo personalizado. |
| data |
Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados. |
| data |
Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados. |
| icon |
Retorna as propriedades de formato condicional do conjunto de ícones se o formato condicional atual for um |
| icon |
Retorna as propriedades de formato condicional do conjunto de ícones se o formato condicional atual for um |
| id | A prioridade do formato condicional no arquivo . |
| preset | Retorna o formato condicional dos critérios predefinidos. Veja |
| preset |
Retorna o formato condicional dos critérios predefinidos. Veja |
| priority | A prioridade (ou índice) dentro da coleção de formato condicional em que esse formato condicional existe atualmente. Alterar isso também altera as prioridades de outros formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma prioridade negativa para começar de trás. Prioridades maiores que os limites serão obtidas e definidas como prioridade máxima (ou mínima, se negativa). Observe também que, se você alterar a prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele. |
| stop |
Se as condições desse formato condicional forem atendidas, nenhum formato de prioridade mais baixa terá efeito nessa célula. O valor está |
| text |
Retorna as propriedades de formato condicional de texto específicas se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células correspondentes à palavra "Texto". |
| text |
Retorna as propriedades de formato condicional de texto específicas se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células correspondentes à palavra "Texto". |
| top |
Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um |
| top |
Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um |
| type | Um tipo de formato condicional. Somente um pode ser definido por vez. |
Métodos
| change |
Altere o tipo de regra de formato condicional para valor de célula. |
| change |
Altere o tipo de regra de formato condicional para escala de cores. |
| change |
Altere o tipo de regra de formato condicional para comparação de texto. |
| change |
Altere o tipo de regra de formato condicional para personalizado. |
| change |
Altere o tipo de regra de formato condicional para barra de dados. |
| change |
Altere o tipo de regra de formato condicional para conjunto de ícones. |
| change |
Altere o tipo de regra de formato condicional para critérios predefinidos. |
| change |
Altere o tipo de regra de formato condicional para superior/inferior. |
| delete() | Exclui esse formato condicional. |
| get |
Retorna o intervalo ao qual o formatato condicional é aplicada. Lançará um erro se o formato condicional for aplicado a vários intervalos. |
| get |
Retorna o intervalo ao qual o formato condicional é aplicado. Se o formato condicional for aplicado a vários intervalos, esse método retornará um objeto com sua |
| get |
Retorna o |
| 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. 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. |
| set |
Defina os intervalos aos quais a regra de formato condicional é aplicada. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
cellValue
Retorna as propriedades de formato condicional do valor da célula se o formato condicional atual é um CellValue tipo.
readonly cellValue: Excel.CellValueConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
cellValueOrNullObject
Retorna as propriedades de formato condicional do valor da célula se o formato condicional atual é um CellValue tipo.
readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
colorScale
Retorna as propriedades de formato condicional da escala de cores se o formato condicional atual for um ColorScale tipo.
readonly colorScale: Excel.ColorScaleConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
colorScaleOrNullObject
Retorna as propriedades de formato condicional da escala de cores se o formato condicional atual for um ColorScale tipo.
readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
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
custom
Retorna as propriedades de formato condicional personalizadas se o formato condicional atual for um tipo personalizado.
readonly custom: Excel.CustomConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
customOrNullObject
Retorna as propriedades de formato condicional personalizadas se o formato condicional atual for um tipo personalizado.
readonly customOrNullObject: Excel.CustomConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
dataBar
Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados.
readonly dataBar: Excel.DataBarConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
dataBarOrNullObject
Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados.
readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
iconSet
Retorna as propriedades de formato condicional do conjunto de ícones se o formato condicional atual for um IconSet tipo.
readonly iconSet: Excel.IconSetConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
iconSetOrNullObject
Retorna as propriedades de formato condicional do conjunto de ícones se o formato condicional atual for um IconSet tipo.
readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
id
A prioridade do formato condicional no arquivo .ConditionalFormatCollection
readonly id: string;Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.6]
preset
Retorna o formato condicional dos critérios predefinidos. Veja Excel.PresetCriteriaConditionalFormat para obter detalhes.
readonly preset: Excel.PresetCriteriaConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
presetOrNullObject
Retorna o formato condicional dos critérios predefinidos. Veja Excel.PresetCriteriaConditionalFormat para obter detalhes.
readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
priority
A prioridade (ou índice) dentro da coleção de formato condicional em que esse formato condicional existe atualmente. Alterar isso também altera as prioridades de outros formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma prioridade negativa para começar de trás. Prioridades maiores que os limites serão obtidas e definidas como prioridade máxima (ou mínima, se negativa). Observe também que, se você alterar a prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele.
priority: number;Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.6]
stopIfTrue
Se as condições desse formato condicional forem atendidas, nenhum formato de prioridade mais baixa terá efeito nessa célula. O valor está null nas barras de dados, conjuntos de ícones e escalas de cores, pois não há conceito para StopIfTrue eles.
stopIfTrue: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.6]
textComparison
Retorna as propriedades de formato condicional de texto específicas se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células correspondentes à palavra "Texto".
readonly textComparison: Excel.TextConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
textComparisonOrNullObject
Retorna as propriedades de formato condicional de texto específicas se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células correspondentes à palavra "Texto".
readonly textComparisonOrNullObject: Excel.TextConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
topBottom
Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um TopBottom tipo. Por exemplo, para formatar os 10% principais ou os 10 itens inferiores.
readonly topBottom: Excel.TopBottomConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
topBottomOrNullObject
Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um TopBottom tipo. Por exemplo, para formatar os 10% principais ou os 10 itens inferiores.
readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.6]
type
Um tipo de formato condicional. Somente um pode ser definido por vez.
readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";Valor da propriedade
Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
Comentários
[Conjunto de apis: ExcelApi 1.6]
Detalhes do método
changeRuleToCellValue(properties)
Altere o tipo de regra de formato condicional para valor de célula.
changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;Parâmetros
- properties
- Excel.ConditionalCellValueRule
As propriedades a serem definidas para a regra de formato condicional do valor da célula.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
changeRuleToColorScale()
Altere o tipo de regra de formato condicional para escala de cores.
changeRuleToColorScale(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
changeRuleToContainsText(properties)
Altere o tipo de regra de formato condicional para comparação de texto.
changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;Parâmetros
- properties
- Excel.ConditionalTextComparisonRule
As propriedades a serem definidas para a regra de formato condicional de comparação de texto.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
changeRuleToCustom(formula)
Altere o tipo de regra de formato condicional para personalizado.
changeRuleToCustom(formula: string): void;Parâmetros
- formula
-
string
A fórmula a ser definida para a regra de formato condicional personalizado.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
changeRuleToDataBar()
Altere o tipo de regra de formato condicional para barra de dados.
changeRuleToDataBar(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
changeRuleToIconSet()
Altere o tipo de regra de formato condicional para conjunto de ícones.
changeRuleToIconSet(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
changeRuleToPresetCriteria(properties)
Altere o tipo de regra de formato condicional para critérios predefinidos.
changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;Parâmetros
- properties
- Excel.ConditionalPresetCriteriaRule
As propriedades a serem definidas para a regra de formato condicional de critérios predefinidos.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
changeRuleToTopBottom(properties)
Altere o tipo de regra de formato condicional para superior/inferior.
changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;Parâmetros
- properties
- Excel.ConditionalTopBottomRule
As propriedades a serem definidas para a regra de formato condicional superior/inferior.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
delete()
Exclui esse formato condicional.
delete(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.6]
getRange()
Retorna o intervalo ao qual o formatato condicional é aplicada. Lançará um erro se o formato condicional for aplicado a vários intervalos.
getRange(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.6]
getRangeOrNullObject()
Retorna o intervalo ao qual o formato condicional é aplicado. Se o formato condicional for aplicado a vários intervalos, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getRangeOrNullObject(): Excel.Range;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.6]
getRanges()
Retorna o RangeAreas, que compreende um ou mais intervalos retangulares, ao qual o formato condicional é aplicado.
getRanges(): Excel.RangeAreas;Retornos
Comentários
[Conjunto de apis: 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.ConditionalFormatLoadOptions): Excel.ConditionalFormat;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
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[]): Excel.ConditionalFormat;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
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;
}): Excel.ConditionalFormat;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
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.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.ConditionalFormatUpdateData
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 de propriedades tentar definir 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.ConditionalFormat): void;Parâmetros
- properties
- Excel.ConditionalFormat
Retornos
void
setRanges(ranges)
Defina os intervalos aos quais a regra de formato condicional é aplicada.
setRanges(ranges: Range | RangeAreas | string): void;Parâmetros
- ranges
-
Excel.Range | Excel.RangeAreas | string
Coleção de um ou mais intervalos aos quais essa regra será aplicada.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.17]
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.ConditionalFormat é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ConditionalFormatData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ConditionalFormatData;