Excel.NoteCollection class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.Note[];

プロパティ値

指定されたセルに、指定された内容を含む新しいメモを追加します。

add(cellAddress: Range | string, content: any): Excel.Note;

パラメーター

返品

注釈

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 adds a note to the selected cell.
await Excel.run(async (context) => {
  const selectedRange = context.workbook.getSelectedRange();

  // Note that an InvalidArgument error is thrown if multiple cells are selected.
  context.workbook.notes.add(selectedRange, "The first note.");
  await context.sync();
});

コレクション内のノートの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

API セット: ExcelApi 1.18

セル アドレスからメモを取得します。

getItem(key: string): Excel.Note;

パラメーター

返品

指定されたセル アドレスのメモ。 指定されたセル アドレスにメモがない場合は、 ItemNotFound エラーがスローされます。

注釈

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

位置に基づいてコレクションからメモを取得します。

getItemAt(index: number): Excel.Note;

パラメーター

返品

注釈

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

セル アドレスからメモを取得します。 ノート オブジェクトが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getItemOrNullObject(key: string): Excel.Note;

パラメーター

返品

指定されたセル アドレスまたは null オブジェクトを含むメモ。

注釈

API セット: ExcelApi 1.18

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NoteCollection;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.NoteCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.NoteCollectionData として型指定された) を返します。

toJSON(): Excel.Interfaces.NoteCollectionData;

返品