Excel.CustomPropertyCollection class
Contiene la colección de propiedades personalizadas.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.7]
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(key, value) | Crea una nueva propiedad personalizada o establece una existente. |
| delete |
Elimina todas las propiedades personalizadas de la colección. |
| get |
Obtiene el recuento de las propiedades personalizadas. |
| get |
Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Genera un error si la propiedad personalizada no existe. |
| get |
Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Si la propiedad personalizada 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.CustomProperty[];Valor de propiedad
Detalles del método
add(key, value)
Crea una nueva propiedad personalizada o establece una existente.
add(key: string, value: any): Excel.CustomProperty;Parámetros
- key
-
string
Obligatorio. La clave de la propiedad personalizada, que no distingue mayúsculas de minúsculas. La clave está limitada a 255 caracteres fuera de Excel en la Web (las teclas más grandes se recortan automáticamente a 255 caracteres en otras plataformas).
- value
-
any
Obligatorio. El valor de la propiedad personalizada. El valor está limitado a 255 caracteres por fuera de Excel en la Web (los valores mayores se recortan automáticamente a 255 caracteres en otras plataformas).
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.7]
deleteAll()
Elimina todas las propiedades personalizadas de la colección.
deleteAll(): void;Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.7]
getCount()
Obtiene el recuento de las propiedades personalizadas.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
[Conjunto de API: ExcelApi 1.7]
getItem(key)
Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Genera un error si la propiedad personalizada no existe.
getItem(key: string): Excel.CustomProperty;Parámetros
- key
-
string
La clave que identifica el objeto de propiedad personalizada.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.7]
getItemOrNullObject(key)
Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas. Si la propiedad personalizada 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(key: string): Excel.CustomProperty;Parámetros
- key
-
string
Obligatorio. La clave que identifica el objeto de propiedad personalizada.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.7]
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.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection;Parámetros
- options
-
Excel.Interfaces.CustomPropertyCollectionLoadOptions & 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.CustomPropertyCollection;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.CustomPropertyCollection;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.CustomPropertyCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.CustomPropertyCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Excel.Interfaces.CustomPropertyCollectionData;