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