Excel.NamedItemCollection class
Colección de todos los NamedItem objetos que forman parte del libro o la hoja de cálculo, en función de cómo se haya alcanzado.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
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, reference, comment) | Agrega un nuevo nombre a la colección del ámbito especificado. |
| add |
Agrega un nuevo nombre a la colección del ámbito especificado, empleando la configuración regional del usuario para la fórmula. |
| get |
Obtiene el número de elementos con nombre de la colección. |
| get |
Obtiene un |
| get |
Obtiene un |
| 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.NamedItem[];Valor de propiedad
Detalles del método
add(name, reference, comment)
Agrega un nuevo nombre a la colección del ámbito especificado.
add(name: string, reference: Range | string, comment?: string): Excel.NamedItem;Parámetros
- name
-
string
El nombre del elemento con nombre.
- reference
-
Excel.Range | string
Fórmula o rango a los que se refiere el nombre.
- comment
-
string
Opcional. Comentario asociado al elemento con nombre.
Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.4 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const headerRange = sheet.getRange("A1:D1");
sheet.names.add("ExpensesHeader", headerRange);
const namedItems = sheet.names.load("name, type");
await context.sync();
});
addFormulaLocal(name, formula, comment)
Agrega un nuevo nombre a la colección del ámbito especificado, empleando la configuración regional del usuario para la fórmula.
addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem;Parámetros
- name
-
string
El nombre del elemento con nombre.
- formula
-
string
Fórmula de la configuración regional del usuario a la que se refiere el nombre.
- comment
-
string
Opcional. Comentario asociado al elemento con nombre.
Devoluciones
Comentarios
getCount()
Obtiene el número de elementos con nombre de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(name)
Obtiene un NamedItem objeto con su nombre.
getItem(name: string): Excel.NamedItem;Parámetros
- name
-
string
Nombre del elemento con nombre.
Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
await Excel.run(async (context) => {
const sheetName = 'Sheet1';
const nameditem = context.workbook.names.getItem(sheetName);
nameditem.load('type');
await context.sync();
console.log(nameditem.type);
});
getItemOrNullObject(name)
Obtiene un NamedItem objeto con su nombre. Si el objeto 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.NamedItem;Parámetros
- name
-
string
Nombre del elemento con nombre.
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.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection;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.NamedItemCollection;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
Ejemplos
await Excel.run(async (context) => {
const nameditems = context.workbook.names;
nameditems.load('items');
await context.sync();
for (let i = 0; i < nameditems.items.length; i++) {
console.log(nameditems.items[i].name);
}
});
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.NamedItemCollection;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.NamedItemCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NamedItemCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.NamedItemCollectionData;