Excel.NamedSheetView class

Пакет:

excel

Представляет именованное представление листа. В представлении листа хранятся правила сортировки и фильтрации для определенного листа. Каждое представление листа (даже временное) имеет уникальное имя с областью листа, которое используется для доступа к представлению.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
name	Указывает имя представления листа. Имя представления временного листа — это пустая строка (""). Присвоение представлению имени с помощью свойства name приводит к тому, что представление листа будет сохранено.

Методы

activate()	Активирует это представление листа. Это эквивалентно использованию функции "Переключиться на" в пользовательском интерфейсе Excel.
delete()	Удаляет представление листа с листа.
duplicate(name)	Создает копию этого представления листа.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.NamedSheetView объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.NamedSheetViewData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

name

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

name: string;

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

string

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

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

activate()

Активирует это представление листа. Это эквивалентно использованию функции "Переключиться на" в пользовательском интерфейсе Excel.

activate(): void;

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

delete()

Удаляет представление листа с листа.

delete(): void;

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

void

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

duplicate(name)

Создает копию этого представления листа.

duplicate(name?: string): Excel.NamedSheetView;

Параметры

name

string

Имя повторяющегося представления листа. Если имя не указано, оно будет создано.

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

Excel.NamedSheetView

Новое, дублированное представление листа.

Комментарии

[ Набор API: ExcelApiOnline 1.1 ]

load(options)

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

load(options?: Excel.Interfaces.NamedSheetViewLoadOptions): Excel.NamedSheetView;

Параметры

options

Excel.Interfaces.NamedSheetViewLoadOptions

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

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

Excel.NamedSheetView

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.NamedSheetView

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NamedSheetView;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

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

Excel.NamedSheetView

toJSON()

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

toJSON(): Excel.Interfaces.NamedSheetViewData;

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

Excel.Interfaces.NamedSheetViewData