Excel JavaScript API デスクトップのみの要件セット 1.1

ExcelApiDesktop要件セットは、Excel for Windows および Excel for Excel for Mac でのみ使用できる機能を含む特別な要件セットです。 この要件セットの API は、Windows および Mac 上の Excel アプリケーション用の運用 API と見なされます。 Microsoft 365 開発者サポート ポリシーに従います。 ExcelApiDesktop API は、他のプラットフォーム (Web や iPad など) の "プレビュー" API と見なされ、それらのプラットフォームでサポートされていない場合があります。

ExcelApiDesktop要件セットの API がすべてのプラットフォームでサポートされている場合は、次にリリースされた要件セット (ExcelApi 1.[NEXT]) に追加されます。 新しい要件セットが公開されると、これらの API もこの ExcelApiDesktop 要件セットで引き続きタグ付けされます。 一般的なプラットフォーム固有の要件の詳細については、「 プラットフォーム固有の要件セットについて」を参照してください。

重要

ExcelApiDesktop 1.1 はデスクトップのみの要件セットです。 これは ExcelApi 1.21 のスーパーセットです。

ExcelApiDesktop 1.1 API は Windows および Mac の Excel でのみサポートされるため、これらの API を呼び出す前に、アドインが要件セットがサポートされているかどうかをチェックする必要があります。 これにより、サポートされていないプラットフォームでデスクトップ専用 API を使用しようとする試みを回避できます。

if (Office.context.requirements.isSetSupported("ExcelApiDesktop", "1.1")) {
   // Any API exclusive to this ExcelApiDesktop requirement set.
}

API がクロスプラットフォーム要件セットになったら、isSetSupported チェックを削除または編集する必要があります。 これにより、他のプラットフォームでのアドインの機能が有効になります。 この変更を行う際は、必ずそれらのプラットフォームで機能をテストしてください。

重要

マニフェストでアクティブ化要件として ExcelApiDesktop 1.1 を指定できません。 これは、Set 要素で使用する有効な値ではありません。

API リスト

次の表に、現在 ExcelApiDesktop 1.1 要件セットに含まれている Excel JavaScript API を示します。 すべての Excel JavaScript API ( ExcelApiDesktop 1.1 API と以前にリリースされた API を含む) の完全な一覧については、「 すべての Excel JavaScript API」を参照してください。

クラス フィールド 説明
Application activeWindow アクティブなウィンドウ (一番上のウィンドウ) を表す window オブジェクトを返します。
checkSpelling(word: string, options?: Excel.CheckSpellingOptions) 指定された単語のスペルをチェックします。
enterEditingMode() 作業中のワークシートで選択した範囲の編集モードに入ります。
union(firstRange: Range |RangeAreas, secondRange: Range |RangeAreas, ...additionalRanges: (Range |RangeAreas)[]) 2 つ以上のRangeまたは RangeAreas オブジェクトの和集合を表すRangeAreas オブジェクトを返します。
windows 開いているすべての Excel ウィンドウを返します。
CheckSpellingOptions customDictionary 省略可能。
ignoreUppercase 省略可能。
HeaderFooter centerFooterPicture フッターの中央セクションの図を表す HeaderFooterPicture オブジェクトを取得します。
centerHeaderPicture ヘッダーの中央セクションの画像を表す HeaderFooterPicture オブジェクトを取得します。
leftFooterPicture フッターの左側セクションの図を表す HeaderFooterPicture オブジェクトを取得します。
leftHeaderPicture ヘッダーの左側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。
rightFooterPicture フッターの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。
rightHeaderPicture ヘッダーの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。
HeaderFooterPicture brightness 画像の明るさを指定します。
colorType 画像の色変換の種類を指定します。
コントラスト 画像のコントラストを指定します。
cropBottom 画像の下部から切り取られるポイントの数を指定します。
cropLeft 画像の左側から切り取られるポイントの数を指定します。
cropRight 画像の右側から切り取られるポイントの数を指定します。
cropTop 画像の上部から切り取られる点の数を指定します。
filename ソース オブジェクトが保存される場所への URL (イントラネットまたは Web) またはパス (ローカルまたはネットワーク) を指定します。
height 画像の高さをポイント単位で指定します。
lockAspectRatio サイズを変更したときに、図が元の縦横比を維持するかどうかを示す値を指定します。
width 画像の幅をポイント単位で指定します。
Image brightness 画像の明るさを指定します。
colorType 画像に適用される色変換の種類を指定します。
コントラスト 画像のコントラストを指定します。
cropBottom 画像の下部から切り取られる点の数を指定します。
cropLeft 画像の左側から切り取られる点の数を指定します。
cropRight 画像の右側から切り取られる点の数を指定します。
cropTop 画像の上部から切り取られる点の数を指定します。
incrementBrightness(increment: number) 指定した量だけ画像の明るさをインクリメントします。
incrementContrast(increment: number) 画像のコントラストを指定した量だけインクリメントします。
PageLayout alignMarginsHeaderFooter Excel がヘッダーとフッターをページ設定オプションで設定した余白に合わせるかどうかを指定します。
printQuality 水平方向と垂直方向の両方の印刷品質値を含む 2 要素の配列を指定します。
ペイン index ウィンドウのインデックスを返します。
PaneCollection getCount() コレクション内のウィンドウの数を返します。
getItemAt(index: number) インデックスでコレクションのウィンドウを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
Range checkSpelling(options?: Excel.CheckSpellingOptions) この範囲内の単語のスペルをチェックします。
formulaArray 範囲の配列数式を指定します。
showDependents(remove?: boolean) アクティブ セル (参照元) から、その値を直接参照しているセル (参照先) に向けてトレース矢印を引きます。
showPrecedents(remove?: boolean) 対象セルが直接参照しているセル (参照元) から、対象セルに向けて矢印を引きます。
Window activate() ウィンドウをアクティブにします。
activateNext() 次のウィンドウをアクティブにします。
activatePrevious() 前のウィンドウをアクティブにします。
activeCell ウィンドウ内のアクティブ セルを取得します。
activePane ウィンドウ内のアクティブなウィンドウを取得します。
activeWorksheet ウィンドウ内のアクティブなワークシートを取得します。
autoFilterDateGroupingEnabled ウィンドウでオートフィルターの日付グループ化を有効にするかどうかを指定します。
close() ウィンドウを閉じます。
enableResize ウィンドウのサイズ変更を有効にするかどうかを指定します。
freezePanes ウィンドウでウィンドウ枠を固定するかどうかを指定します。
height ウィンドウの高さを指定します。
index ウィンドウのインデックスを取得します。
isVisible ウィンドウを表示するかどうかを指定します。
largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number) ウィンドウを複数ページずつスクロールします。
left コンピューター画面の左端からウィンドウの左端までの距離をポイント単位で指定します。
name ウィンドウの名前を指定します。
newWindow() 新しい Excel ウィンドウを開きます。
ウィンドウ ウィンドウに関連付けられているウィンドウのコレクションを取得します。
pointsToScreenPixelsX(Points: number) 水平点を画面ピクセルに変換します。
pointsToScreenPixelsY(Points: number) 垂直点を画面ピクセルに変換します。
scrollColumn ウィンドウのスクロール列を指定します。
scrollIntoView(左: 数値, 上: 数値, 幅: 数値, 高さ: 数値, 開始?: ブール値) ウィンドウをスクロールして、指定した範囲を表示します。
scrollRow ウィンドウのスクロール行を指定します。
scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition) ブックのタブをスクロールします。
showFormulas 数式をウィンドウに表示するかどうかを指定します。
showGridlines 枠線をウィンドウに表示するかどうかを指定します。
showHeadings 見出しをウィンドウに表示するかどうかを指定します。
showHorizontalScrollBar 水平スクロール バーをウィンドウに表示するかどうかを指定します。
showOutline アウトラインをウィンドウに表示するかどうかを指定します。
showRightToLeft ウィンドウの右から左へのレイアウト値を取得します。
showRuler ルーラーをウィンドウに表示するかどうかを指定します。
showVerticalScrollBar 垂直スクロール バーをウィンドウに表示するかどうかを指定します。
showWhitespace ウィンドウに空白を表示するかどうかを指定します。
showWorkbookTabs ブックのタブをウィンドウに表示するかどうかを指定します。
showZeros ウィンドウにゼロを表示するかどうかを指定します。
smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number) ウィンドウを行数または列単位でスクロールします。
分割 ウィンドウの分割状態を指定します。
splitColumn ウィンドウの分割列を指定します。
splitHorizontal ウィンドウの水平方向の分割を指定します。
splitRow ウィンドウの分割行を指定します。
splitVertical ウィンドウの垂直方向の分割を指定します。
tabRatio ウィンドウのタブ縦横比を指定します。
top ウィンドウの上端から使用可能な領域 (メニューの下、上部にドッキングされたツールバー、数式バー) の上端までの距離をポイント単位で指定します。
type ウィンドウの種類を指定します。
usableHeight ウィンドウの使用可能な高さを取得します。
usableWidth ウィンドウの使用可能な幅を取得します。
view ウィンドウのビューを指定します。
visibleRange ウィンドウの表示範囲を取得します。
width ウィンドウの表示幅を指定します。
windowNumber ウィンドウ番号を取得します。
windowState ウィンドウの状態を指定します。
zoom ウィンドウの表示サイズを表す整数値を指定します。
WindowCollection breakSideBySide() ウィンドウの横並びビューを分割します。
compareCurrentSideBySideWith(windowName: string) 現在のウィンドウを指定されたウィンドウと並べて比較します。
getCount() コレクション内のウィンドウの数を取得します。
getItemAt(index: number) コレクション内のウィンドウをインデックスで取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
resetPositionsSideBySide() 横並びビューでのウィンドウの位置をリセットします。
ブック focus() ブックにフォーカスを設定します。
ワークシート checkSpelling(options?: Excel.CheckSpellingOptions) このワークシート内の単語のスペルをチェックします。
clearArrows() ワークシートからトレース矢印を削除します。
evaluate(name: string) 数式文字列の評価結果を返します。

関連項目

  • Last updated on