Excel.Note class

Paquete:

excel

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa una nota en el libro o hoja de cálculo.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Propiedades

authorName	Obtiene el autor de la nota.
content	Obtiene o establece el texto de la nota. La cadena debe tener menos de 256 caracteres.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
height	Especifica el alto de la nota.
visible	Especifica la visibilidad de la nota. Un valor de true significa que se muestra la nota.
width	Especifica el ancho de la nota.

Métodos

delete()	Elimina la nota.
getLocation()	Obtiene la celda donde se encuentra esta nota.
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 Excel.Note es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NoteData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

authorName

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el autor de la nota.

readonly authorName: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

content

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene o establece el texto de la nota. La cadena debe tener menos de 256 caracteres.

content: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

context

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

Excel.RequestContext

height

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica el alto de la nota.

height: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

visible

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica la visibilidad de la nota. Un valor de true significa que se muestra la nota.

visible: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

width

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica el ancho de la nota.

width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Detalles del método

delete()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Elimina la nota.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

getLocation()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la celda donde se encuentra esta nota.

getLocation(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

load(options)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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.NoteLoadOptions): Excel.Note;

Parámetros

options

Excel.Interfaces.NoteLoadOptions

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

Devoluciones

Excel.Note

load(propertyNames)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

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

Excel.Note

load(propertyNamesAndPaths)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

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

Excel.Note

set(properties, options)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

Parámetros

properties

Excel.Interfaces.NoteUpdateData

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)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.Note): void;

Parámetros

properties

Excel.Note

Devoluciones

void

toJSON()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

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

toJSON(): Excel.Interfaces.NoteData;

Devoluciones

Excel.Interfaces.NoteData