Compartir a través de

OneNote.PageContent class

  • Referencia
Paquete:
onenote

Representa una región de nivel superior en una página que contiene tipos de contenido de nivel superior, como Outline o Image. Un objeto PageContent se puede asignar a una posición XY.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

context

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

Obtiene el identificador del objeto PageContent.
image

Obtiene el elemento Image del objeto PageContent. Produce una excepción si PageContentType no es Image.
ink

Obtiene la tinta del objeto PageContent. Produce una excepción si PageContentType no es Ink.
left

Obtiene o establece la posición izquierda (eje X) del objeto PageContent.
outline

Obtiene el elemento Outline del objeto PageContent. Produce una excepción si PageContentType no es Outline.
parentPage

Obtiene la página que contiene el objeto PageContent.
top

Obtiene o establece la posición superior (eje Y) del objeto PageContent.
type

Obtiene el tipo del objeto PageContent.

Métodos

delete()

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

OneNote.RequestContext

id

Obtiene el identificador del objeto PageContent.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

image

Obtiene el elemento Image del objeto PageContent. Produce una excepción si PageContentType no es Image.

readonly image: OneNote.Image;

Valor de propiedad

OneNote.Image

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

ink

Obtiene la tinta del objeto PageContent. Produce una excepción si PageContentType no es Ink.

readonly ink: OneNote.FloatingInk;

Valor de propiedad

OneNote.FloatingInk

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

left

Obtiene o establece la posición izquierda (eje X) del objeto PageContent.

left: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

outline

Obtiene el elemento Outline del objeto PageContent. Produce una excepción si PageContentType no es Outline.

readonly outline: OneNote.Outline;

Valor de propiedad

OneNote.Outline

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

parentPage

Obtiene la página que contiene el objeto PageContent.

readonly parentPage: OneNote.Page;

Valor de propiedad

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

top

Obtiene o establece la posición superior (eje Y) del objeto PageContent.

top: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

type

Obtiene el tipo del objeto PageContent.

readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";

Valor de propiedad

OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

delete()

Elimina el objeto PageContent.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

await OneNote.run(async (context) => {

    const page = context.application.getActivePage();
    const pageContents = page.contents;

    const firstPageContent = pageContents.getItemAt(0);
    firstPageContent.load('type');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (firstPageContent.isNullObject === false) {
        firstPageContent.delete();
        await context.sync();
    }
});

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?: OneNote.Interfaces.PageContentLoadOptions): OneNote.PageContent;

Parámetros

options
OneNote.Interfaces.PageContentLoadOptions

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

Devoluciones

OneNote.PageContent

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[]): OneNote.PageContent;

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

OneNote.PageContent

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

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

OneNote.PageContent

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.PageContentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
OneNote.Interfaces.PageContentUpdateData

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: OneNote.PageContent): void;

Parámetros

properties
OneNote.PageContent

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

toJSON(): OneNote.Interfaces.PageContentData;

Devoluciones

OneNote.Interfaces.PageContentData

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.

track(): OneNote.PageContent;

Devoluciones

OneNote.PageContent

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(): OneNote.PageContent;

Devoluciones

OneNote.PageContent