Excel.CustomProperty class
Representa una propiedad personalizada.
- 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. |
| key | Clave de la propiedad personalizada. 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). |
| type | Tipo del valor usado para la propiedad personalizada. |
| value | Valor de la propiedad personalizada. El valor está limitado a 255 caracteres fuera de Excel en la Web (los valores más grandes se recortan automáticamente a 255 caracteres en otras plataformas). |
Métodos
| delete() | Elimina la propiedad personalizada. |
| 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 de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| 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
key
Clave de la propiedad personalizada. 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).
readonly key: string;Valor de propiedad
string
Comentarios
type
Tipo del valor usado para la propiedad personalizada.
readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float";Valor de propiedad
Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"
Comentarios
value
Valor de la propiedad personalizada. El valor está limitado a 255 caracteres fuera de Excel en la Web (los valores más grandes se recortan automáticamente a 255 caracteres en otras plataformas).
value: any;Valor de propiedad
any
Comentarios
Detalles del método
delete()
Elimina la propiedad personalizada.
delete(): void;Devoluciones
void
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.CustomPropertyLoadOptions): Excel.CustomProperty;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.CustomProperty;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.CustomProperty;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 de API del mismo tipo.
set(properties: Interfaces.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.CustomPropertyUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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, en función de un objeto cargado existente.
set(properties: Excel.CustomProperty): void;Parámetros
- properties
- Excel.CustomProperty
Devoluciones
void
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.CustomProperty es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.CustomPropertyData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.CustomPropertyData;