Excel.Window class

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

activeCell	Указывает активную ячейку в окне.
activePane	Указывает активную область в окне.
activeWorksheet	Указывает активный лист в окне.
autoFilterDateGroupingEnabled	Указывает, включено ли в окне группирование дат автофильтра.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
enableResize	Указывает, включено ли изменение размера для окна.
freezePanes	Указывает, зависают ли панели в окне.
height	Задает высоту окна.
index	Возвращает индекс окна.
isVisible	Указывает, является ли окно видимым.
left	Указывает расстояние (в точках) от левого края экрана компьютера до левого края окна.
name	Указывает имя окна.
panes	Возвращает коллекцию областей, связанных с окном.
rangeSelection	Возвращает выбранный диапазон в окне.
scrollColumn	Указывает столбец прокрутки окна.
scrollRow	Указывает строку прокрутки окна.
showFormulas	Указывает, отображаются ли в окне формулы.
showGridlines	Указывает, отображаются ли в окне линии сетки.
showHeadings	Указывает, отображаются ли заголовки в окне.
showHorizontalScrollBar	Указывает, отображается ли горизонтальная полоса прокрутки в окне.
showOutline	Указывает, отображается ли в окне структура.
showRightToLeft	Возвращает значение макета окна справа налево. Значение True означает, что в окне используется макет справа налево, значение false означает, что в окне используется макет слева направо.
showRuler	Указывает, отображается ли линейка в окне.
showVerticalScrollBar	Указывает, отображается ли вертикальная полоса прокрутки в окне.
showWhitespace	Указывает, отображается ли пробел в окне.
showWorkbookTabs	Указывает, отображаются ли в окне вкладки книги.
showZeros	Указывает, отображаются ли в окне нули.
split	Указывает состояние разделения окна.
splitColumn	Указывает разделенный столбец окна.
splitHorizontal	Задает горизонтальное разделение окна.
splitRow	Указывает разделенную строку окна.
splitVertical	Задает вертикальное разделение окна.
tabRatio	Задает соотношение вкладок окна.
top	Указывает расстояние (в точках) от верхнего края окна до верхнего края пригодной области (под меню, все панели инструментов, закрепленные вверху, и строка формул).
type	Указывает тип окна.
usableHeight	Указывает пригодную высоту окна.
usableWidth	Указывает пригодную для использования ширину окна.
view	Указывает представление окна.
visibleRange	Возвращает видимый диапазон окна.
width	Задает ширину окна.
windowNumber	Возвращает номер окна.
windowState	Указывает состояние окна.
zoom	Задает целочисленное значение, представляющее размер окна. Его можно задать в процентном соотношении от 10 до 400.

Методы

activate()	Активирует окно.
activateNext()	Активирует следующее окно.
activatePrevious()	Активирует предыдущее окно.
close()	Закрывает окно.
largeScroll(Down, Up, ToRight, ToLeft)	Прокручивает окно на несколько страниц. Параметры `down`, `up`, `toRight`и `toLeft` соответствуют действию прокрутки с помощью клавиш Page Down, Page Up, ALT+Page Down и ALT+Page Up на клавиатуре.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
newWindow()	Открывает новое окно Excel.
pointsToScreenPixelsX(Points)	Преобразует горизонтальные точки в пиксели экрана.
pointsToScreenPixelsY(Points)	Преобразует вертикальные точки в пиксели экрана.
scrollIntoView(Left, Top, Width, Height, Start)	Прокручивает окно, чтобы отобразить указанный диапазон.
scrollWorkbookTabs(Sheets, Position)	Прокручивает вкладки книги.
scrollWorkbookTabs(Sheets, Position)	Прокручивает вкладки книги.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
smallScroll(Down, Up, ToRight, ToLeft)	Прокручивает окно на несколько строк или столбцов. Параметры `down`, `up`, `toRight`и `toLeft` соответствуют действию прокрутки с помощью клавиш со стрелками на клавиатуре.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.Window` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.WindowData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

activeCell

Указывает активную ячейку в окне.

readonly activeCell: Excel.Range;

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

Excel.Range

activePane

Указывает активную область в окне.

readonly activePane: Excel.Pane;

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

Excel.Pane

activeWorksheet

Указывает активный лист в окне.

readonly activeWorksheet: Excel.Worksheet;

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

Excel.Worksheet

autoFilterDateGroupingEnabled

Указывает, включено ли в окне группирование дат автофильтра.

autoFilterDateGroupingEnabled: boolean;

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

boolean

context

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

context: RequestContext;

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

Excel.RequestContext

enableResize

Указывает, включено ли изменение размера для окна.

readonly enableResize: boolean;

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

boolean

freezePanes

Указывает, зависают ли панели в окне.

freezePanes: boolean;

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

boolean

height

Задает высоту окна.

height: number;

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

number

index

Возвращает индекс окна.

readonly index: number;

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

number

isVisible

Указывает, является ли окно видимым.

isVisible: boolean;

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

boolean

left

Указывает расстояние (в точках) от левого края экрана компьютера до левого края окна.

left: number;

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

number

name

Указывает имя окна.

name: string;

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

string

panes

Возвращает коллекцию областей, связанных с окном.

readonly panes: Excel.PaneCollection;

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

Excel.PaneCollection

rangeSelection

Примечание

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

Возвращает выбранный диапазон в окне.

readonly rangeSelection: Excel.RangeAreas;

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

Excel.RangeAreas

scrollColumn

Указывает столбец прокрутки окна.

scrollColumn: number;

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

number

scrollRow

Указывает строку прокрутки окна.

scrollRow: number;

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

number

showFormulas

Указывает, отображаются ли в окне формулы.

showFormulas: boolean;

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

boolean

showGridlines

Указывает, отображаются ли в окне линии сетки.

showGridlines: boolean;

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

boolean

showHeadings

Указывает, отображаются ли заголовки в окне.

showHeadings: boolean;

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

boolean

showHorizontalScrollBar

Указывает, отображается ли горизонтальная полоса прокрутки в окне.

showHorizontalScrollBar: boolean;

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

boolean

showOutline

Указывает, отображается ли в окне структура.

showOutline: boolean;

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

boolean

showRightToLeft

Возвращает значение макета окна справа налево. Значение True означает, что в окне используется макет справа налево, значение false означает, что в окне используется макет слева направо.

readonly showRightToLeft: boolean;

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

boolean

showRuler

Указывает, отображается ли линейка в окне.

showRuler: boolean;

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

boolean

showVerticalScrollBar

Указывает, отображается ли вертикальная полоса прокрутки в окне.

showVerticalScrollBar: boolean;

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

boolean

showWhitespace

Указывает, отображается ли пробел в окне.

showWhitespace: boolean;

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

boolean

showWorkbookTabs

Указывает, отображаются ли в окне вкладки книги.

showWorkbookTabs: boolean;

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

boolean

showZeros

Указывает, отображаются ли в окне нули.

showZeros: boolean;

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

boolean

split

Указывает состояние разделения окна.

split: boolean;

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

boolean

splitColumn

Указывает разделенный столбец окна.

splitColumn: number;

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

number

splitHorizontal

Задает горизонтальное разделение окна.

splitHorizontal: number;

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

number

splitRow

Указывает разделенную строку окна.

splitRow: number;

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

number

splitVertical

Задает вертикальное разделение окна.

splitVertical: number;

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

number

tabRatio

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

tabRatio: number;

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

number

top

Указывает расстояние (в точках) от верхнего края окна до верхнего края пригодной области (под меню, все панели инструментов, закрепленные вверху, и строка формул).

top: number;

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

number

type

Указывает тип окна.

readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";

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

Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook"

usableHeight

Указывает пригодную высоту окна.

readonly usableHeight: number;

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

number

usableWidth

Указывает пригодную для использования ширину окна.

readonly usableWidth: number;

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

number

view

Указывает представление окна.

view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";

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

Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView"

visibleRange

Возвращает видимый диапазон окна.

readonly visibleRange: Excel.Range;

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

Excel.Range

width

Задает ширину окна.

width: number;

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

number

windowNumber

Возвращает номер окна.

readonly windowNumber: number;

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

number

windowState

Указывает состояние окна.

windowState: Excel.WindowState | "maximized" | "minimized" | "normal";

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

Excel.WindowState | "maximized" | "minimized" | "normal"

zoom

Задает целочисленное значение, представляющее размер окна. Его можно задать в процентном соотношении от 10 до 400.

zoom: number;

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

number

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

activate()

Активирует окно.

activate(): void;

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

void

activateNext()

Активирует следующее окно.

activateNext(): void;

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

void

activatePrevious()

Активирует предыдущее окно.

activatePrevious(): void;

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

void

close()

Закрывает окно.

close(): OfficeExtension.ClientResult<boolean>;

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

OfficeExtension.ClientResult<boolean>

largeScroll(Down, Up, ToRight, ToLeft)

Прокручивает окно на несколько страниц. Параметры down, up, toRightи toLeft соответствуют действию прокрутки с помощью клавиш Page Down, Page Up, ALT+Page Down и ALT+Page Up на клавиатуре.

largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;

Параметры

Down: number

Up: number

ToRight: number

ToLeft: number

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

void

load(options)

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

load(options?: Excel.Interfaces.WindowLoadOptions): Excel.Window;

Параметры

options: Excel.Interfaces.WindowLoadOptions

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

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

Excel.Window

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.Window

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.Window

newWindow()

Открывает новое окно Excel.

newWindow(): Excel.Window;

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

Excel.Window

pointsToScreenPixelsX(Points)

Преобразует горизонтальные точки в пиксели экрана.

pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;

Параметры

Points: number

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

OfficeExtension.ClientResult<number>

pointsToScreenPixelsY(Points)

Преобразует вертикальные точки в пиксели экрана.

pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;

Параметры

Points: number

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

OfficeExtension.ClientResult<number>

scrollIntoView(Left, Top, Width, Height, Start)

Прокручивает окно, чтобы отобразить указанный диапазон.

scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean): void;

Параметры

Left: number

Top: number

Width: number

Height: number

Start: boolean

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

void

scrollWorkbookTabs(Sheets, Position)

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

scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;

Параметры

Sheets: number

Position: Excel.ScrollWorkbookTabPosition

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

void

scrollWorkbookTabs(Sheets, Position)

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

scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;

Параметры

Sheets: number

Position: "First" | "Last"

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

void

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.WindowUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Window): void;

Параметры

properties: Excel.Window

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

void

smallScroll(Down, Up, ToRight, ToLeft)

Прокручивает окно на несколько строк или столбцов. Параметры down, up, toRightи toLeft соответствуют действию прокрутки с помощью клавиш со стрелками на клавиатуре.

smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;

Параметры

Down: number

Up: number

ToRight: number

ToLeft: number

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

void

toJSON()

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

toJSON(): Excel.Interfaces.WindowData;

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

Excel.Interfaces.WindowData

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

Была ли эта страница полезна?

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

Excel.Window class

Комментарии

Свойства

Методы

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

activeCell

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

Комментарии

activePane

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

Комментарии

activeWorksheet

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

Комментарии

autoFilterDateGroupingEnabled

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

Комментарии

context

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

enableResize

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

Комментарии

freezePanes

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

Комментарии

height

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

Комментарии

index

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

Комментарии

isVisible

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

Комментарии

left

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

Комментарии

name

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

Комментарии

panes

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

Комментарии

rangeSelection

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

Комментарии

scrollColumn

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

Комментарии

scrollRow

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

Комментарии

showFormulas

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

Комментарии

showGridlines

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

Комментарии

showHeadings

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

Комментарии

showHorizontalScrollBar

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

Комментарии

showOutline

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

Комментарии

showRightToLeft

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

Комментарии

showRuler

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

Комментарии

showVerticalScrollBar

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

Комментарии

showWhitespace

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

Комментарии