Compartir a través de


Word.Page class

Representa una página del documento. Page los objetos administran el diseño y el contenido de la página.

Extends

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Propiedades

context

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

height

Obtiene el alto, en puntos, del papel definido en el cuadro de diálogo Configurar página.

index

Obtiene el índice de la página. El índice de página está basado en 1 e independiente de la numeración de páginas personalizada del usuario.

width

Obtiene el ancho, en puntos, del papel definido en el cuadro de diálogo Configurar página.

Métodos

getNext()

Obtiene la página siguiente del panel. Produce un ItemNotFound error si esta página es la última.

getNextOrNullObject()

Obtiene la página siguiente. Si esta página es la última, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getRange(rangeLocation)

Obtiene toda la página, o el punto inicial o final de la página, como un intervalo.

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.

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.Page es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.PageData) 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

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

height

Obtiene el alto, en puntos, del papel definido en el cuadro de diálogo Configurar página.

readonly height: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

index

Obtiene el índice de la página. El índice de página está basado en 1 e independiente de la numeración de páginas personalizada del usuario.

readonly index: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

width

Obtiene el ancho, en puntos, del papel definido en el cuadro de diálogo Configurar página.

readonly width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Detalles del método

getNext()

Obtiene la página siguiente del panel. Produce un ItemNotFound error si esta página es la última.

getNext(): Word.Page;

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getNextOrNullObject()

Obtiene la página siguiente. Si esta página es la última, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getNextOrNullObject(): Word.Page;

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getRange(rangeLocation)

Obtiene toda la página, o el punto inicial o final de la página, como un intervalo.

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

Parámetros

rangeLocation

whole | start | end | "Whole" | "Start" | "End"

Opcional. La ubicación del intervalo debe ser "Whole", "Start" o "End".

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

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

Parámetros

options
Word.Interfaces.PageLoadOptions

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

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

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

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

toJSON(): Word.Interfaces.PageData;

Devoluciones

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.Page;

Devoluciones

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.Page;

Devoluciones