Excel.NoteCollection class
Representa una colección de objetos de nota que forman parte del libro.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.18 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(cell |
Agrega una nueva nota con el contenido especificado en la celda especificada. |
| get |
Obtiene el número de notas de la colección. |
| get |
Obtiene una nota por su dirección de celda. |
| get |
Obtiene una nota de la colección en función de su posición. |
| get |
Obtiene una nota por su dirección de celda. Si el objeto note no existe, este método devuelve un objeto con su |
| 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 |
| toJSON() | Invalida el método JavaScript |
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
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.Note[];Valor de propiedad
Detalles del método
add(cellAddress, content)
Agrega una nueva nota con el contenido especificado en la celda especificada.
add(cellAddress: Range | string, content: any): Excel.Note;Parámetros
- cellAddress
-
Excel.Range | string
Celda a la que se agrega la nota. Puede ser un Range objeto o una cadena como "A1". Si la cadena no es válida o el intervalo no es una sola celda, se produce un InvalidCellAddress error.
- content
-
any
Texto de la nota.
Devoluciones
Comentarios
getCount()
Obtiene el número de notas de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(key)
Obtiene una nota por su dirección de celda.
getItem(key: string): Excel.Note;Parámetros
- key
-
string
Dirección de celda de la nota.
Devoluciones
Nota con la dirección de celda especificada. Si no hay ninguna nota con la dirección de celda especificada, se produce el ItemNotFound error.
Comentarios
getItemAt(index)
Obtiene una nota de la colección en función de su posición.
getItemAt(index: number): Excel.Note;Parámetros
- index
-
number
Valor de índice de la nota que se va a recuperar. Indizado con cero.
Devoluciones
Comentarios
getItemOrNullObject(key)
Obtiene una nota por su dirección de celda. Si el objeto note no existe, este método devuelve 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).
getItemOrNullObject(key: string): Excel.Note;Parámetros
- key
-
string
Dirección de celda de la nota.
Devoluciones
Nota con la dirección de celda especificada o el objeto NULL.
Comentarios
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.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;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.NoteCollection;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?: OfficeExtension.LoadOption): Excel.NoteCollection;Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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 Excel.NoteCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NoteCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.NoteCollectionData;