Excel.Window class

ブック内のウィンドウを表します。

注釈

使用元

プロパティ

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()	API オブジェクトが `JSON.stringify()` に渡されるときに、より有用な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (次に、`JSON.stringify`渡されたオブジェクトの `toJSON` メソッドを呼び出します)。元の `Excel.Window` オブジェクトが API オブジェクトであるのに対し、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.WindowData` と型指定) を返します。

activeCell

ウィンドウ内のアクティブセルを指定します。

readonly activeCell: Excel.Range;

プロパティ値

Excel.Range

注釈

API セット: ExcelApiDesktop 1.1

activePane

ウィンドウ内のアクティブなウィンドウを指定します。

readonly activePane: Excel.Pane;

プロパティ値

Excel.Pane

注釈

API セット: ExcelApiDesktop 1.1

activeWorksheet

ウィンドウで作業中のシートを指定します。

readonly activeWorksheet: Excel.Worksheet;

プロパティ値

Excel.Worksheet

注釈

API セット: ExcelApiDesktop 1.1

autoFilterDateGroupingEnabled

ウィンドウでオートフィルターの日付グループ化を有効にするかどうかを指定します。

autoFilterDateGroupingEnabled: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

enableResize

ウィンドウのサイズ変更を有効にするかどうかを指定します。

readonly enableResize: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

freezePanes

ウィンドウでウィンドウ枠を固定するかどうかを指定します。

freezePanes: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

height

ウィンドウの高さを指定します。

height: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

index

ウィンドウのインデックスを取得します。

readonly index: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

isVisible

ウィンドウを表示するかどうかを指定します。

isVisible: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

left

コンピューター画面の左端からウィンドウの左端までの距離をポイント単位で指定します。

left: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

name

ウィンドウの名前を指定します。

name: string;

プロパティ値

string

注釈

API セット: ExcelApiDesktop 1.1

panes

ウィンドウに関連付けられているウィンドウのコレクションを取得します。

readonly panes: Excel.PaneCollection;

プロパティ値

Excel.PaneCollection

注釈

API セット: ExcelApiDesktop 1.1

rangeSelection

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

ウィンドウ内の範囲の選択を取得します。

readonly rangeSelection: Excel.RangeAreas;

プロパティ値

Excel.RangeAreas

注釈

API セット: ExcelApi ベータ版 (プレビューのみ)

scrollColumn

ウィンドウのスクロール列を指定します。

scrollColumn: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

scrollRow

ウィンドウのスクロール行を指定します。

scrollRow: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

showFormulas

数式をウィンドウに表示するかどうかを指定します。

showFormulas: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showGridlines

枠線をウィンドウに表示するかどうかを指定します。

showGridlines: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showHeadings

見出しをウィンドウに表示するかどうかを指定します。

showHeadings: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showHorizontalScrollBar

水平スクロールバーをウィンドウに表示するかどうかを指定します。

showHorizontalScrollBar: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showOutline

アウトラインをウィンドウに表示するかどうかを指定します。

showOutline: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showRightToLeft

ウィンドウの右から左へのレイアウト値を取得します。 true は、ウィンドウが右から左のレイアウトを使用していることを意味し、false は、ウィンドウが左から右のレイアウトを使用していることを意味します。

readonly showRightToLeft: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showRuler

ルーラーをウィンドウに表示するかどうかを指定します。

showRuler: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showVerticalScrollBar

垂直スクロールバーをウィンドウに表示するかどうかを指定します。

showVerticalScrollBar: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showWhitespace

ウィンドウに空白を表示するかどうかを指定します。

showWhitespace: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showWorkbookTabs

ブックのタブをウィンドウに表示するかどうかを指定します。

showWorkbookTabs: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

showZeros

ウィンドウにゼロを表示するかどうかを指定します。

showZeros: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

split

ウィンドウの分割状態を指定します。

split: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApiDesktop 1.1

splitColumn

ウィンドウの分割列を指定します。

splitColumn: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

splitHorizontal

ウィンドウの水平方向の分割を指定します。

splitHorizontal: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

splitRow

ウィンドウの分割行を指定します。

splitRow: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

splitVertical

ウィンドウの垂直方向の分割を指定します。

splitVertical: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

tabRatio

ウィンドウのタブ縦横比を指定します。

tabRatio: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

top

ウィンドウの上端から使用可能な領域 (メニューの下、上部にドッキングされたツールバー、数式バー) の上端までの距離をポイント単位で指定します。

top: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

type

ウィンドウの種類を指定します。

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

プロパティ値

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

注釈

API セット: ExcelApiDesktop 1.1

usableHeight

ウィンドウの使用可能な高さを指定します。

readonly usableHeight: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

usableWidth

ウィンドウの使用可能な幅を指定します。

readonly usableWidth: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

view

ウィンドウのビューを指定します。

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

プロパティ値

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

注釈

API セット: ExcelApiDesktop 1.1

visibleRange

ウィンドウの表示範囲を取得します。

readonly visibleRange: Excel.Range;

プロパティ値

Excel.Range

注釈

API セット: ExcelApiDesktop 1.1

width

ウィンドウの表示幅を指定します。

width: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

windowNumber

ウィンドウ番号を取得します。

readonly windowNumber: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

windowState

ウィンドウの状態を指定します。

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

プロパティ値

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

注釈

API セット: ExcelApiDesktop 1.1

zoom

ウィンドウの表示サイズを表す整数値を指定します。 10 から 400 までのパーセンテージに設定できます。

zoom: number;

プロパティ値

number

注釈

API セット: ExcelApiDesktop 1.1

activate()

ウィンドウをアクティブにします。

activate(): void;

返品

void

注釈

API セット: ExcelApiDesktop 1.1

activateNext()

次のウィンドウをアクティブにします。

activateNext(): void;

返品

void

注釈

API セット: ExcelApiDesktop 1.1

activatePrevious()

前のウィンドウをアクティブにします。

activatePrevious(): void;

返品

void

注釈

API セット: ExcelApiDesktop 1.1

close()

ウィンドウを閉じます。

close(): OfficeExtension.ClientResult<boolean>;

返品

OfficeExtension.ClientResult<boolean>

注釈

API セット: ExcelApiDesktop 1.1

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

注釈

API セット: ExcelApiDesktop 1.1

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

options: Excel.Interfaces.WindowLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Excel.Window

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Excel.Window

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

注釈

API セット: ExcelApiDesktop 1.1

pointsToScreenPixelsX(Points)

水平点を画面ピクセルに変換します。

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

パラメーター

Points: number

返品

OfficeExtension.ClientResult<number>

注釈

API セット: ExcelApiDesktop 1.1

pointsToScreenPixelsY(Points)

垂直点を画面ピクセルに変換します。

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

パラメーター

Points: number

返品

OfficeExtension.ClientResult<number>

注釈

API セット: ExcelApiDesktop 1.1

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

注釈

API セット: ExcelApiDesktop 1.1

scrollWorkbookTabs(Sheets, Position)

ブックのタブをスクロールします。

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

パラメーター

Sheets: number

Position: Excel.ScrollWorkbookTabPosition

返品

void

注釈

API セット: ExcelApiDesktop 1.1

scrollWorkbookTabs(Sheets, Position)

ブックのタブをスクロールします。

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

パラメーター

Sheets: number

Position: "First" | "Last"

返品

void

注釈

API セット: ExcelApiDesktop 1.1

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

注釈

API セット: ExcelApiDesktop 1.1

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Window オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.WindowData と型指定) を返します。

toJSON(): Excel.Interfaces.WindowData;

返品

Excel.Interfaces.WindowData

注釈

使用元

プロパティ

メソッド

プロパティの詳細

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

プロパティ値

注釈