Word.Window class
ドキュメントを表示するウィンドウを表します。 1 つのウィンドウを分割して複数の閲覧ウィンドウを含めることもできます。
- Extends
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets the first paragraph of each page.
console.log("Getting first paragraph of each page...");
// Get the active window.
const activeWindow: Word.Window = context.document.activeWindow;
activeWindow.load();
// Get the active pane.
const activePane: Word.Pane = activeWindow.activePane;
activePane.load();
// Get all pages.
const pages: Word.PageCollection = activePane.pages;
pages.load();
await context.sync();
// Get page index and paragraphs of each page.
const pagesIndexes = [];
const pagesNumberOfParagraphs = [];
const pagesFirstParagraphText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
page.load("index");
pagesIndexes.push(page);
const paragraphs = page.getRange().paragraphs;
paragraphs.load("items/length");
pagesNumberOfParagraphs.push(paragraphs);
const firstParagraph = paragraphs.getFirst();
firstParagraph.load("text");
pagesFirstParagraphText.push(firstParagraph);
}
await context.sync();
for (let i = 0; i < pagesIndexes.length; i++) {
console.log(`Page index: ${pagesIndexes[i].index}`);
console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
}
});
プロパティ
| active |
ウィンドウ内のアクティブなウィンドウを取得します。 |
| are |
ウィンドウまたはウィンドウのルーラーを表示するかどうかを指定します。 |
| are |
コメント、脚注、文末脚注、およびハイパーリンクをヒントとして表示するかどうかを指定します。 |
| are |
文書内のページのサムネイル画像を Microsoft Word 文書ウィンドウの左側に表示するかどうかを指定します。 |
| caption | ドキュメントまたはアプリケーション ウィンドウのタイトル バーに表示されるウィンドウのキャプション テキストを指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| height | ウィンドウの高さを指定します (ポイント単位)。 |
| horizontal |
水平スクロール位置を文書幅の割合で指定します。 |
| ime |
日本語の入力システム (IME) の起動時の既定モードを指定します。 |
| index | コレクション内の項目の位置を取得します。 |
| is |
ウィンドウがアクティブかどうかを指定します。 |
| is |
ドキュメント マップを表示するかどうかを指定します。 |
| is |
電子メール メッセージのヘッダーをドキュメント ウィンドウに表示するかどうかを指定します。 既定値は |
| is |
ウィンドウに水平スクロール バーを表示するかどうかを指定します。 |
| is |
文書ウィンドウの左側に垂直スクロール バーを表示するかどうかを指定します。 |
| is |
印刷レイアウト表示で、文書ウィンドウの右側に垂直ルーラーを表示するかどうかを指定します。 |
| is |
ウィンドウを複数のウィンドウに分割するかどうかを指定します。 |
| is |
ウィンドウまたはウィンドウに垂直ルーラーを表示するかどうかを指定します。 |
| is |
ウィンドウに垂直スクロール バーを表示するかどうかを指定します。 |
| is |
ウィンドウを表示するかどうかを指定します。 |
| left | ウィンドウの水平方向の位置をポイント単位で指定します。 |
| next | 開いているドキュメント ウィンドウのコレクションの次のドキュメント ウィンドウを取得します。 |
| panes | ウィンドウ内のウィンドウのコレクションを取得します。 |
| previous | コレクションの開いているドキュメント ウィンドウ内の前のドキュメント ウィンドウを取得します。 |
| show |
比較および結合処理後の Microsoft Word での元文書の表示方法を指定します。 |
| split |
ウィンドウの垂直分割パーセンテージを指定します。 |
| state | ドキュメント ウィンドウまたはタスク ウィンドウの状態を指定します。 |
| style |
スタイル領域の幅をポイント単位で指定します。 |
| top | ドキュメント ウィンドウの垂直方向の位置をポイント単位で指定します。 |
| type | ウィンドウの種類を取得します。 |
| usable |
ドキュメント ウィンドウ内のアクティブな作業領域の高さ (ポイント単位) を取得します。 |
| usable |
ドキュメント ウィンドウ内のアクティブな作業領域の幅 (ポイント単位) を取得します。 |
| vertical |
垂直スクロール位置を文書の長さに対する割合で指定します。 |
| view | ウィンドウのビューを表す |
| width | ドキュメント ウィンドウの幅をポイント単位で指定します。 |
| window |
ウィンドウの位置を表す整数を取得します。 |
メソッド
| activate() | ウィンドウをアクティブにします。 |
| close(options) | ウィンドウを閉じます。 |
| large |
指定した数の画面分だけウィンドウをスクロールします。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| page |
ウィンドウをページごとにスクロールします。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
ドキュメント ウィンドウのフォーカスをメール メッセージの本文に設定します。 |
| small |
指定した行数分だけウィンドウをスクロールします。 "線" は、スクロール バーのスクロール矢印を 1 回クリックしてスクロールした距離に対応します。 |
| toggle |
リボンを表示または非表示にします。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
activePane
ウィンドウ内のアクティブなウィンドウを取得します。
readonly activePane: Word.Pane;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets the pages enclosing the viewport.
// Get the active window.
const activeWindow: Word.Window = context.document.activeWindow;
activeWindow.load();
// Get the active pane.
const activePane: Word.Pane = activeWindow.activePane;
activePane.load();
// Get pages enclosing the viewport.
const pages: Word.PageCollection = activePane.pagesEnclosingViewport;
pages.load();
await context.sync();
// Log the number of pages.
const pageCount = pages.items.length;
console.log(`Number of pages enclosing the viewport: ${pageCount}`);
// Log index info of these pages.
const pagesIndexes = [];
for (let i = 0; i < pageCount; i++) {
const page = pages.items[i];
page.load("index");
pagesIndexes.push(page);
}
await context.sync();
for (let i = 0; i < pagesIndexes.length; i++) {
console.log(`Page index: ${pagesIndexes[i].index}`);
}
});
areRulersDisplayed
ウィンドウまたはウィンドウのルーラーを表示するかどうかを指定します。
areRulersDisplayed: boolean;プロパティ値
boolean
注釈
areScreenTipsDisplayed
コメント、脚注、文末脚注、およびハイパーリンクをヒントとして表示するかどうかを指定します。
readonly areScreenTipsDisplayed: boolean;プロパティ値
boolean
注釈
areThumbnailsDisplayed
文書内のページのサムネイル画像を Microsoft Word 文書ウィンドウの左側に表示するかどうかを指定します。
areThumbnailsDisplayed: boolean;プロパティ値
boolean
注釈
caption
ドキュメントまたはアプリケーション ウィンドウのタイトル バーに表示されるウィンドウのキャプション テキストを指定します。
caption: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
height
horizontalPercentScrolled
水平スクロール位置を文書幅の割合で指定します。
horizontalPercentScrolled: number;プロパティ値
number
注釈
imeMode
日本語の入力システム (IME) の起動時の既定モードを指定します。
imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul";プロパティ値
Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"
注釈
index
isActive
isDocumentMapVisible
ドキュメント マップを表示するかどうかを指定します。
isDocumentMapVisible: boolean;プロパティ値
boolean
注釈
isEnvelopeVisible
電子メール メッセージのヘッダーをドキュメント ウィンドウに表示するかどうかを指定します。 既定値は false です。
isEnvelopeVisible: boolean;プロパティ値
boolean
注釈
isHorizontalScrollBarDisplayed
ウィンドウに水平スクロール バーを表示するかどうかを指定します。
isHorizontalScrollBarDisplayed: boolean;プロパティ値
boolean
注釈
isLeftScrollBarDisplayed
文書ウィンドウの左側に垂直スクロール バーを表示するかどうかを指定します。
isLeftScrollBarDisplayed: boolean;プロパティ値
boolean
注釈
isRightRulerDisplayed
印刷レイアウト表示で、文書ウィンドウの右側に垂直ルーラーを表示するかどうかを指定します。
isRightRulerDisplayed: boolean;プロパティ値
boolean
注釈
isSplit
isVerticalRulerDisplayed
ウィンドウまたはウィンドウに垂直ルーラーを表示するかどうかを指定します。
isVerticalRulerDisplayed: boolean;プロパティ値
boolean
注釈
isVerticalScrollBarDisplayed
ウィンドウに垂直スクロール バーを表示するかどうかを指定します。
isVerticalScrollBarDisplayed: boolean;プロパティ値
boolean
注釈
isVisible
left
next
開いているドキュメント ウィンドウのコレクションの次のドキュメント ウィンドウを取得します。
readonly next: Word.Window;プロパティ値
注釈
panes
ウィンドウ内のウィンドウのコレクションを取得します。
readonly panes: Word.PaneCollection;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets all the panes in the active document window.
// Get the active window.
const activeWindow: Word.Window = context.document.activeWindow;
activeWindow.load("panes/items/length");
await context.sync();
const panes: Word.PaneCollection = activeWindow.panes;
console.log(`Number of panes in the current document window: ${panes.items.length}`);
});
previous
コレクションの開いているドキュメント ウィンドウ内の前のドキュメント ウィンドウを取得します。
readonly previous: Word.Window;プロパティ値
注釈
showSourceDocuments
比較および結合処理後の Microsoft Word での元文書の表示方法を指定します。
showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both";プロパティ値
Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"
注釈
splitVertical
state
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ドキュメント ウィンドウまたはタスク ウィンドウの状態を指定します。
state: Word.WindowState | "Normal" | "Maximize" | "Minimize";プロパティ値
Word.WindowState | "Normal" | "Maximize" | "Minimize"
注釈
styleAreaWidth
top
ドキュメント ウィンドウの垂直方向の位置をポイント単位で指定します。
readonly top: number;プロパティ値
number
注釈
type
ウィンドウの種類を取得します。
readonly type: Word.WindowType | "Document" | "Template";プロパティ値
Word.WindowType | "Document" | "Template"
注釈
usableHeight
ドキュメント ウィンドウ内のアクティブな作業領域の高さ (ポイント単位) を取得します。
readonly usableHeight: number;プロパティ値
number
注釈
usableWidth
ドキュメント ウィンドウ内のアクティブな作業領域の幅 (ポイント単位) を取得します。
readonly usableWidth: number;プロパティ値
number
注釈
verticalPercentScrolled
垂直スクロール位置を文書の長さに対する割合で指定します。
verticalPercentScrolled: number;プロパティ値
number
注釈
view
ウィンドウのビューを表す View オブジェクトを取得します。
readonly view: Word.View;プロパティ値
注釈
width
windowNumber
メソッドの詳細
activate()
close(options)
ウィンドウを閉じます。
close(options?: Word.WindowCloseOptions): void;パラメーター
- options
- Word.WindowCloseOptions
省略可能。 閉じる前に変更を保存するかどうか、およびドキュメントをルーティングするかどうかを定義するオプション。
返品
void
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/close-document-window.yaml
await Word.run(async (context) => {
// Closes the document window, prompting to save if this is a new document.
const window: Word.Window = context.document.activeWindow;
const closeOptions: Word.WindowCloseOptions = { saveChanges: Word.SaveConfiguration.promptToSaveChanges };
console.log("About to close the document window...");
window.close(closeOptions);
});
largeScroll(options)
指定した数の画面分だけウィンドウをスクロールします。
largeScroll(options?: Word.WindowScrollOptions): void;パラメーター
- options
- Word.WindowScrollOptions
省略可能。 指定した数の画面でウィンドウをスクロールするためのオプション。 オプションが指定されていない場合、ウィンドウは 1 画面下にスクロールされます。
返品
void
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.WindowLoadOptions): Word.Window;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.Window;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Window;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
pageScroll(options)
ウィンドウをページごとにスクロールします。
pageScroll(options?: Word.WindowPageScrollOptions): void;パラメーター
- options
- Word.WindowPageScrollOptions
省略可能。 ウィンドウをページごとにスクロールするためのオプション。
返品
void
注釈
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.WindowUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.Window): void;パラメーター
- properties
- Word.Window
返品
void
setFocus()
smallScroll(options)
指定した行数分だけウィンドウをスクロールします。 "線" は、スクロール バーのスクロール矢印を 1 回クリックしてスクロールした距離に対応します。
smallScroll(options?: Word.WindowScrollOptions): void;パラメーター
- options
- Word.WindowScrollOptions
省略可能。 指定した行数だけウィンドウをスクロールするためのオプション。 オプションが指定されていない場合、ウィンドウは 1 行分下にスクロールされます。
返品
void
注釈
toggleRibbon()
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.Window オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.WindowData と型指定) を返します。
toJSON(): Word.Interfaces.WindowData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.Window;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.Window;