Excel.ConditionalFormatCollection class
Representa una colección de todos los formatos condicionales que se superponen al rango.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.6]
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(type) | Agrega un nuevo formato condicional a la colección en la prioridad primera/superior. |
| add(type) | Agrega un nuevo formato condicional a la colección en la prioridad primera/superior. |
| clear |
Borra todos los formatos condicionales activos en el intervalo actual especificado. |
| get |
Devuelve el número de formatos condicionales del libro. |
| get |
Devuelve un formato condicional para el identificador especificado. |
| get |
Devuelve un formato condicional en el índice especificado. |
| get |
Devuelve un formato condicional identificado por su identificador. Si el objeto de formato condicional no existe, este método devuelve un objeto con su |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.ConditionalFormat[];Valor de propiedad
Detalles del método
add(type)
Agrega un nuevo formato condicional a la colección en la prioridad primera/superior.
add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;Parámetros
El tipo de formato condicional que se va a agregar. Vea Excel.ConditionalFormatType para más información.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.6]
add(type)
Agrega un nuevo formato condicional a la colección en la prioridad primera/superior.
add(type: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat;Parámetros
- type
-
"Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
El tipo de formato condicional que se va a agregar. Vea Excel.ConditionalFormatType para más información.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.6]
clearAll()
Borra todos los formatos condicionales activos en el intervalo actual especificado.
clearAll(): void;Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.6]
getCount()
Devuelve el número de formatos condicionales del libro.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
[Conjunto de API: ExcelApi 1.6]
getItem(id)
Devuelve un formato condicional para el identificador especificado.
getItem(id: string): Excel.ConditionalFormat;Parámetros
- id
-
string
El identificador del formato condicional.
Devoluciones
Objeto de formato condicional.
Comentarios
[Conjunto de API: ExcelApi 1.6]
getItemAt(index)
Devuelve un formato condicional en el índice especificado.
getItemAt(index: number): Excel.ConditionalFormat;Parámetros
- index
-
number
Índice de los formatos condicionales que se recuperarán.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.6]
getItemOrNullObject(id)
Devuelve un formato condicional identificado por su identificador. Si el objeto de formato condicional no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getItemOrNullObject(id: string): Excel.ConditionalFormat;Parámetros
- id
-
string
El identificador del formato condicional.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.14]
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;Parámetros
- options
-
Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.ConditionalFormatCollection;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ConditionalFormatCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.ConditionalFormatCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;