Compartir a través de

Word.DocumentProperties class

  • Referencia
Paquete:
word

Representa las propiedades del documento.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

Propiedades

applicationName

Obtiene el nombre de aplicación del documento.
author

Especifica el autor del documento.
category

Especifica la categoría del documento.
comments

Especifica el campo Comentarios en los metadatos del documento. No tienen ninguna conexión con los comentarios de los usuarios realizados en el documento.
company

Especifica la empresa del documento.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
creationDate

Obtiene la fecha de creación del documento.
customProperties

Obtiene la colección de propiedades personalizadas del documento.
format

Especifica el formato del documento.
keywords

Especifica las palabras clave del documento.
lastAuthor

Obtiene el último autor del documento.
lastPrintDate

Obtiene la última fecha de impresión del documento.
lastSaveTime

Obtiene la última fecha de modificación del documento.
manager

Especifica el administrador del documento.
revisionNumber

Obtiene el número de revisión del documento.
security

Obtiene la configuración de seguridad del documento. Algunas son restricciones de acceso en el archivo en disco. Otros son la configuración de Protección de documentos. Algunos valores posibles son 0 = El archivo en disco es de lectura y escritura; 1 = Proteger documento: el archivo está cifrado y requiere una contraseña para abrirse; 2 = Proteger documento: Siempre abierto como de solo lectura; 3 = Proteger documento: tanto #1 como #2; 4 = El archivo en el disco es de solo lectura; 5 = Tanto #1 como #4; 6 = Tanto #2 como #4; 7 = Todo de #1, #2 y #4; 8 = Proteger documento: Restringir la edición a solo lectura; 9 = Tanto #1 como #8; 10 = Tanto #2 como #8; 11 = Todo de #1, #2 y #8; 12 = Tanto #4 como #8; 13 = Todo de #1, #4 y #8; 14 = Todo de #2, #4 y #8; 15 = Todo de #1, #2, #4 y #8.
subject

Especifica el asunto del documento.
template

Obtiene la plantilla del documento.
title

Especifica el título del documento.

Métodos

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(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
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 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 Word.DocumentProperties es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.DocumentPropertiesData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

applicationName

Obtiene el nombre de aplicación del documento.

readonly applicationName: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

author

Especifica el autor del documento.

author: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

category

Especifica la categoría del documento.

category: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

comments

Especifica el campo Comentarios en los metadatos del documento. No tienen ninguna conexión con los comentarios de los usuarios realizados en el documento.

comments: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

company

Especifica la empresa del documento.

company: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Word.RequestContext

creationDate

Obtiene la fecha de creación del documento.

readonly creationDate: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: WordApi 1.3 ]

customProperties

Obtiene la colección de propiedades personalizadas del documento.

readonly customProperties: Word.CustomPropertyCollection;

Valor de propiedad

Word.CustomPropertyCollection

Comentarios

[ Conjunto de API: WordApi 1.3 ]

format

Especifica el formato del documento.

format: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

keywords

Especifica las palabras clave del documento.

keywords: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

lastAuthor

Obtiene el último autor del documento.

readonly lastAuthor: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

lastPrintDate

Obtiene la última fecha de impresión del documento.

readonly lastPrintDate: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: WordApi 1.3 ]

lastSaveTime

Obtiene la última fecha de modificación del documento.

readonly lastSaveTime: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: WordApi 1.3 ]

manager

Especifica el administrador del documento.

manager: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

revisionNumber

Obtiene el número de revisión del documento.

readonly revisionNumber: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

security

Obtiene la configuración de seguridad del documento. Algunas son restricciones de acceso en el archivo en disco. Otros son la configuración de Protección de documentos. Algunos valores posibles son 0 = El archivo en disco es de lectura y escritura; 1 = Proteger documento: el archivo está cifrado y requiere una contraseña para abrirse; 2 = Proteger documento: Siempre abierto como de solo lectura; 3 = Proteger documento: tanto #1 como #2; 4 = El archivo en el disco es de solo lectura; 5 = Tanto #1 como #4; 6 = Tanto #2 como #4; 7 = Todo de #1, #2 y #4; 8 = Proteger documento: Restringir la edición a solo lectura; 9 = Tanto #1 como #8; 10 = Tanto #2 como #8; 11 = Todo de #1, #2 y #8; 12 = Tanto #4 como #8; 13 = Todo de #1, #4 y #8; 14 = Todo de #2, #4 y #8; 15 = Todo de #1, #2, #4 y #8.

readonly security: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

subject

Especifica el asunto del documento.

subject: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

template

Obtiene la plantilla del documento.

readonly template: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

title

Especifica el título del documento.

title: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties;

Parámetros

options
Word.Interfaces.DocumentPropertiesLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.DocumentProperties

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[]): Word.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

Word.DocumentProperties

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;
        }): Word.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

Word.DocumentProperties

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

properties
Word.Interfaces.DocumentPropertiesUpdateData

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: Word.DocumentProperties): void;

Parámetros

properties
Word.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 Word.DocumentProperties es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.DocumentPropertiesData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.DocumentPropertiesData;

Devoluciones

Word.Interfaces.DocumentPropertiesData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.DocumentProperties;

Devoluciones

Word.DocumentProperties

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.DocumentProperties;

Devoluciones

Word.DocumentProperties