office package

クラス

Office.TableData

テーブルまたはテーブル内のデータを表 Office.TableBinding.

OfficeExtension.ClientObject

ドキュメント内のオブジェクトを表す抽象プロキシ オブジェクトOfficeします。 コンテキスト (または他のプロキシ オブジェクト) からプロキシ オブジェクトを作成し、オブジェクトに対して処理するコマンドをキューに追加し、プロキシ オブジェクトの状態を呼び出してドキュメントと同期します。 context.sync().

OfficeExtension.ClientRequestContext

アプリケーションのホストへの要求を容易にする抽象 RequestContext オブジェクトOfficeします。 and Excel.run メソッド Word.run は、要求コンテキストを提供します。

OfficeExtension.ClientResult

プリミティブ型を返すメソッドの結果を格納します。 オブジェクトの value プロパティは、呼び出された後にドキュメント context.sync() から取得されます。

OfficeExtension.EmbeddedSession
OfficeExtension.Error

によって返される error オブジェクト context.sync()、要求の処理中にエラーが発生して約束が拒否された場合。

OfficeExtension.ErrorCodes
OfficeExtension.EventHandlerResult
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects

要求コンテキスト内に含まれる追跡対象オブジェクトのコレクション。 詳細については、「context.trackedObjects」を参照してください。

インターフェイス

Office.Actions

アクションとキーボード ショートカットを管理します。

Office.AddBindingFromNamedItemOptions

作成されるバインドを構成するためのオプションを提供します。

Office.AddBindingFromPromptOptions

プロンプトを構成し、作成されるバインドを識別するためのオプションを提供します。

Office.AddBindingFromSelectionOptions

作成されるバインドを識別するためのオプションを提供します。

Office.Addin

アドインのさまざまな側面を操作または構成するためのアドイン レベルの機能を表します。

Office.AddinCommands.Event

Event オブジェクトは、UI を使用しないコマンド ボタンによって呼び出されるアドイン関数のパラメーターとして渡されます。オブジェクトにより、アドインはどのボタンがクリックされたかを識別し、その処理を行ったホストにシグナルを送ることができます。

Office.AddinCommands.EventCompletedOptions

イベントが完了した場合の動作を指定します。

Office.AddinCommands.Source

アドイン イベントのソース データをカプセル化します。

Office.AsyncContextOptions

コールバックで使用するために、任意の種類のコンテキスト データを変更されずに保持するためのオプションを提供します。

Office.AsyncResult

要求が失敗した場合の状態やエラー情報など、非同期要求の結果をカプセル化するオブジェクト。

"Async" メソッドのパラメーターに渡す関数が実行すると、関数の唯一のパラメーターからアクセスできる callback AsyncResult オブジェクト callback を受け取ります。

Office.Auth

Auth Officeの名前空間Office.authを使用すると、クライアント アプリケーションOfficeアドインの Web アプリケーションへのアクセス トークンを取得できるメソッドが提供されます。 これにより、間接的に、サインインしたユーザーの Microsoft Graph データにアドインがアクセスできるようにもなります。ユーザーがもう一度サインインする必要はありません。

Office.AuthOptions

AAD v からアドインOfficeアクセス トークンを取得するときに、ユーザー エクスペリエンスのオプションを提供します。 getAccessToken メソッドを使用して AAD v. 2.0 からアドインに対するアクセス トークンを取得する場合用のユーザー エクスペリエンス用のオプションがあります。

Office.BeforeDocumentCloseNotification

ユーザーがドキュメントを閉じるときに表示されるモーダル通知ダイアログを表します。 ドキュメントは、ユーザーが応答するまで閉じない。 通知ダイアログを使用すると、ユーザーは要求を確認してドキュメントを閉じるか、要求をキャンセルしてドキュメントを閉じできます。

Office。バインド

ドキュメントのセクションへのバインドを表します。

Binding オブジェクトは、種類に関係なく、すべてのバインドが持つ機能を公開します。

Binding オブジェクトは直接呼び出されません。 バインドの各種類を表すオブジェクトの抽象親クラスです。Office。MatrixBinding、Office。TableBinding、またはOffice。TextBinding. これら 3 つのオブジェクトはすべて、バインド内のデータを操作できる Binding オブジェクトから getDataAsync メソッドと setDataAsync メソッドを継承します。 また、id および type プロパティを継承して、これらのプロパティ値をクエリすることもできます。 さらに、MatrixBinding および TableBinding オブジェクトは、行数と列数をカウントする機能など、マトリックスおよびテーブル固有の機能も公開します。

Office.BindingDataChangedEventArgs

DataChanged イベントが発生したバインドに関する情報を提供します。

Office.Bindings

アドイン がドキュメント内に持つバインドを表します。

Office.BindingSelectionChangedEventArgs

SelectionChanged イベントが発生したバインドに関する情報を提供します。

Office.Context

アドインのランタイム環境を表し、API の主要なオブジェクトへのアクセスを提供します。 現在のコンテキストは、Office のプロパティとして存在します。 を使用してアクセスされます。 Office.context.

Office.ContextInformation

アドインが実行されている環境に関する情報を提供します。

Office.Control

個々のコントロールまたはコマンドと、そのコントロールに必要な状態を表します。

オブジェクトとそのプロパティを使用する方法を示すコード サンプルについては Control 、「Enable and Disable Add-in Commands and Create custom contextual tabs」 を参照してください。.

Office.CustomXmlNode

ドキュメント内のツリーの XML ノードを表します。

Office.CustomXmlPart

1 つの CustomXMLPart を表します 。Office.CustomXmlParts コレクション。

Office.CustomXmlParts

CustomXmlPart オブジェクトのコレクションを表します。

Office.CustomXmlPrefixMappings

CustomXmlPart オブジェクトのコレクションを表します。

Office.Dialog

呼び出された場合に返 UI.displayDialogAsync されるオブジェクト。 イベント ハンドラーを登録し、ダイアログを閉じるメソッドを公開します。

Office.DialogMessageOptions

ダイアログとその親の間で、どちらの方向でもメッセージを送信する方法のオプションを提供します。

Office.DialogOptions

ダイアログの表示方法のオプションを提供します。

Office.DialogParentMessageReceivedEventArgs

イベントを発生した親ページからのメッセージに関する情報を提供 DialogParentMessageReceived します。

イベントのイベント ハンドラーを追加 DialogParentMessageReceived するには、イベント の addHandlerAsync メソッドを使用Office。UIオブジェクト。

Office.Document

アドインから対話操作するドキュメントを表す抽象クラス。

Office.DocumentSelectionChangedEventArgs

SelectionChanged イベントが発生したドキュメントに関する情報を提供します。

Office.Error

非同期的なデータ操作中に発生したエラーに関する特定の情報を提供します。

Office.File

Office アドインに関連付けられているドキュメント ファイルを表します。

Office.FileProperties
Office.GetBindingDataOptions

バインド内のデータを取得する方法のオプションを提供します。

Office.GetFileOptions

ドキュメントを分割するスライスのサイズを設定するためのオプションを提供します。

Office.GetSelectedDataOptions

返されるデータと書式設定方法をカスタマイズするためのオプションを提供します。

Office.GoToByIdOptions

移動する場所を選択するかどうかを指定するオプションを提供します。

Office.Group

リボン タブのコントロールのグループを表します。

要件セット: リボン 1.1

Office.IPromiseConstructor
Office.MatrixBinding

行と列の 2 次元でバインドを表現します。

Office.NodeDeletedEventArgs

nodeDeleted イベントの発生元となる削除されたノードに関する情報を提供します。

Office.NodeInsertedEventArgs

nodeInserted イベントの発生元となる挿入されたノードに関する情報を提供します。

Office.NodeReplacedEventArgs

nodeReplaced イベントが発生した、置き換えられるノードに関する情報を提供します。

Office.OfficeTheme

Office テーマの色のプロパティにアクセスできるようにします。

Office テーマの色を使用すると、すべての Office ホスト アプリケーションに適用される File Office Account Office テーマ UI を使用して、ユーザーが選択した現在の Office テーマとアドインの配色を調整できます。 > > Using Office theme colors is appropriate for mail and task pane add-ins.

Office.RangeCoordinates

ゼロベースの行番号または列番号で、セルまたは行、または列を指定します。 例: 4 番目 (ゼロベース) 列の 3 行目 (0 から始め) のセル {row: 3, column: 4} を指定します。

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 イベントは、複数のユーザーが共有 (共同編集) ドキュメントでアドインを使用するときに同時に設定を保存しようとするときに、潜在的な競合を処理するように設計されています。

重要: アドインのコードは、アドインが Excel クライアントで実行されている場合に settingsChanged イベントのハンドラーを登録できますが、アドインが Web 上の Excel で開かれているスプレッドシートで読み込まれ、複数のユーザーがスプレッドシートを編集している場合にのみ発生します (共同編集)。 したがって、効果的に settingsChanged イベントは、共同編集シナリオで Web 上の Excel でのみサポートされます。

Office.Slice

ドキュメント ファイルのスライスを表します。 Slice オブジェクトには、メソッドを使用してアクセス File.getSliceAsync します。

Office.Tab

個々のタブと、それが持つ必要がある状態を表します。 コード例については、「Enable and Disable Add-in Commands and Create custom contextual tabs」を参照してください。.

Office.TableBinding

バインドを行と列の 2 次元で、必要に応じてヘッダーと共に表します。

Office.TextBinding

ドキュメント内のバインドされているテキスト選択を表します。

TextBinding オブジェクトは、id プロパティ、type プロパティ、getDataAsync メソッド、および setDataAsync メソッドを Office.Binding オブジェクトから継承 します。 これ以外に、このオブジェクトが独自に実装するプロパティやメソッドはありません。

Office.UI

ダイアログ ボックスなどの UI コンポーネントを作成および操作するために使用できるオブジェクトとメソッドを、Office提供します。

アドイン[でダイアログ API をOfficeする] を参照してください。詳細については、「」を参照してください。

Office.VisibilityModeChangedMessage

呼び出しで使用されるメッセージ onVisibilityModeChanged

OfficeExtension.DebugInfo

エラーに関する情報を提供します。

OfficeExtension.EmbeddedOptions
OfficeExtension.EventInfo
OfficeExtension.LoadOption

読み込むオブジェクトのプロパティを指定します。 この読み込みは、sync() メソッドが実行されると発生します。 これにより、オブジェクトと対応する JavaScript プロキシ Office間の状態が同期されます。

OfficeExtension.RequestContextDebugInfo

要求コンテキストに関するデバッグ情報が含まれる。

OfficeExtension.RequestUrlAndHeaderInfo

要求の URL とヘッダー

OfficeExtension.RunOptions

に渡されるその他のオプション {Host}.run(...).

OfficeExtension.UpdateOptions

複数のプロパティを設定するために使用されるオブジェクトが読み取り専用プロパティを設定しようとするときにエラーを抑制するオプションを提供します。

列挙型

Office.ActiveView

ユーザーがドキュメントを編集できるかどうかなど、ドキュメントのアクティブなビューの状態を指定します。

Office.AsyncResultStatus

非同期呼び出しの結果を指定します。

Office.BindingType

返されるバインド オブジェクトの種類を指定します。

Office.CoercionType

呼び出されたメソッドによって返される、または設定されるデータを強制的に変換する方法を指定します。

Office.CustomXMLNodeType

XML ノードの種類を指定します。

Office.DocumentMode

関連付けられているアプリケーションのドキュメントを読み取り専用または読み取り/書き込みのどちらかに指定します。

Office.EventType

発生したイベントの種類を指定します。 オブジェクトのプロパティ type によって返 *EventArgs されます。

アドインは、Projectをサポートします。Office.EventType.ResourceSelectionChanged, Office.EventType.TaskSelectionChanged、および Office.EventType.ViewSelectionChanged イベントの種類。

メールボックス API セット イベントの種類をサポートOutlook作業ウィンドウ アドインのみです。

Office.FileType

ドキュメントを返す形式を指定します。

Office.FilterType

データを取得するときにホスト アプリケーションからのフィルタリングを適用するかどうかを指定します。

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

(ドキュメントを使用する場合) に移動する場所を選択 (強調表示) するかどうかを指定 します。.goToByIdAsync メソッド)。

Office.StartupBehavior

次の起動時にアドインの起動動作を決定するオプションを提供します。

Office.Table

テーブル書式メソッドの cellFormat パラメーターでプロパティの cells 列挙値 を指定します。.

Office.ValueFormat

呼び出されたメソッドによって取得する値 (数字、日付など) に書式を設定するかどうかを指定します。書式を設定すると、その書式が適用された状態で値が返されます。

Office.VisibilityMode

アドインの表示モード。

機能

Office.initialize(reason)

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

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

  • ユーザーは、Office ホスト アプリケーションのリボンの [挿入] タブの [アドイン] ドロップダウン リストの [最近使用したアドイン] セクション、または [アドインの挿入] ダイアログ ボックスから挿入しました。

  • 既にアドインが含まれているドキュメントをユーザーが開いた場合。

: initialize イベント リスナー関数の reason パラメーターは、作業ウィンドウアドインとコンテンツ アドインの列挙値 InitializationReason のみを返します。このメソッドは、アドインの値Outlook返す必要があります。

Office.isSetSupported(name, minVersion)

指定した要件セットがホスト アプリケーションでサポートOfficeします。

Office.onReady(callback)

アドインによってOffice JavaScript API を呼び出す準備ができていることを確認します。 フレームワークがまだ初期化されていない場合、コールバックまたは promise は、ホストが API 呼び出しを受け入れるOfficeするまで待機します。 この API はアドイン内で使用Officeですが、アドインの外部でも使用できます。 その場合、Office.js が Office ホスト アプリケーションの外部で実行されていると判断すると、コールバックを呼び出し、ホストとプラットフォームの両方に対して "null" で約束を解決します。

Office.select(expression, callback)

式で説明されているオブジェクトの約束を返します。 コールバックは、メソッドが失敗した場合にのみ呼び出されます。

Office.useShortNamespace(useShortNamespace)

名前空間全体のエイリアスの Office オンとオフを切り替 Microsoft.Office.WebExtension えます。

関数の詳細

Office.initialize(reason)

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

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

  • ユーザーは、Office ホスト アプリケーションのリボンの [挿入] タブの [アドイン] ドロップダウン リストの [最近使用したアドイン] セクション、または [アドインの挿入] ダイアログ ボックスから挿入しました。

  • 既にアドインが含まれているドキュメントをユーザーが開いた場合。

: initialize イベント リスナー関数の reason パラメーターは、作業ウィンドウアドインとコンテンツ アドインの列挙値 InitializationReason のみを返します。このメソッドは、アドインの値Outlook返す必要があります。

export function initialize(reason: InitializationReason): void;

パラメーター

reason
Office.InitializationReason

アプリが初期化された方法を示します。

戻り値

void

注釈

サポートの詳細

次の表で、大文字 Y は、このメソッドは、対応する Office ホスト アプリケーションでサポートされていることを示します。空のセルは、Office ホスト アプリケーションでこのメソッドをサポートしないことを示します。

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

サポートされるホスト (プラットフォーム別)

Windows での Office Officeブラウザーで使用する Office on iPad Outlookデバイス上での設定 Office on Mac
Excel Y Y Y Y
Outlook Y Y Y Y
PowerPoint Y Y Y Y
Project Y Y
Word Y Y Y Y

// 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 function.
    $(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 は、ホストが API 呼び出しを受け入れるOfficeするまで待機します。 この API はアドイン内で使用Officeですが、アドインの外部でも使用できます。 その場合、Office.js が Office ホスト アプリケーションの外部で実行されていると判断すると、コールバックを呼び出し、ホストとプラットフォームの両方に対して "null" で約束を解決します。

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)

式で説明されているオブジェクトの約束を返します。 コールバックは、メソッドが失敗した場合にのみ呼び出されます。

export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;

パラメーター

expression

string

取得するオブジェクト。 "bindings # BindingName" の例では、'BindingName' という名前のバインドのバインド約束を取得します。

callback

(result: Office.AsyncResult<any>) => void

省略可能。 コールバックが返された場合に呼び出される関数で、そのパラメーターはパラメーターの種類Office。AsyncResult.

戻り値

注釈

サポートの詳細

次の表で、大文字 Y は、このメソッドは、対応する Office ホスト アプリケーションでサポートされていることを示します。空のセルは、Office ホスト アプリケーションでこのメソッドをサポートしないことを示します。

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

サポートされるホスト (プラットフォーム別)

Windows での Office Officeブラウザーで使用する Office on iPad
Excel Y Y Y
Word Y Y

// The following code example uses the select method 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)

名前空間全体のエイリアスの Office オンとオフを切り替 Microsoft.Office.WebExtension えます。

export function useShortNamespace(useShortNamespace: boolean): void;

パラメーター

useShortNamespace

boolean

ショートカット エイリアスを使用するには True を指定します。それ以外の場合は false を指定して無効にします。 既定値は true です。

戻り値

void

注釈

サポートの詳細

次の表で、大文字 Y は、このメソッドは、対応する Office ホスト アプリケーションでサポートされていることを示します。空のセルは、Office ホスト アプリケーションでこのメソッドをサポートしないことを示します。

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

サポートされるホスト (プラットフォーム別)

Windows での Office Officeブラウザーで使用する Office on iPad Outlookデバイス上での設定 Office on Mac
Excel Y Y Y
Outlook Y Y Y Y
PowerPoint Y Y Y
Project Y
Word Y Y Y

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; 
}