Excel.ConditionalRangeFormat class
Um objeto de formato que encapsula o tipo de letra, o preenchimento, os limites e outras propriedades do intervalo de formatos condicionais.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Propriedades
| borders | Coleção de objetos de limite que se aplicam ao intervalo de formato condicional geral. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| fill | Devolve o objeto de preenchimento definido no intervalo de formato condicional geral. |
| font | Devolve o objeto de tipo de letra definido no intervalo de formato condicional geral. |
| number |
Representa o código de formato de número do Excel para o intervalo especificado. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número. Desmarcado se |
Métodos
| clear |
Remova as propriedades de formato de uma regra de formato condicional. Esta ação cria uma regra sem definições de formato. |
| 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 |
Detalhes da propriedade
borders
Coleção de objetos de limite que se aplicam ao intervalo de formato condicional geral.
readonly borders: Excel.ConditionalRangeBorderCollection;Valor da propriedade
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
fill
Devolve o objeto de preenchimento definido no intervalo de formato condicional geral.
readonly fill: Excel.ConditionalRangeFill;Valor da propriedade
Comentários
font
Devolve o objeto de tipo de letra definido no intervalo de formato condicional geral.
readonly font: Excel.ConditionalRangeFont;Valor da propriedade
Comentários
numberFormat
Representa o código de formato de número do Excel para o intervalo especificado. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número. Desmarcado se null for transmitido.
numberFormat: any;Valor da propriedade
any
Comentários
Detalhes do método
clearFormat()
Remova as propriedades de formato de uma regra de formato condicional. Esta ação cria uma regra sem definições de formato.
clearFormat(): void;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?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;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[]): Excel.ConditionalRangeFormat;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;
}): Excel.ConditionalRangeFormat;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.ConditionalRangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
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: Excel.ConditionalRangeFormat): void;Parâmetros
- properties
- Excel.ConditionalRangeFormat
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 Excel.ConditionalRangeFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ConditionalRangeFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ConditionalRangeFormatData;