Excel.NoteCollection class

Представляет коллекцию объектов заметок, являющихся частью книги.

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

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(cellAddress, content)	Добавляет новую заметку с данным содержимым в данной ячейке.
getCount()	Получает количество заметок в коллекции.
getItem(key)	Получает заметку по адресу ячейки.
getItemAt(index)	Получает заметку из коллекции в зависимости от своего положения.
getItemOrNullObject(key)	Получает заметку по адресу ячейки. Если объекта note не существует, этот метод возвращает объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.NoteCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.NoteCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.Note[];

Значение свойства

Excel.Note[]

add(cellAddress, content)

Добавляет новую заметку с данным содержимым в данной ячейке.

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

Параметры

cellAddress: Excel.Range | string

Ячейка, в которую добавляется заметка. Это может быть объект или строка Range , например "A1". Если строка недопустима или диапазон не содержит одну ячейку, InvalidCellAddress возникает ошибка.

content: any

Текст примечания.

Возвращаемое значение

Excel.Note

Примеры

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

Получает количество заметок в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

OfficeExtension.ClientResult<number>

getItem(key)

Получает заметку по адресу ячейки.

getItem(key: string): Excel.Note;

Параметры

key: string

Адрес ячейки заметки.

Возвращаемое значение

Excel.Note

Заметка с заданным адресом ячейки. Если нет примечания с указанным адресом ячейки, то ItemNotFound выбрасывается ошибка.

Примеры

// 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)

Получает заметку из коллекции в зависимости от своего положения.

getItemAt(index: number): Excel.Note;

Параметры

index: number

Значение индекса извлекаемой ноты. Используется нулевой индекс.

Возвращаемое значение

Excel.Note

Примеры

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

getItemOrNullObject(key)

Получает заметку по адресу ячейки. Если объекта note не существует, этот метод возвращает объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(key: string): Excel.Note;

Параметры

key: string

Адрес ячейки заметки.

Возвращаемое значение

Excel.Note

Заметка с заданным адресом ячейки или объект null.

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options: Excel.Interfaces.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Excel.NoteCollection

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Excel.NoteCollection

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Excel.NoteCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.NoteCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.NoteCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

toJSON(): Excel.Interfaces.NoteCollectionData;

Возвращаемое значение

Excel.Interfaces.NoteCollectionData

Комментарии

Используется

Примеры

Свойства

Методы

Сведения о свойстве

context

Значение свойства

items

Значение свойства

Сведения о методе

add(cellAddress, content)

Параметры

Возвращаемое значение

Комментарии

Примеры

getCount()

Возвращаемое значение

Комментарии

getItem(key)

Параметры

Возвращаемое значение

Комментарии

Примеры

getItemAt(index)

Параметры

Возвращаемое значение

Комментарии

Примеры

getItemOrNullObject(key)

Параметры

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

Обратная связь