office package
クラス
Office.TableData |
テーブルまたは Office.TableBinding 内のデータを表します。 |
OfficeExtension.ClientObject |
Office ドキュメント内のオブジェクトを表す抽象プロキシ オブジェクト。 コンテキスト (または他のプロキシ オブジェクトから) からプロキシ オブジェクトを作成し、オブジェクトを操作するコマンドをキューに追加し、 |
OfficeExtension.ClientRequestContext |
Office アプリケーションへの要求を容易にする抽象 RequestContext オブジェクト。
|
OfficeExtension.ClientResult |
プリミティブ型を返すメソッドの結果を格納します。 オブジェクトの value プロパティは、 |
OfficeExtension.EmbeddedSession |
SharePoint ページに埋め込まれた Visio ダイアグラムのセッションを表します。 詳細については、「 Visio JavaScript API の概要」を参照してください。 |
OfficeExtension.Error |
要求の処理中にエラーが発生したために promise が拒否された場合、 |
OfficeExtension.ErrorCodes |
OfficeExtension.Error.code によって返されるエラー コードを表します。 エラー コードの詳細については、「 Office Common API エラー コード」を参照してください。 |
OfficeExtension.EventHandlerResult |
イベント ハンドラーの削除を有効にします。
注: ハンドラーを削除するときは、ハンドラーが追加されたのと同じ RequestContext オブジェクトを使用する必要があります。 詳細については、「 イベント ハンドラーの削除」を参照してください。 |
OfficeExtension.EventHandlers | |
OfficeExtension.TrackedObjects |
要求コンテキスト内に含まれる追跡対象オブジェクトのコレクション。 詳細については、「 context.trackedObjects 」を参照してください。 |
インターフェイス
Office.Actions |
アクションとキーボード ショートカットを管理します。 |
Office.AddBindingFromNamedItemOptions |
作成されるバインドを構成するためのオプションを提供します。 |
Office.AddBindingFromPromptOptions |
プロンプトを構成し、作成されるバインドを識別するためのオプションを提供します。 |
Office.AddBindingFromSelectionOptions |
作成されるバインドを識別するためのオプションを提供します。 |
Office.Addin |
アドインのさまざまな側面を操作または構成するためのアドイン レベルの機能を表します。 |
Office.AddinCommands.Event |
|
Office.AddinCommands.EventCompletedOptions |
|
Office.AddinCommands.Source |
アドイン イベントのソース データをカプセル化します。 |
Office.AsyncContextOptions |
コールバックで使用するために、任意の型のコンテキスト データを変更せずに保持するためのオプションを提供します。 |
Office.AsyncResult |
要求が失敗した場合の状態やエラー情報など、非同期要求の結果をカプセル化するオブジェクト。 "Async" メソッドの |
Office.Auth |
Office Auth 名前空間 |
Office.AuthContext |
msal.js に渡すことができるユーザー情報を表します。 |
Office.AuthOptions |
Office が |
Office.BeforeDocumentCloseNotification |
ユーザーがドキュメントを閉じようとしたときに表示されるモーダル通知ダイアログを表します。 ユーザーが応答するまで、ドキュメントは閉じられません。 通知ダイアログを使用すると、ユーザーはドキュメントを閉じる要求を確認したり、ドキュメントを閉じる要求を取り消したりできます。 この API は Excel でのみサポートされています。 |
Office.Binding |
ドキュメントのセクションへのバインドを表します。 Binding オブジェクトは、型に関係なく、すべてのバインドによって所有されている機能を公開します。 Binding オブジェクトが直接呼び出されることはありません。 これは、各種類のバインドを表すオブジェクトの抽象親クラスです: Office.MatrixBinding、 Office.TableBinding、または Office.TextBinding。 これらの 3 つのオブジェクトはすべて、バインド内のデータとの対話を可能にする Binding オブジェクトから getDataAsync メソッドと setDataAsync メソッドを継承します。 また、これらのプロパティ値を照会するための ID プロパティと型プロパティも継承します。 さらに、MatrixBinding および TableBinding オブジェクトは、行数と列数をカウントする機能など、マトリックスおよびテーブル固有の機能も公開します。 |
Office.BindingDataChangedEventArgs |
DataChanged イベントが発生したバインドに関する情報を提供します。 |
Office.Bindings |
アドイン がドキュメント内に持つバインドを表します。 |
Office.BindingSelectionChangedEventArgs |
SelectionChanged イベントが発生したバインドに関する情報を提供します。 |
Office.Context |
アドインのランタイム環境を表し、API の主要なオブジェクトへのアクセスを提供します。 現在のコンテキストは、Office のプロパティとして存在します。
|
Office.ContextInformation |
アドインが実行されている環境に関する情報を提供します。 |
Office.Control |
個々のコントロールまたはコマンドと、そのコントロールが持つ必要がある状態を表します。 |
Office.CustomXmlNode |
ドキュメント内のツリーの XML ノードを表します。 |
Office.CustomXmlPart |
Office.CustomXmlParts コレクション内の 1 つの CustomXMLPart を表します。 |
Office.CustomXmlParts |
CustomXmlPart オブジェクトのコレクションを表します。 |
Office.CustomXmlPrefixMappings |
CustomXmlPart オブジェクトのコレクションを表します。 |
Office.DevicePermission |
アドインがデバイス機能にアクセスするためのアクセス許可をユーザーに要求するためのメソッドを提供します。 ユーザーのデバイス機能には、カメラ、位置情報、マイクが含まれます。 |
Office.Dialog |
|
Office.DialogMessageOptions |
ダイアログとその親の間で、どちらの方向でもメッセージを送信する方法のオプションを提供します。 |
Office.DialogOptions |
ダイアログの表示方法のオプションを提供します。 |
Office.DialogParentMessageReceivedEventArgs |
|
Office.Document |
アドインから対話操作するドキュメントを表す抽象クラス。 |
Office.DocumentSelectionChangedEventArgs |
SelectionChanged イベントが発生したドキュメントに関する情報を提供します。 |
Office.Error |
非同期的なデータ操作中に発生したエラーに関する特定の情報を提供します。 |
Office.File |
Office アドインに関連付けられているドキュメント ファイルを表します。 |
Office.FileProperties | |
Office.GetBindingDataOptions |
バインド内のデータを取得する方法のオプションを提供します。 |
Office.GetFileOptions |
ドキュメントが分割されるスライスのサイズを設定するためのオプションを提供します。 |
Office.GetSelectedDataOptions |
返されるデータと書式設定方法をカスタマイズするためのオプションを提供します。 |
Office.GoToByIdOptions |
移動先の場所を選択するかどうかを示すオプションを提供します。 |
Office.Group |
リボン タブのコントロールのグループを表します。 要件セット: RibbonAPI 1.1 |
Office.IPromiseConstructor | |
Office.MatrixBinding |
行と列の 2 次元でバインドを表現します。 |
Office.NodeDeletedEventArgs |
nodeDeleted イベントの発生元となる削除されたノードに関する情報を提供します。 |
Office.NodeInsertedEventArgs |
nodeInserted イベントの発生元となる挿入されたノードに関する情報を提供します。 |
Office.NodeReplacedEventArgs |
nodeReplaced イベントが発生した、置き換えられるノードに関する情報を提供します。 |
Office.OfficeTheme |
Office テーマの色のプロパティにアクセスできるようにします。 Office テーマの色を使用すると、アドインの配色を、ユーザーが選択した現在の Office テーマと調整できます。 ユーザーは、Office アプリケーションで File>Account または Office アカウント>Office テーマを使用してテーマを設定します。 選択したテーマが、すべての Office アプリケーションに適用されます。 Using Office theme colors is appropriate for mail and task pane add-ins. Office のテーマの詳細については、「Microsoft 365 の外観を変更する」を参照してください。 |
Office.RangeCoordinates |
セルまたは行または列を、0 から始まる行番号または列番号で指定します。 例: |
Office.RangeFormatConfiguration |
範囲とその書式設定を指定します。 |
Office.RemoveHandlerOptions |
削除されるイベント ハンドラーまたはハンドラーを決定するオプションを提供します。 |
Office.RequirementSetSupport |
現在の環境でサポートされている要件セットに関する情報を提供します。 |
Office.Ribbon |
Office リボンの状態を管理するために提供されるすべての機能を含むインターフェイス。 |
Office.RibbonUpdaterData |
ボタンの有効または無効の状態など、リボンに対する変更を指定します。 |
Office.SaveSettingsOptions |
設定を保存するためのオプションを提供します。 |
Office.SetBindingDataOptions |
バインドでデータを設定する方法のオプションを提供します。 |
Office.SetSelectedDataOptions |
選択範囲にデータを挿入する方法のオプションを提供します。 |
Office.Settings |
ホスト ドキュメントに名前/値のペアとして格納される、作業ウィンドウ アドインまたはコンテンツ アドインのカスタム設定を表します。 |
Office.SettingsChangedEventArgs |
settingsChanged イベントが発生した設定についての情報を提供します。 settingsChanged イベントのイベント ハンドラーを追加するには、 Office.Settings オブジェクトの addHandlerAsync メソッドを使用します。 settingsChanged イベントは、アドインのスクリプトが Settings.saveAsync メソッドを呼び出して、設定のメモリ内コピーをドキュメント ファイルに保持する場合にのみ発生します。 settingsChanged イベントは、Settings.set または Settings.remove メソッドが呼び出された場合にはトリガーされません。 settingsChanged イベントは、2 人以上のユーザーが共有 (共同編集) ドキュメントでアドインを使用するときに同時に設定を保存しようとしたときに、競合の可能性を処理できるように設計されています。 重要: アドインのコードは、アドインが Excel クライアントで実行されているときに settingsChanged イベントのハンドラーを登録できますが、このイベントは、Web 上の Excel で開かれたスプレッドシートでアドインが読み込まれ、複数のユーザーがスプレッドシートを編集 (共同編集) している場合にのみ発生します。 したがって、実質的に settingsChanged イベントは、共同編集シナリオでは Excel on the web でのみサポートされます。 |
Office.Slice |
ドキュメント ファイルのスライスを表します。 Slice オブジェクトには、 |
Office.Tab |
個々のタブと、そのタブに必要な状態を表します。 コード例については、「 アドイン コマンドの有効化と無効化」および 「 カスタム コンテキスト タブの作成」を参照してください。 |
Office.TableBinding |
バインドを行と列の 2 次元で、必要に応じてヘッダーと共に表します。 |
Office.TextBinding |
ドキュメント内のバインドされているテキスト選択を表します。 TextBinding オブジェクトは、 |
Office.UI |
Office アドインで、ダイアログ ボックスなどの UI コンポーネントを作成および操作するために使用できるオブジェクトとメソッドを提供します。 詳細については、「Office アドインでダイアログ API を使用する」を参照してください。 |
Office.Urls |
アドインによって使用されるランタイム環境の URL を提供します。 |
Office.VisibilityModeChangedMessage |
|
OfficeExtension.DebugInfo |
エラーに関する情報を提供します。 |
OfficeExtension.EmbeddedOptions |
SharePoint ページに埋め込まれた Visio ダイアグラムのセッションのオプションを指定します。
|
OfficeExtension.EventInfo |
イベント ハンドラーを構築するために Office によって使用されます。 コードで を呼び出さないでください。 |
OfficeExtension.LoadOption |
読み込むオブジェクトのプロパティを指定します。 この読み込みは、sync() メソッドが実行されたときに発生します。 これにより、Office オブジェクトと対応する JavaScript プロキシ オブジェクトの間で状態が同期されます。 |
OfficeExtension.RequestContextDebugInfo |
要求コンテキストに関するデバッグ情報が含まれます。 |
OfficeExtension.RequestUrlAndHeaderInfo |
要求 URL とヘッダー |
OfficeExtension.RunOptions |
|
OfficeExtension.UpdateOptions |
複数のプロパティを設定するために使用されるオブジェクトが読み取り専用プロパティを設定しようとしたときにエラーを抑制するためのオプションを提供します。 |
型エイリアス
OfficeExtension.IPromise |
列挙型
Office.ActiveView |
ユーザーがドキュメントを編集できるかどうかなど、ドキュメントのアクティブなビューの状態を指定します。 |
Office.AsyncResultStatus |
非同期呼び出しの結果を指定します。 |
Office.BindingType |
返されるバインディング オブジェクトの種類を指定します。 |
Office.CoercionType |
呼び出されたメソッドによって返される、または設定されるデータを強制的に変換する方法を指定します。 |
Office.CustomXMLNodeType |
XML ノードの種類を指定します。 |
Office.DevicePermissionType |
アドインがアクセスを要求しているデバイス機能を指定します。 |
Office.DocumentMode |
関連付けられているアプリケーションのドキュメントを読み取り専用または読み取り/書き込みのどちらかに指定します。 |
Office.EventType |
発生したイベントの種類を指定します。
Project 用アドインでは、 Outlook 用の作業ウィンドウ アドインのみが、メールボックス API セットのイベントの種類をサポートします。 |
Office.FileType |
ドキュメントを返す形式を指定します。 |
Office.FilterType |
データを取得するときに Office アプリケーションからのフィルター処理を適用するかどうかを指定します。 |
Office.GoToType |
ナビゲートする場所またはオブジェクトの種類を指定します。 |
Office.HostType |
アドインが実行されている Office アプリケーションを指定します。 |
Office.Index |
スライドの相対的なPowerPointを指定します。 |
Office.InitializationReason |
ドキュメントにアドインが挿入されたばかりであるか、既に含まれていたかを指定します。 |
Office.PlatformType |
Office アプリケーションが実行されている OS またはその他のプラットフォームを指定します。 |
Office.ProjectProjectFields |
Document.getProjectFieldAsync メソッドのパラメーターとして使用できるプロジェクト フィールドを指定します。 |
Office.ProjectResourceFields |
Document.getResourceFieldAsync メソッドのパラメーターとして使用できるリソース フィールドを指定します。 |
Office.ProjectTaskFields |
Document.getTaskFieldAsync メソッドのパラメーターとして使用できるタスク フィールドを指定します。 |
Office.ProjectViewTypes |
Document.getSelectedViewAsync メソッドが認識できるビューの種類を指定します。 |
Office.SelectionMode |
移動先の場所を選択 (強調表示) するかどうかを指定します ( Document.goToByIdAsync メソッドを使用する場合)。 |
Office.StartupBehavior |
次回の起動時にアドインの起動動作を判断するオプションを提供します。 |
Office.Table |
テーブル書式設定メソッドの cellFormat パラメーターで、 |
Office.ThemeId |
現在選択されている Office テーマを指定します。 Office のテーマの詳細については、「Microsoft 365 の外観を変更する」を参照してください。 |
Office.ValueFormat |
呼び出されたメソッドによって取得する値 (数字、日付など) に書式を設定するかどうかを指定します。書式を設定すると、その書式が適用された状態で値が返されます。 |
Office.VisibilityMode |
アドインの表示モード。 |
関数
Office. |
ランタイム環境が読み込まれ、アプリケーションやホストされたドキュメントを対話操作するアドインの準備ができたときに発生します。 initialize イベント リスナー関数の reason パラメーターは、初期化の発生方法を指定する
注: initialize イベント リスナー関数の reason パラメーターは、作業ウィンドウアドインとコンテンツ アドインの |
Office. |
指定した要件セットが Office アプリケーションでサポートされているかどうかを確認します。 |
Office. |
アドインから Office JavaScript API を呼び出す準備が整っていることを確認します。 フレームワークがまだ初期化されていない場合、コールバックまたは promise は、Office アプリケーションが API 呼び出しを受け入れる準備ができるまで待機します。 この API は Office アドイン内で使用することを目的としていますが、アドインの外部でも使用できることに注意してください。 その場合、Office.js が Office アプリケーションの外部で実行されていることを判断すると、コールバックを呼び出し、アプリケーションとプラットフォームの両方で "null" で promise を解決します。 |
Office. |
式で説明されているオブジェクトの promise を返します。 コールバックは、関数が失敗した場合にのみ呼び出されます。 |
Office. |
完全な |
関数の詳細
Office.initialize(reason)
ランタイム環境が読み込まれ、アプリケーションやホストされたドキュメントを対話操作するアドインの準備ができたときに発生します。
initialize イベント リスナー関数の reason パラメーターは、初期化の発生方法を指定する InitializationReason
列挙値を返します。 作業ウィンドウ アドインまたはコンテンツ アドインは、次の 2 つの場合に初期化できます。
ユーザーは、Office アプリケーションのリボンの [挿入] タブの [アドイン] ドロップダウン リストの [最近使用したアドイン] セクションから、または [アドインの挿入] ダイアログ ボックスから挿入しただけです。
既にアドインが含まれているドキュメントをユーザーが開いた場合。
注: initialize イベント リスナー関数の reason パラメーターは、作業ウィンドウアドインとコンテンツ アドインの InitializationReason
列挙値のみを返します。Outlook アドインの値は返されません。
export function initialize(reason: InitializationReason): void;
パラメーター
- reason
- Office.InitializationReason
アプリの初期化方法を示します。
戻り値
void
注釈
サポートの詳細
Office アプリケーションとサーバーの要件の詳細については、「 Office アドインを実行するための要件」を参照してください。
サポートされているアプリケーション (プラットフォーム別)
Office on the web | Office on Windows | Office on Mac | Office on iPad | モバイル デバイス上の Outlook | |
---|---|---|---|---|---|
秀でる | サポート | サポート | サポート | サポート | 該当なし |
前途 | サポート | サポートされている | サポートされている | サポートされている | サポートされている |
PowerPoint | サポートされている | サポートされている | サポートされている | サポート | 該当なし |
プロジェクト | 非サポート | サポートされている | サポートされている | 非サポート | 該当なし |
言葉 | サポートされている | サポートされている | サポートされている | サポート | 該当なし |
例
// You can use the value of the InitializationEnumeration to implement different logic for
// when the add-in is first inserted versus when it is already part of the document.
// The following example shows some simple logic that uses the value of the reason parameter
// to display how the task pane or content add-in was initialized.
Office.initialize = function (reason) {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, code specific to the add-in can run.
// Display initialization reason.
if (reason == "inserted")
write("The add-in was just inserted.");
if (reason == "documentOpened")
write("The add-in is already part of the document.");
});
}
// Function that writes to a div with id='message' on the page.
function write(message){
document.getElementById('message').innerText += message;
}
Office.isSetSupported(name, minVersion)
指定した要件セットが Office アプリケーションでサポートされているかどうかを確認します。
export function isSetSupported(name: string, minVersion?: string): boolean;
パラメーター
- name
-
string
名前を設定します。例: "MatrixBindings"
- minVersion
-
string
最低限必要なバージョン。例: "1.4"
戻り値
boolean
Office.onReady(callback)
アドインから Office JavaScript API を呼び出す準備が整っていることを確認します。 フレームワークがまだ初期化されていない場合、コールバックまたは promise は、Office アプリケーションが API 呼び出しを受け入れる準備ができるまで待機します。 この API は Office アドイン内で使用することを目的としていますが、アドインの外部でも使用できることに注意してください。 その場合、Office.js が Office アプリケーションの外部で実行されていることを判断すると、コールバックを呼び出し、アプリケーションとプラットフォームの両方で "null" で promise を解決します。
export function onReady(callback?: (info: { host: HostType, platform: PlatformType }) => any): Promise<{ host: HostType, platform: PlatformType }>;
パラメーター
- callback
-
(info: { host: Office.HostType, platform: Office.PlatformType }) => any
アプリケーションとプラットフォームの情報を受け取る省略可能なコールバック関数。 または、コールバックを使用するのではなく、関数から返された Promise が解決されるのを待つだけです。
戻り値
Promise<{ host: Office.HostType, platform: Office.PlatformType }>
初期化が完了すると、アプリケーションとプラットフォームの情報を含む Promise。
Office.select(expression, callback)
式で説明されているオブジェクトの promise を返します。 コールバックは、関数が失敗した場合にのみ呼び出されます。
export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;
パラメーター
- expression
-
string
取得するオブジェクト。 "bindings#BindingName" の例では、'BindingName' という名前のバインドに対するバインドの約束を取得します
- callback
-
(result: Office.AsyncResult<any>) => void
省略可能。 コールバックが戻るときに呼び出される関数。パラメーターは Office.AsyncResult 型のみです。
戻り値
注釈
サポートの詳細
Office アプリケーションとサーバーの要件の詳細については、「 Office アドインを実行するための要件」を参照してください。
サポートされているアプリケーション (プラットフォーム別)
Office on the web | Windows での Office | Office on iPad | |
---|---|---|---|
秀でる | サポート | サポートされている | サポート |
言葉 | 非サポート | サポートされている | サポート |
例
// The following code example uses the select function to retrieve a binding with the id "cities" from
// the Bindings collection, and then calls the addHandlerAsync method to add an event handler for the
// dataChanged event of the binding.
function addBindingDataChangedEventHandler() {
Office.select("bindings#cities", function onError(){}).addHandlerAsync(Office.EventType.BindingDataChanged,
function (eventArgs) {
doSomethingWithBinding(eventArgs.binding);
});
}
Office.useShortNamespace(useShortNamespace)
完全なMicrosoft.Office.WebExtension
名前空間のOffice
エイリアスのオンとオフを切り替えます。
export function useShortNamespace(useShortNamespace: boolean): void;
パラメーター
- useShortNamespace
-
boolean
True を指定すると、ショートカット エイリアスが使用されます。それ以外の場合は false を指定して無効にします。 既定値は true です。
戻り値
void
注釈
サポートの詳細
Office アプリケーションとサーバーの要件の詳細については、「 Office アドインを実行するための要件」を参照してください。
サポートされているアプリケーション (プラットフォーム別)
Office on the web | Office on Windows | Office on Mac | Office on iPad | モバイル デバイス上の Outlook | |
---|---|---|---|---|---|
秀でる | サポート | サポートされている | 非サポート | サポート | 該当なし |
前途 | サポートされている | サポート | サポートされている | サポート | サポート |
PowerPoint | サポートされている | サポート | 非サポート | サポート | 該当なし |
プロジェクト | 非サポート | サポート | 非サポート | 非サポート | 該当なし |
言葉 | サポート | サポート | 非サポート | サポート | 該当なし |
例
function startUsingShortNamespace() {
if (typeof Office === 'undefined') {
Microsoft.Office.WebExtension.useShortNamespace(true);
}
else {
Office.useShortNamespace(true);
}
write('Office alias is now ' + typeof Office);
}
function stopUsingShortNamespace() {
if (typeof Office === 'undefined') {
Microsoft.Office.WebExtension.useShortNamespace(false);
}
else {
Office.useShortNamespace(false);
}
write('Office alias is now ' + typeof Office);
}
// Function that writes to a div with id='message' on the page.
function write(message){
document.getElementById('message').innerText += message;
}
Office Add-ins