Excel.DocumentProperties class
Representa las propiedades del libro.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Propiedades
| author | Autor del libro. |
| category | Categoría del libro. |
| comments | Campo Comentarios en los metadatos del libro. No tienen ninguna conexión con los comentarios de los usuarios realizados en el libro. |
| company | La empresa del libro. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| creation |
Obtiene la fecha de creación del libro. |
| custom | Obtiene la colección de propiedades personalizadas del libro. |
| keywords | Palabras clave del libro. |
| last |
Obtiene el último autor del libro. |
| manager | Administrador del libro. |
| revision |
Obtiene el número de revisión del libro. |
| subject | Asunto del libro. |
| title | Título del libro. |
Métodos
| 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
author
Autor del libro.
author: string;Valor de propiedad
string
Comentarios
category
Categoría del libro.
category: string;Valor de propiedad
string
Comentarios
comments
Campo Comentarios en los metadatos del libro. No tienen ninguna conexión con los comentarios de los usuarios realizados en el libro.
comments: string;Valor de propiedad
string
Comentarios
company
La empresa del libro.
company: string;Valor de propiedad
string
Comentarios
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
creationDate
Obtiene la fecha de creación del libro.
readonly creationDate: Date;Valor de propiedad
Date
Comentarios
custom
Obtiene la colección de propiedades personalizadas del libro.
readonly custom: Excel.CustomPropertyCollection;Valor de propiedad
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Load the keys and values of all custom properties.
const customDocProperties = context.workbook.properties.custom;
customDocProperties.load(["key", "value"]);
await context.sync();
// Log each custom property to the console.
// Note that your document may have more properties than those you have set using this snippet.
customDocProperties.items.forEach((property) => {
console.log(`${property.key}:${property.value}`);
});
});
keywords
Palabras clave del libro.
keywords: string;Valor de propiedad
string
Comentarios
lastAuthor
Obtiene el último autor del libro.
readonly lastAuthor: string;Valor de propiedad
string
Comentarios
manager
Administrador del libro.
manager: string;Valor de propiedad
string
Comentarios
revisionNumber
Obtiene el número de revisión del libro.
revisionNumber: number;Valor de propiedad
number
Comentarios
subject
Asunto del libro.
subject: string;Valor de propiedad
string
Comentarios
title
Título del libro.
title: string;Valor de propiedad
string
Comentarios
Detalles del método
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.DocumentPropertiesLoadOptions): Excel.DocumentProperties;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.DocumentProperties;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.DocumentProperties;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.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
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.DocumentProperties): void;Parámetros
- properties
- Excel.DocumentProperties
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.DocumentProperties es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.DocumentPropertiesData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.DocumentPropertiesData;