Excel.StyleCollection class
Representa una colección de todos los estilos.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(name) | Agrega un nuevo estilo a la colección. |
| get |
Obtiene el número de estilos de la colección. |
| get |
Obtiene un valor |
| get |
Obtiene un estilo basándose en su posición en la colección. |
| get |
Obtiene un estilo por nombre. Si el objeto de estilo 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() | Invalida el método JavaScript |
Detalles de las propiedades
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al 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.Style[];Valor de propiedad
Detalles del método
add(name)
Agrega un nuevo estilo a la colección.
add(name: string): void;Parámetros
- name
-
string
Nombre del estilo que se va a agregar.
Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let styles = context.workbook.styles;
// Add a new style to the style collection.
// Styles is in the Home tab ribbon.
styles.add("Diagonal Orientation Style");
let newStyle = styles.getItem("Diagonal Orientation Style");
// The "Diagonal Orientation Style" properties.
newStyle.textOrientation = 38;
newStyle.autoIndent = true;
newStyle.includeProtection = true;
newStyle.shrinkToFit = true;
newStyle.locked = false;
await context.sync();
console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});
getCount()
Obtiene el número de estilos de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(name)
Obtiene un valor Style por nombre.
getItem(name: string): Excel.Style;Parámetros
- name
-
string
Nombre del estilo que se va a recuperar.
Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let styles = context.workbook.styles;
// Add a new style to the style collection.
// Styles is in the Home tab ribbon.
styles.add("Diagonal Orientation Style");
let newStyle = styles.getItem("Diagonal Orientation Style");
// The "Diagonal Orientation Style" properties.
newStyle.textOrientation = 38;
newStyle.autoIndent = true;
newStyle.includeProtection = true;
newStyle.shrinkToFit = true;
newStyle.locked = false;
await context.sync();
console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});
getItemAt(index)
Obtiene un estilo basándose en su posición en la colección.
getItemAt(index: number): Excel.Style;Parámetros
- index
-
number
Valor de índice del objeto de estilo que se va a recuperar. Indizado con cero.
Devoluciones
Comentarios
getItemOrNullObject(name)
Obtiene un estilo por nombre. Si el objeto de estilo no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(name: string): Excel.Style;Parámetros
- name
-
string
Nombre del estilo que se va a recuperar.
Devoluciones
Comentarios
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.StyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.StyleCollection;Parámetros
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.StyleCollection;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.StyleCollection;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()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.StyleCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.StyleCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.StyleCollectionData;