Excel.Note class

获取笔记的作者。

readonly authorName: string;

属性值

注解

[ API 集：ExcelApi 1.18 ]

获取或设置笔记的文本。

content: string;

属性值

注解

[ API 集：ExcelApi 1.18 ]

示例

// 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();
});

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

指定注释的高度。

height: number;

属性值

注解

[ API 集：ExcelApi 1.18 ]

示例

// 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();
});

指定注释的可见性。 值 表示 true 显示注释。

visible: boolean;

属性值

注解

[ API 集：ExcelApi 1.18 ]

示例

// 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: number;

属性值

注解

[ API 集：ExcelApi 1.18 ]

示例

// 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();
});

删除注释。

delete(): void;

返回

注解

[ API 集：ExcelApi 1.18 ]

示例

// 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(): Excel.Range;

返回

注解

[ API 集：ExcelApi 1.18 ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.NoteLoadOptions): Excel.Note;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.Note;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Note;

参数

返回

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.NoteUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.Note): void;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.Note对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.NoteData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.NoteData;

返回