Excel.NamedSheetViewCollection class

Представляет коллекцию представлений листов на листе.

Свойства

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

Методы

add(name)	Создает новое представление листа с заданным именем.
enterTemporary()	Создание и активация нового временного представления листа. Временные представления удаляются при закрытии приложения, выходе из временного представления методом выхода или переключении на другое представление листа. Доступ к временному представлению листа также можно получить с помощью пустой строки (""), если временное представление существует.
exit()	Завершает активное представление листа.
getActive()	Получение активного в данный момент представления листа на листе.
getCount()	Получает количество представлений листов на этом листе. Включает временное представление листа, если оно существует.
getItem(key)	Получение представления листа с его именем.
getItemAt(index)	Получение представления листа по его индексу в коллекции.
getItemOrNullObject(key)	Получение представления листа с его именем. Если объекта представления листа не существует, этот метод возвращает объект со `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.NamedSheetViewCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.NamedSheetViewCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

context

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

context: RequestContext;

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

Excel.RequestContext

items

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

readonly items: Excel.NamedSheetView[];

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

Excel.NamedSheetView[]

add(name)

Создает новое представление листа с заданным именем.

add(name: string): Excel.NamedSheetView;

Параметры

name: string

Имя создаваемого представления листа. Выдает ошибку, если указанное имя уже существует, пусто или зарезервировано на листе.

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

Excel.NamedSheetView

Только что созданный объект представления листа.

enterTemporary()

Создание и активация нового временного представления листа. Временные представления удаляются при закрытии приложения, выходе из временного представления методом выхода или переключении на другое представление листа. Доступ к временному представлению листа также можно получить с помощью пустой строки (""), если временное представление существует.

enterTemporary(): Excel.NamedSheetView;

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

Excel.NamedSheetView

Только что созданный объект представления листа.

exit()

Завершает активное представление листа.

exit(): void;

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

void

getActive()

Получение активного в данный момент представления листа на листе.

getActive(): Excel.NamedSheetView;

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

Excel.NamedSheetView

Текущее представление листа для этого листа.

getCount()

Получает количество представлений листов на этом листе. Включает временное представление листа, если оно существует.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

getItem(key)

Получение представления листа с его именем.

getItem(key: string): Excel.NamedSheetView;

Параметры

key: string

Имя представления листа с учетом регистра. Используйте пустую строку (""), чтобы получить временное представление листа, если временное представление существует.

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

Excel.NamedSheetView

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

getItemAt(index)

Получение представления листа по его индексу в коллекции.

getItemAt(index: number): Excel.NamedSheetView;

Параметры

index: number

Индекс объекта представления листа в коллекции.

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

Excel.NamedSheetView

Представление листа в заданном индексе.

getItemOrNullObject(key)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

getItemOrNullObject(key: string): Excel.NamedSheetView;

Параметры

key: string

Имя представления листа с учетом регистра. Используйте пустую строку (""), чтобы получить временное представление листа, если временное представление существует.

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

Excel.NamedSheetView

Представление листа с указанным именем или временное представление, если указана пустая строка.

load(options)

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

load(options?: Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedSheetViewCollection;

Параметры

options: Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.NamedSheetViewCollection

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Excel.NamedSheetViewCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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

Excel.NamedSheetViewCollection

toJSON()

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

toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;

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

Excel.Interfaces.NamedSheetViewCollectionData

Комментарии

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

Свойства

Методы

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

context

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

items

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

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

add(name)

Параметры

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

Комментарии

enterTemporary()

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

Комментарии

exit()

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

Комментарии

getActive()

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

Комментарии

getCount()

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

Комментарии

getItem(key)

Параметры

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

Комментарии

getItemAt(index)

Параметры

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

Комментарии

getItemOrNullObject(key)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

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