Excel.Note class
Representa una nota del libro o de la hoja de cálculo.
- Extends
Comentarios
Conjunto de API: ExcelApi 1.18
Usada por
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the height and width of the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});
Propiedades
| author |
Consigue el autor de la nota. |
| content | Especifica el texto de la nota. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| height | Especifica la altura de la nota. Nota: esta propiedad no es compatible con Excel en la Web. |
| visible | Especifica la visibilidad de la nota. Un valor de |
| width | Especifica la anchura del billete. Nota: esta propiedad no es compatible con Excel en la Web. |
Métodos
| delete() | Elimina la nota. |
| get |
Obtiene la celda donde se encuentra este billete. |
| 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 |
| 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 API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
authorName
Consigue el autor de la nota.
readonly authorName: string;Valor de propiedad
string
Comentarios
content
Especifica el texto de la nota.
content: string;Valor de propiedad
string
Comentarios
Conjunto de API: ExcelApi 1.18
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the content in the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.content = "Changing the content of the first note.";
await context.sync();
});
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
height
Especifica la altura de la nota. Nota: esta propiedad no es compatible con Excel en la Web.
height: number;Valor de propiedad
number
Comentarios
Conjunto de API: ExcelApi 1.18
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the height and width of the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});
visible
Especifica la visibilidad de la nota. Un valor de true significa que se muestra el billete. Nota: esta propiedad no es compatible con Excel en la Web.
visible: boolean;Valor de propiedad
boolean
Comentarios
Conjunto de API: ExcelApi 1.18
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function sets the note on cell A1 to visible.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const firstNote = sheet.notes.getItem("A1");
firstNote.load();
await context.sync();
firstNote.visible = true;
});
width
Especifica la anchura del billete. Nota: esta propiedad no es compatible con Excel en la Web.
width: number;Valor de propiedad
number
Comentarios
Conjunto de API: ExcelApi 1.18
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the height and width of the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});
Detalles del método
delete()
Elimina la nota.
delete(): void;Devoluciones
void
Comentarios
Conjunto de API: ExcelApi 1.18
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function deletes the note from cell A2.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItem("A2");
note.delete();
await context.sync();
});
getLocation()
Obtiene la celda donde se encuentra este billete.
getLocation(): Excel.Range;Devoluciones
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.NoteLoadOptions): Excel.Note;Parámetros
- options
- Excel.Interfaces.NoteLoadOptions
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.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
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;
}): 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
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 API del mismo tipo.
set(properties: Interfaces.NoteUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.NoteUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en un objeto cargado existente.
set(properties: Excel.Note): void;Parámetros
- properties
- Excel.Note
Devoluciones
void
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Note es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.NoteData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.NoteData;