Excel.NamedItem class
Representa un nombre definido para un rango de celdas o un valor. Los nombres pueden ser objetos primitivos con nombre (como se ve en el tipo siguiente), objetos de rango o una referencia a un rango. Este objeto puede usarse para obtener un objeto de rango asociado a nombres.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.1]
Propiedades
| array |
Devuelve un objeto que contiene los valores y tipos del elemento con nombre. |
| comment | Especifica el comentario asociado a este nombre. |
| 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. |
| formula | La fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("="). |
| name | Nombre del objeto. |
| scope | Especifica si el nombre tiene un ámbito para el libro o para una hoja de cálculo específica. Los valores posibles son: Hoja de cálculo, Libro. |
| type | Especifica el tipo de valor devuelto por la fórmula del nombre. Vea |
| value | Representa el valor calculado por la fórmula del nombre. Para un rango con nombre, devolverá la dirección del rango. This API returned the #VALUE! en la interfaz de usuario de Excel si hace referencia a una función definida por el usuario. |
| value |
Una representación JSON de los valores de este elemento con nombre. A diferencia de |
| value |
Una representación JSON de los valores de este elemento con nombre. A diferencia de |
| visible | Especifica si el objeto está visible. |
| worksheet | Devuelve la hoja de cálculo que tiene como ámbito el elemento con nombre. Genera un error si el elemento se limita al libro. |
| worksheet |
Devuelve la hoja de cálculo en la que se limita el elemento con nombre. Si el elemento se limita al libro en su lugar, este método devuelve un objeto con su |
Métodos
| delete() | Elimina el nombre especificado. |
| get |
Devuelve el objeto de rango asociado al nombre. Se produce un error si el tipo del elemento con nombre no es un rango. |
| get |
Devuelve el objeto de rango asociado al nombre. Si el tipo del elemento con nombre no es un rango, 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 |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
arrayValues
Devuelve un objeto que contiene los valores y tipos del elemento con nombre.
readonly arrayValues: Excel.NamedItemArrayValues;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.7]
comment
Especifica el comentario asociado a este nombre.
comment: string;Valor de propiedad
string
Comentarios
[Conjunto de API: ExcelApi 1.4]
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
formula
La fórmula del elemento con nombre. Las fórmulas siempre comienzan con un signo igual ("=").
formula: any;Valor de propiedad
any
Comentarios
[Conjunto de API: ExcelApi 1.7]
name
Nombre del objeto.
readonly name: string;Valor de propiedad
string
Comentarios
[Conjunto de API: ExcelApi 1.1]
scope
Especifica si el nombre tiene un ámbito para el libro o para una hoja de cálculo específica. Los valores posibles son: Hoja de cálculo, Libro.
readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook";Valor de propiedad
Excel.NamedItemScope | "Worksheet" | "Workbook"
Comentarios
[Conjunto de API: ExcelApi 1.4]
type
Especifica el tipo de valor devuelto por la fórmula del nombre. Vea Excel.NamedItemType para más información.
readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";Valor de propiedad
Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"
Comentarios
[Conjunto de API: ExcelApi 1.1 para cadena, entero, doble, booleano, rango, error; 1.7 para matriz]
value
Representa el valor calculado por la fórmula del nombre. Para un rango con nombre, devolverá la dirección del rango. This API returned the #VALUE! en la interfaz de usuario de Excel si hace referencia a una función definida por el usuario.
readonly value: any;Valor de propiedad
any
Comentarios
[Conjunto de API: ExcelApi 1.1]
valueAsJson
Una representación JSON de los valores de este elemento con nombre. A diferencia de NamedItem.value, NamedItem.valueAsJson admite todos los tipos de datos que pueden estar en una celda. Algunos ejemplos son los valores numéricos con formato y las imágenes web, además de los valores estándar booleanos, numéricos y de cadena. Los datos devueltos desde esta API siempre se alinean con la configuración regional en-US. Para recuperar datos en la configuración regional de visualización del usuario, use NamedItem.valueAsJsonLocal.
readonly valueAsJson: CellValue | string;Valor de propiedad
Excel.CellValue | string
Comentarios
[Conjunto de API: ExcelApi 1.16]
valueAsJsonLocal
Una representación JSON de los valores de este elemento con nombre. A diferencia de NamedItem.value, NamedItem.valueAsJsonLocal admite todos los tipos de datos que pueden estar en una celda. Algunos ejemplos son los valores numéricos con formato y las imágenes web, además de los valores estándar booleanos, numéricos y de cadena. Los datos devueltos desde esta API siempre se alinean con la configuración regional de visualización del usuario. Para recuperar datos independientemente de la configuración regional, use NamedItem.valueAsJson.
readonly valueAsJsonLocal: CellValue | string;Valor de propiedad
Excel.CellValue | string
Comentarios
[Conjunto de API: ExcelApi 1.16]
visible
Especifica si el objeto está visible.
visible: boolean;Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.1]
worksheet
Devuelve la hoja de cálculo que tiene como ámbito el elemento con nombre. Genera un error si el elemento se limita al libro.
readonly worksheet: Excel.Worksheet;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.4]
worksheetOrNullObject
Devuelve la hoja de cálculo en la que se limita el elemento con nombre. Si el elemento se limita al libro en su lugar, 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.
readonly worksheetOrNullObject: Excel.Worksheet;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.4]
Detalles del método
delete()
Elimina el nombre especificado.
delete(): void;Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.4]
getRange()
Devuelve el objeto de rango asociado al nombre. Se produce un error si el tipo del elemento con nombre no es un rango.
getRange(): Excel.Range;Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.1]
getRangeOrNullObject()
Devuelve el objeto de rango asociado al nombre. Si el tipo del elemento con nombre no es un rango, 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.
getRangeOrNullObject(): Excel.Range;Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.4]
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.NamedItemLoadOptions): Excel.NamedItem;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.NamedItem;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?: {
select?: string;
expand?: string;
}): Excel.NamedItem;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.NamedItemUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
set(properties: Excel.NamedItem): void;Parámetros
- properties
- Excel.NamedItem
Devoluciones
void
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.NamedItem es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.NamedItemData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.NamedItemData;