Excel.NamedSheetViewCollection class
Представляет коллекцию представлений листов на листе.
- Extends
Комментарии
[ Набор API: ExcelApiOnline 1.1 ]
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(name) | Создает представление листа с заданным именем. |
| enter |
Создает и активирует новое временное представление листа. Временные представления удаляются при закрытии приложения, выходе из временного представления с помощью метода exit или переключении в другое представление листа. Доступ к временному представлению листа также можно получить с помощью пустой строки (""), если временное представление существует. |
| exit() | Выход из текущего активного представления листа. |
| get |
Возвращает текущее активное представление листа. |
| get |
Возвращает количество представлений листа на этом листе. Включает временное представление листа, если оно существует. |
| get |
Возвращает представление листа, используя его имя. |
| get |
Возвращает представление листа по индексу в коллекции. |
| get |
Возвращает представление листа, используя его имя. Если объект представления листа не существует, то этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.NamedSheetView[];Значение свойства
Сведения о методе
add(name)
Создает представление листа с заданным именем.
add(name: string): Excel.NamedSheetView;Параметры
- name
-
string
Имя создаваемого представления листа. Выдает ошибку, если предоставленное имя уже существует, является пустым или является именем, зарезервированным листом.
Возвращаемое значение
Только что созданный объект представления листа.
Комментарии
enterTemporary()
Создает и активирует новое временное представление листа. Временные представления удаляются при закрытии приложения, выходе из временного представления с помощью метода exit или переключении в другое представление листа. Доступ к временному представлению листа также можно получить с помощью пустой строки (""), если временное представление существует.
enterTemporary(): Excel.NamedSheetView;Возвращаемое значение
Только что созданный объект представления листа.
Комментарии
exit()
Выход из текущего активного представления листа.
exit(): void;Возвращаемое значение
void
Комментарии
getActive()
Возвращает текущее активное представление листа.
getActive(): Excel.NamedSheetView;Возвращаемое значение
Текущее активное представление листа для этого листа.
Комментарии
getCount()
Возвращает количество представлений листа на этом листе. Включает временное представление листа, если оно существует.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(key)
Возвращает представление листа, используя его имя.
getItem(key: string): Excel.NamedSheetView;Параметры
- key
-
string
Имя представления листа с учетом регистра. Используйте пустую строку (""), чтобы получить временное представление листа, если временное представление существует.
Возвращаемое значение
Представление листа с заданным именем или временное представление, если была предоставлена пустая строка. Если текущее временное представление отсутствует и была указана пустая строка, ItemNotFound возникает ошибка.
Комментарии
getItemAt(index)
Возвращает представление листа по индексу в коллекции.
getItemAt(index: number): Excel.NamedSheetView;Параметры
- index
-
number
Индекс объекта представления листа в коллекции.
Возвращаемое значение
Представление листа по заданному индексу.
Комментарии
getItemOrNullObject(key)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает представление листа, используя его имя. Если объект представления листа не существует, то этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): Excel.NamedSheetView;Параметры
- key
-
string
Имя представления листа с учетом регистра. Используйте пустую строку (""), чтобы получить временное представление листа, если временное представление существует.
Возвращаемое значение
Представление листа с заданным именем или временное представление, если была предоставлена пустая строка.
Комментарии
[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedSheetViewCollection;Параметры
- options
-
Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.NamedSheetViewCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedSheetViewCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.NamedSheetViewCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.NamedSheetViewCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;Возвращаемое значение
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по