Поделиться через

Excel.NoteCollection class

Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор 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();
});

Свойства

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

Комментарии

[ Набор 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()

Возвращает количество заметок в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.18 ]

getItem(key)

Возвращает заметку по адресу ячейки.

getItem(key: string): Excel.Note;

Параметры

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)

Возвращает заметку из коллекции на основе ее положения.

getItemAt(index: number): Excel.Note;

Параметры

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

getItemOrNullObject(key)

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

getItemOrNullObject(key: string): Excel.Note;

Параметры

key

string

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

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

Excel.Note

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

Комментарии

[ Набор API: ExcelApi 1.18 ]

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