office package

クラス

Office.TableData	テーブルまたは Office.TableBinding 内のデータを表します。
OfficeExtension.ClientObject	Office ドキュメント内のオブジェクトを表す抽象プロキシオブジェクト。コンテキストから (または他のプロキシオブジェクトから) プロキシオブジェクトを作成し、そのオブジェクトを操作するコマンドをキューに追加してから、 `context.sync()` を呼び出してプロキシオブジェクトの状態をドキュメントと同期します。
OfficeExtension.ClientRequestContext	Office アプリケーションへの要求を容易にする抽象的な RequestContext オブジェクト。 `Excel.run` メソッドと `Word.run` メソッドは、要求コンテキストを提供します。
OfficeExtension.ClientResult	プリミティブ型を返すメソッドの結果を格納します。オブジェクトの値プロパティは、 `context.sync()` が呼び出された後にドキュメントから取得されます。
OfficeExtension.EmbeddedSession	SharePoint ページに埋め込まれた Visio ダイアグラムのセッションを表します。詳細については、「 Visio JavaScript API の概要」を参照してください。
OfficeExtension.Error	要求の処理中にエラーが発生したために Promise が拒否された場合に、 `context.sync()` によって返されるエラーオブジェクト。
OfficeExtension.ErrorCodes	OfficeExtension.Error.code によって返される可能性があるエラーコードを表します。エラーコードの詳細については、「 Office 共通 API エラーコード」を参照してください。
OfficeExtension.EventHandlerResult	イベントハンドラーの削除を有効にします。 `EventHandlers.add` メソッドによって返されます。注: ハンドラーを削除するときは、ハンドラーが追加されたのと同じ RequestContext オブジェクトを使用する必要があります。詳細については、「イベントハンドラーの削除」を参照してください。
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects	要求コンテキスト内に含まれる、追跡対象オブジェクトのコレクション。詳細については、 context.trackedObjects を参照してください。

インターフェイス

Office.Actions	アクションとキーボードショートカットを管理します。
Office.AddBindingFromNamedItemOptions	作成されるバインドを構成するためのオプションを指定します。
Office.AddBindingFromPromptOptions	プロンプトを構成し、作成されるバインドを識別するためのオプションを提供します。
Office.AddBindingFromSelectionOptions	作成されるバインドを識別するためのオプションを提供します。
Office.Addin	アドインのさまざまな側面を操作または構成するためのアドインレベルの機能を表します。
Office.AddinCommands.Event	`Event` オブジェクトは、関数コマンドボタンによって呼び出されるアドイン関数にパラメーターとして渡されます。オブジェクトを使用すると、アドインはどのボタンがクリックされたかを識別し、処理が完了したことを Office アプリケーションに通知することができます。
Office.AddinCommands.EventCompletedOptions	Outlook でイベントの処理が完了したときの、送信時アドインオンライン会議プロバイダーアドインまたはメモログモバイルアドインの動作を指定します。
Office.AddinCommands.Source	アドインイベントのソースデータをカプセル化します。
Office.AsyncContextOptions	コールバックで使用するために、任意の種類のコンテキストデータを変更されないまま保持するためのオプションを提供します。
Office.AsyncResult	要求が失敗した場合の状態やエラー情報など、非同期要求の結果をカプセル化するオブジェクト。 "Async" メソッドの `callback` パラメーターに渡した関数が実行されると、 `callback` 関数の唯一のパラメーターからアクセスできる AsyncResult オブジェクトを受け取ります。
Office.Auth	`Office.auth` 、Office 認証名前空間は、Office クライアントアプリケーションがアドインの Web アプリケーションへのアクセストークンを取得するためのメソッドを提供します。これにより、間接的に、サインインしたユーザーの Microsoft Graph データにアドインがアクセスできるようにもなります。ユーザーがもう一度サインインする必要はありません。
Office.AuthContext	JavaScript 用 Microsoft 認証ライブラリ (MSAL.js) に渡すことができるユーザー情報を表します。
Office.AuthOptions	Office が `getAccessToken` メソッドを使用して AAD v. 2.0 からアドインへのアクセストークンを取得するときのユーザーエクスペリエンスのオプションを提供します。
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.context` を使用してアクセスします。
Office.ContextInformation	アドインが実行されている環境に関する情報を提供します。
Office.ContextMenu	Office コンテキストメニューの状態を管理するためのオプションを提供します。詳細については、「アドインコマンドの可用性を変更する」を参照してください。
Office.ContextMenuControl	個々のコンテキストメニューコントロールとその状態を表します。詳細については、「アドインコマンドの可用性を変更する」を参照してください。
Office.ContextMenuUpdaterData	コンテキストメニューへの変更を表します。詳細については、「アドインコマンドの可用性を変更する」を参照してください。
Office.Control	個々のコントロールまたはコマンド、およびそれに必要な状態を表します。
Office.CustomXmlNode	ドキュメント内のツリーの XML ノードを表します。
Office.CustomXmlPart	Office.CustomXmlParts コレクション内の単一の CustomXMLPart を表します。
Office.CustomXmlParts	CustomXmlPart オブジェクトのコレクションを表します。
Office.CustomXmlPrefixMappings	CustomXmlPart オブジェクトのコレクションを表します。
Office.DevicePermission	アドインがデバイス機能にアクセスするためのアクセス許可をユーザーに要求するメソッドを提供します。ユーザーのデバイス機能には、カメラ、位置情報、マイクが含まれます。
Office.Dialog	`UI.displayDialogAsync` が呼び出されると返されるオブジェクト。イベントハンドラーを登録してダイアログを閉じるためのメソッドを公開します。
Office.DialogMessageOptions	ダイアログとその親の間でどちらの方向でもメッセージを送信する方法のオプションを提供します。
Office.DialogOptions	ダイアログの表示方法のオプションを指定します。
Office.DialogParentMessageReceivedEventArgs	`DialogParentMessageReceived` イベントを発生させた親ページからのメッセージに関する情報を提供します。 `DialogParentMessageReceived` イベントのイベントハンドラーを追加するには、Office.UI オブジェクトの `addHandlerAsync` メソッドを使用します。
Office.Document	アドインから対話操作するドキュメントを表す抽象クラス。
Office.DocumentSelectionChangedEventArgs	SelectionChanged イベントが発生したドキュメントに関する情報を提供します。
Office.Error	非同期的なデータ操作中に発生したエラーに関する特定の情報を提供します。
Office.ExtensionLifeCycle	アドインの実行中に Office アドインのユーザーインターフェイスを管理するためのオプションを提供します。
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 アカウント>Office テーマを使用して Office アプリケーションでテーマを設定します。選択したテーマは、すべての Office アプリケーションに適用されます。 Using Office theme colors is appropriate for mail and task pane add-ins. Office テーマの詳細については、「 Microsoft 365 の外観を変更する」を参照してください。
Office.OnReadyOptions	`onReady` イベントに関連するオプションを提供します。
Office.RangeCoordinates	0 から始まる行番号または列番号で、セル、行、または列を指定します。例: `{row: 3, column: 4}` は、4 列目 (ゼロから始まる) の 3 行目 (ゼロから始まる) のセルを指定します。
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 イベントのハンドラーをアドインのコードで登録できますが、イベントが発生するのは、Excel on the web で開かれたスプレッドシートでアドインが読み込まれ、複数のユーザーがスプレッドシートを編集 (共同編集) している場合のみです。したがって、事実上、settingsChanged イベントは、共同編集シナリオの Excel on the web でのみサポートされます。
Office.Slice	ドキュメントファイルのスライスを表します。スライスオブジェクトには、 `File.getSliceAsync` メソッドを使用してアクセスします。
Office.Slide	PowerPoint プレゼンテーションの 1 枚のスライドを表します。このインターフェイスは、Office.CoercionType.SlideRange で呼び出されたときに Office.Document.getSelectedDataAsync によって返される Office.SlideRange オブジェクトの一部として使用されます。
Office.SlideRange	PowerPoint プレゼンテーションで選択したスライドを表示します。このオブジェクトは、PowerPoint で Office.CoercionType.SlideRange を使用して Office.Document.getSelectedDataAsync を呼び出すときに返されます。
Office.Tab	個々のタブと、必要な状態を表します。コード例については、「アドインコマンドの可用性を変更する」および「カスタムコンテキストタブを作成する」を参照してください。
Office.TableBinding	バインドを行と列の 2 次元で、必要に応じてヘッダーと共に表します。
Office.TaskPane	アドインの作業ウィンドウを管理するメソッドを提供します。
Office.TextBinding	ドキュメント内のバインドされているテキスト選択を表します。 TextBinding オブジェクトは、 `id` プロパティ、type プロパティ、getDataAsync メソッド、および setDataAsync メソッドを Office.Binding オブジェクトから継承します。これ以外に、このオブジェクトが独自に実装するプロパティやメソッドはありません。
Office.UI	Office アドインでダイアログボックスなどの UI コンポーネントを作成および操作するためのオブジェクトとメソッドを提供します。ダイアログボックスの構成方法の詳細については、「 Office アドインでダイアログ API を使用する」を参照してください。
Office.Urls	アドインで使用されるランタイム環境の URL を提供します。
Office.VisibilityModeChangedMessage	`onVisibilityModeChanged`呼び出しで使用されたメッセージ。
OfficeExtension.DebugInfo	エラーに関する情報を提供します。
OfficeExtension.EmbeddedOptions	SharePoint ページに埋め込まれた Visio ダイアグラムのセッションのオプションを指定します。 `EmbeddedSession` のコンストラクターによって呼び出されます。詳細については、「 Visio JavaScript API の概要」を参照してください。
OfficeExtension.EventInfo	Office でイベントハンドラーを構築するために使用されます。コードを呼び出さないでください。
OfficeExtension.LoadOption	読み込むオブジェクトのプロパティを指定します。このロードは、sync() メソッドが実行されたときに発生します。これにより、Office オブジェクトと対応する JavaScript プロキシオブジェクトとの間の状態が同期されます。
OfficeExtension.RequestContextDebugInfo	要求コンテキストに関するデバッグ情報を格納します。
OfficeExtension.RequestUrlAndHeaderInfo	要求の URL とヘッダー
OfficeExtension.RunOptions	`{Host}.run(...)` に渡される追加オプション。
OfficeExtension.UpdateOptions	複数のプロパティの設定に使用されるオブジェクトが読み取り専用プロパティを設定しようとしたときにエラーを抑制するオプションを提供します。

型エイリアス

OfficeExtension.IPromise

列挙型

Office.ActiveView	ユーザーがドキュメントを編集できるかどうかなど、ドキュメントのアクティブなビューの状態を指定します。
Office.AsyncResultStatus	非同期呼び出しの結果を指定します。
Office.BindingType	返されるバインディングオブジェクトの種類を指定します。
Office.CoercionType	呼び出されたメソッドによって返される、または設定されるデータを強制的に変換する方法を指定します。
Office.CustomXMLNodeType	XML ノードのタイプを指定します。
Office.DevicePermissionType	アドインがアクセスを要求しているデバイス機能を指定します。
Office.DocumentMode	関連付けられているアプリケーションのドキュメントを読み取り専用または読み取り/書き込みのどちらかに指定します。
Office.EventType	発生したイベントの種類を指定します。 `*EventArgs` オブジェクトの `type` プロパティによって返されます。 Project 用アドインは、 `Office.EventType.ResourceSelectionChanged`、 `Office.EventType.TaskSelectionChanged`、および `Office.EventType.ViewSelectionChanged` のイベントの種類をサポートしています。 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 パラメーターの `cells` プロパティの列挙値を指定します。
Office.ThemeId	現在選択されている Office テーマを指定します。 Office テーマの詳細については、「 Microsoft 365 の外観を変更する」を参照してください。
Office.ValueFormat	呼び出されたメソッドによって取得する値 (数字、日付など) に書式を設定するかどうかを指定します。書式を設定すると、その書式が適用された状態で値が返されます。
Office.VisibilityMode	アドインの表示モード。

関数

Office.initialize(reason)	ランタイム環境が読み込まれ、アプリケーションやホストされたドキュメントを対話操作するアドインの準備ができたときに発生します。初期化イベントリスナー関数の reason パラメーターは、初期化がどのように行われたかを指定する `InitializationReason` 列挙値を返します。作業ウィンドウアドインまたはコンテンツアドインは、次の 2 つの場合に初期化できます。 Office アプリケーションのリボンの [挿入] タブにある [アドイン] ドロップダウンリストの [最近使ったアドイン] セクションか、[アドインの挿入] ダイアログボックスから挿入したばかりです。既にアドインが含まれているドキュメントをユーザーが開いた場合。注: イベントリスナー初期化関数の reason パラメーターは、作業ウィンドウアドインとコンテンツアドインの `InitializationReason` 列挙値のみを返します。Outlook アドインの値は返されません。
Office.isSetSupported(name, minVersion)	指定した要件セットが Office アプリケーションでサポートされているかどうかを確認します。
Office.onReady(callback)	Office JavaScript API をアドインから呼び出す準備ができていることを確認します。フレームワークがまだ初期化されていない場合、コールバックまたは Promise は、Office アプリケーションが API 呼び出しを受け入れる準備ができるまで待機します。この API は Office アドイン内で使用することを目的としていますが、アドインの外部で使用することもできます。その場合、Office.js は Office アプリケーションの外部で実行されていると判断すると、コールバックを呼び出し、アプリケーションとプラットフォームの両方に対して "null" で promise を解決します。
Office.select(expression, callback)	式に記述されているオブジェクトの Promise を返します。コールバックは、関数が失敗した場合にのみ呼び出されます。
Office.useShortNamespace(useShortNamespace)	完全な`Microsoft.Office.WebExtension`名前空間の`Office`エイリアスのオンとオフを切り替えます。

Office.initialize(reason)

ランタイム環境が読み込まれ、アプリケーションやホストされたドキュメントを対話操作するアドインの準備ができたときに発生します。

初期化イベントリスナー関数の reason パラメーターは、初期化がどのように行われたかを指定する InitializationReason 列挙値を返します。作業ウィンドウアドインまたはコンテンツアドインは、次の 2 つの場合に初期化できます。

Office アプリケーションのリボンの [挿入] タブにある [アドイン] ドロップダウンリストの [最近使ったアドイン] セクションか、[アドインの挿入] ダイアログボックスから挿入したばかりです。
既にアドインが含まれているドキュメントをユーザーが開いた場合。

注: イベントリスナー初期化関数の 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
Excel	サポート	サポート	サポート	サポート	該当なし
Outlook	サポート	サポート	サポート	サポート	サポート
PowerPoint	サポート	サポート	サポート	サポート	該当なし
プロジェクト	非サポート	サポート	サポート	サポート対象外	該当なし
Word	サポート	サポート	サポート	サポート	該当なし

例

// 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 === Office.InitializationReason.Inserted) {
            write("The add-in was just inserted.");
        }

        if (reason === Office.InitializationReason.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)

警告

この API は非推奨になりました。

This API returns inaccurate values when used on desktop applications. Use Office.context.requirements.isSetSupported instead.

指定した要件セットが 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.onReady(function(info) {
    if (info.host === Office.HostType.Excel) {
        // Do Excel-specific initialization (for example, make add-in task pane's
        // appearance compatible with Excel "green").
    }
    if (info.platform === Office.PlatformType.PC) {
        // Make minor layout changes in the task pane.
    }
    console.log(`Office.js is now ready in ${info.host} on ${info.platform}`);
});

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.Binding

注釈

サポートの詳細

Office アプリケーションとサーバーの要件の詳細については、「Office アドインを実行するための要件」を参照してください。

サポートされているアプリケーション (プラットフォーム別)

	Office on the web	Windows での Office	Office on iPad
Excel	サポート	サポート	サポート
Word	非サポート	サポート	サポート

例

// 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
Excel	サポート	サポート	非サポート	サポート	該当なし
Outlook	サポート	サポート	サポート	サポート	サポート
PowerPoint	サポート	サポート	非サポート	サポート	該当なし
プロジェクト	非サポート	サポート	サポート対象外	サポート対象外	該当なし
Word	サポート	サポート	非サポート	サポート	該当なし

例

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.initialize(reason)

パラメーター

返品

注釈

例

Office.isSetSupported(name, minVersion)

パラメーター

返品

Office.onReady(callback)

パラメーター

返品

例

Office.select(expression, callback)

パラメーター

返品

注釈

例

Office.useShortNamespace(useShortNamespace)

パラメーター

返品

注釈

例

フィードバック