ExcelApiDesktop要件セットは、Excel for Windows および 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.20 のスーパーセットです。
推奨される使用方法
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 オブジェクトを返します。 |
|
| ウィンドウズ | 開いているすべての Excel ウィンドウを返します。 | |
| CheckSpellingOptions | customDictionary | 省略可能。 |
| ignoreUppercase | 省略可能。 | |
| HeaderFooter | centerFooterPicture | フッターの中央セクションの画像を表す HeaderFooterPicture オブジェクトを取得します。 |
| centerHeaderPicture | ヘッダーの中央セクションの画像を表す HeaderFooterPicture オブジェクトを取得します。 |
|
| leftFooterPicture | フッターの左側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。 |
|
| leftHeaderPicture | ヘッダーの左側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。 |
|
| rightFooterPicture | フッターの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。 |
|
| rightHeaderPicture | ヘッダーの右側のセクションの画像を表す HeaderFooterPicture オブジェクトを取得します。 |
|
| HeaderFooterPicture | 明るさ | 画像の明るさを指定します。 |
| colorType | 画像の色変換の種類を指定します。 | |
| 対照 | 画像のコントラストを指定します。 | |
| cropBottom | 図の下部からトリミングされるポイントの数を指定します。 | |
| cropLeft | 図の左側からトリミングされるポイントの数を指定します。 | |
| cropRight | 図の右側からトリミングされるポイントの数を指定します。 | |
| cropTop | 図の上部からトリミングされるポイントの数を指定します。 | |
| filename | ソース オブジェクトを保存する場所への URL (イントラネットまたは Web 上) またはパス (ローカルまたはネットワーク) を指定します。 | |
| height | 図の高さをポイント単位で指定します。 | |
| lockAspectRatio | 画像のサイズを変更したときに元の比率を保持するかどうかを示す値を指定します。 | |
| width | 図の幅をポイント単位で指定します。 | |
| Image | 明るさ | イメージの明るさを指定します。 |
| 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(Left: number, Top: number, Width: number, Height: number, Start?: boolean) | ウィンドウをスクロールして、指定した範囲を表示します。 | |
| 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) | コレクション内の Window をインデックスで取得します。 | |
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| resetPositionsSideBySide() | サイド バイ サイド ビューのウィンドウの位置をリセットします。 | |
| ブック | focus() | ブックにフォーカスを設定します。 |
| ワークシート | checkSpelling(options?: Excel.CheckSpellingOptions) | このワークシート内の単語のスペルをチェックします。 |
| clearArrows() | ワークシートからトレース矢印を削除します。 | |
| evaluate(name: string) | 数式文字列の評価結果を返します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins