office package

クラス

Office.TableData

テーブルまたはOffice tablebinding内のデータを表します。Represents the data in a table or an Office.TableBinding.

OfficeExtension.ClientObject

Office ドキュメント内のオブジェクトを表す抽象プロキシオブジェクト。An abstract proxy object that represents an object in an Office document. プロキシオブジェクトをコンテキスト (またはその他のプロキシオブジェクト) から作成し、そのオブジェクトに対してアクションを実行するためのコマンドをキューに追加して、プロキシオブジェクトの状態を呼び出してドキュメントと同期します。context.sync()You create proxy objects from the context (or from other proxy objects), add commands to a queue to act on the object, and then synchronize the proxy object state with the document by calling context.sync().

OfficeExtension.ClientRequestContext

ホスト Office アプリケーションへの要求を容易にする抽象 RequestContext オブジェクト。An abstract RequestContext object that facilitates requests to the host Office application. メソッドExcel.runWord.runメソッドは、要求コンテキストを提供します。The Excel.run and Word.run methods provide a request context.

OfficeExtension.ClientResult

プリミティブ型を返すメソッドの結果が含まれています。Contains the result for methods that return primitive types. オブジェクトの value プロパティは、が呼び出された後context.sync()にドキュメントから取得されます。The object's value property is retrieved from the document after context.sync() is invoked.

OfficeExtension.EmbeddedSession

テーブルまたはOffice tablebinding内のデータを表します。Represents the data in a table or an Office.TableBinding.

OfficeExtension.Error

で返される error オブジェクトcontext.sync()The error object returned by context.sync()要求の処理中にエラーが発生したため、promise が拒否された場合。, if a promise is rejected due to an error while processing the request.

OfficeExtension.ErrorCodes

テーブルまたはOffice tablebinding内のデータを表します。Represents the data in a table or an Office.TableBinding.

OfficeExtension.EventHandlerResult

テーブルまたはOffice tablebinding内のデータを表します。Represents the data in a table or an Office.TableBinding.

OfficeExtension.EventHandlers

テーブルまたはOffice tablebinding内のデータを表します。Represents the data in a table or an Office.TableBinding.

OfficeExtension.TrackedObjects

追跡されているオブジェクトのコレクション。要求コンテキスト内に含まれます。Collection of tracked objects, contained within a request context. 詳細については、「trackedobjects 内容」を参照してください。See "context.trackedObjects" for more information.

インターフェイス

Office.AddBindingFromNamedItemOptions

作成されたバインドを構成するためのオプションを提供します。Provides options for configuring the binding that is created.

Office.AddBindingFromPromptOptions

プロンプトを構成し、作成されたバインドを識別するためのオプションを提供します。Provides options for configuring the prompt and identifying the binding that is created.

Office.AddBindingFromSelectionOptions

プロンプトを構成し、作成されたバインドを識別するためのオプションを提供します。Provides options for configuring the prompt and identifying the binding that is created.

Office.AddinCommands.Event

イベントオブジェクトは、UI レスコマンドボタンによって呼び出されるアドイン関数にパラメーターとして渡されます。The event object is passed as a parameter to add-in functions invoked by UI-less command buttons. オブジェクトにより、アドインはどのボタンがクリックされたかを識別し、その処理を行ったホストにシグナルを送ることができます。The object allows the add-in to identify which button was clicked and to signal the host that it has completed its processing.

Office.AddinCommands.EventCompletedOptions

イベントが完了したときの動作を指定します。Specifies the behavior for when the event is completed.

Office.AddinCommands.Source

アドインイベントのソースデータをカプセル化します。Encapsulates source data for add-in events.

Office.AsyncContextOptions

コールバックで使用するために、変更されていない任意の型のコンテキストデータを保持するためのオプションを提供します。Provides an option for preserving context data of any type, unchanged, for use in a callback.

Office.AsyncResult

要求が失敗した場合の状態やエラー情報など、非同期要求の結果をカプセル化するオブジェクト。An object which encapsulates the result of an asynchronous request, including status and error information if the request failed.

"Async" メソッドのcallbackパラメーターに渡す関数が実行されると、AsyncResult オブジェクトを受け取ります。このオブジェクトには、 callback関数の唯一のパラメーターからアクセスできます。When the function you pass to the callback parameter of an "Async" method executes, it receives an AsyncResult object that you can access from the callback function's only parameter.

Office.Auth

office Auth 名前空間 (office) は、office ホストがアドインの web アプリケーションへのアクセストークンを取得できるようにするメソッドを提供します。The Office Auth namespace, Office.context.auth, provides a method that allows the Office host to obtain an access token to the add-in's web application. これにより、間接的に、サインインしたユーザーの Microsoft Graph データにアドインがアクセスできるようにもなります。ユーザーがもう一度サインインする必要はありません。Indirectly, this also enables the add-in to access the signed-in user's Microsoft Graph data without requiring the user to sign in a second time.

Office.AuthOptions

Office が AAD v からアドインへのアクセストークンを取得するときのユーザー環境のオプションを提供します。Provides options for the user experience when Office obtains an access token to the add-in from AAD v. getAccessTokenAsync メソッドを使用する場合は、2.0 を使用します。2.0 with the getAccessTokenAsync method.

Office.Binding

文書のセクションへのバインドを表します。Represents a binding to a section of the document.

Binding オブジェクトは、種類に関係なくすべてのバインドが持つ機能を公開します。The Binding object exposes the functionality possessed by all bindings regardless of type.

Binding オブジェクトは直接呼び出されることはありません。The Binding object is never called directly. 各種類のバインドを表すオブジェクトの抽象親クラスです: MatrixBindingIt is the abstract parent class of the objects that represent each type of binding: Office.MatrixBindingOffice tablebinding, Office.TableBinding、またはOffice textbinding, or Office.TextBinding. これらの3つのオブジェクトはすべて、バインドオブジェクトから getdataasync メソッドと setdataasync メソッドを継承し、バインド内のデータを操作できるようにします。All three of these objects inherit the getDataAsync and setDataAsync methods from the Binding object that enable to you interact with the data in the binding. また、id および type プロパティを継承して、これらのプロパティ値をクエリすることもできます。They also inherit the id and type properties for querying those property values. さらに、MatrixBinding および TableBinding オブジェクトは、行数と列数をカウントする機能など、マトリックスおよびテーブル固有の機能も公開します。Additionally, the MatrixBinding and TableBinding objects expose additional methods for matrix- and table-specific features, such as counting the number of rows and columns.

Office.BindingDataChangedEventArgs

DataChanged イベントが発生したバインドに関する情報を提供します。Provides information about the binding that raised the DataChanged event.

Office.Bindings

アドイン がドキュメント内に持つバインドを表します。Represents the bindings the add-in has within the document.

Office.BindingSelectionChangedEventArgs

SelectionChanged イベントが発生したバインドに関する情報を提供します。Provides information about the binding that raised the SelectionChanged event.

Office.Context

アドインのランタイム環境を表し、API の主要なオブジェクトへのアクセスを提供します。Represents the runtime environment of the add-in and provides access to key objects of the API. 現在のコンテキストは、Office のプロパティとして存在します。The current context exists as a property of Office. このファイルにアクセスするには、Office.contextIt is accessed using Office.context.

Office.ContextInformation

アドインが実行されている環境に関する情報を提供します。Provides information about the environment in which the add-in is running.

Office.CustomXmlNode

ドキュメント内のツリーの XML ノードを表します。Represents an XML node in a tree in a document.

Office.CustomXmlPart

customxmlpartsコレクション内の1つの CustomXMLPart を表します。Represents a single CustomXMLPart in an Office.CustomXmlParts collection.

Office.CustomXmlParts

CustomXmlPart オブジェクトのコレクションを表します。Represents a collection of CustomXmlPart objects.

Office.CustomXmlPrefixMappings

CustomXmlPart オブジェクトのコレクションを表します。Represents a collection of CustomXmlPart objects.

Office.Dialog

が呼び出されたときUI.displayDialogAsyncに返されるオブジェクト。The object that is returned when UI.displayDialogAsync is called. イベントハンドラーを登録してダイアログを閉じるためのメソッドを公開します。It exposes methods for registering event handlers and closing the dialog.

Office.DialogOptions

ダイアログの表示方法に関するオプションを提供します。Provides options for how a dialog is displayed.

Office.Document

アドインから対話操作するドキュメントを表す抽象クラス。An abstract class that represents the document the add-in is interacting with.

Office.DocumentSelectionChangedEventArgs

SelectionChanged イベントが発生したドキュメントに関する情報を提供します。Provides information about the document that raised the SelectionChanged event.

Office.Error

非同期的なデータ操作中に発生したエラーに関する特定の情報を提供します。Provides specific information about an error that occurred during an asynchronous data operation.

Office.File

Office アドインに関連付けられているドキュメント ファイルを表します。Represents the document file associated with an Office Add-in.

Office.FileProperties

作成されたバインドを構成するためのオプションを提供します。Provides options for configuring the binding that is created.

Office.GetBindingDataOptions

バインドでデータを取得する方法のオプションを提供します。Provides options for how to get the data in a binding.

Office.GetFileOptions

ドキュメントが分割されるスライスのサイズを設定するためのオプションを提供します。Provides options for setting the size of slices that the document will be divided into.

Office.GetSelectedDataOptions

返されるデータとその書式設定方法をカスタマイズするためのオプションを提供します。Provides options for customizing what data is returned and how it is formatted.

Office.GoToByIdOptions

移動先の場所を選択するかどうかのオプションを提供します。Provides options for whether to select the location that is navigated to.

Office.IPromiseConstructor

作成されたバインドを構成するためのオプションを提供します。Provides options for configuring the binding that is created.

Office.MatrixBinding

行と列の 2 次元でバインドを表現します。Represents a binding in two dimensions of rows and columns.

Office.NodeDeletedEventArgs

nodeDeleted イベントの発生元となる削除されたノードに関する情報を提供します。Provides information about the deleted node that raised the nodeDeleted event.

Office.NodeInsertedEventArgs

nodeInserted イベントの発生元となる挿入されたノードに関する情報を提供します。Provides information about the inserted node that raised the nodeInserted event.

Office.NodeReplacedEventArgs

nodeReplaced イベントが発生した、置き換えられるノードに関する情報を提供します。Provides information about the replaced node that raised the nodeReplaced event.

Office.OfficeTheme

Office テーマの色のプロパティにアクセスできるようにします。Provides access to the properties for Office theme colors.

office テーマの色を使用すると、アドインの配色を、[ファイル> office アカウント> ] office テーマ UI を使用してユーザーが選択した現在の office テーマを使用して、すべての office ホストアプリケーションで適用されます。Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user with File > Office Account > Office Theme UI, which is applied across all Office host applications. Using Office theme colors is appropriate for mail and task pane add-ins.Using Office theme colors is appropriate for mail and task pane add-ins.

Office.RangeCoordinates

0から始まる行番号または列番号で、1つまたは複数のセル、行、または列を指定します。Specifies a cell, or row, or column, by its zero-based row and/or column number. 例: {row: 3, column: 4}第 4 (0 ベース) 列の3番目 (0 ベース) の行のセルを指定します。Example: {row: 3, column: 4} specifies the cell in the 3rd (zero-based) row in the 4th (zero-based) column.

Office.RangeFormatConfiguration

範囲とその書式を指定します。Specifies a range and its formatting.

Office.RemoveHandlerOptions

削除するイベントハンドラーを決めるためのオプションを提供します。Provides options to determine which event handler or handlers are removed.

Office.RequirementSetSupport

現在の環境でサポートされている要件セットに関する情報を提供します。Provides information about what Requirement Sets are supported in current environment.

Office.SaveSettingsOptions

設定を保存するためのオプションを提供します。Provides options for saving settings.

Office.SetBindingDataOptions

バインドのデータを設定する方法についてのオプションを提供します。Provides options for how to set the data in a binding.

Office.SetSelectedDataOptions

選択範囲にデータを挿入する方法のオプションを提供します。Provides options for how to insert data to the selection.

Office.Settings

ホスト ドキュメントに名前/値のペアとして格納される、作業ウィンドウ アドインまたはコンテンツ アドインのカスタム設定を表します。Represents custom settings for a task pane or content add-in that are stored in the host document as name/value pairs.

Office.SettingsChangedEventArgs

settingsChanged イベントが発生した設定についての情報を提供します。Provides information about the settings that raised the settingsChanged event.

settingschanged イベントのイベントハンドラーを追加するには、 Office の Settingsオブジェクトの addhandler async メソッドを使用します。To add an event handler for the settingsChanged event, use the addHandlerAsync method of the Office.Settings object.

settingschanged イベントは、アドインのスクリプトが saveAsync メソッドを呼び出して、設定のメモリ内コピーをドキュメントファイルに保持する場合にのみ発生します。The settingsChanged event fires only when your add-in's script calls the Settings.saveAsync method to persist the in-memory copy of the settings into the document file. settingsChanged イベントは、Settings.set または Settings.remove メソッドが呼び出された場合にはトリガーされません。The settingsChanged event is not triggered when the Settings.set or Settings.remove methods are called.

settingschanged イベントは、アドインが共有 (共同編集) ドキュメントで使用されているときに、2人以上のユーザーが設定を保存しようとしたときに発生する可能性のある競合を処理できるように設計されています。The settingsChanged event was designed to let you to handle potential conflicts when two or more users are attempting to save settings at the same time when your add-in is used in a shared (co-authored) document.

重要: アドインが excel クライアントで実行されている場合は、アドインのコードで settingschanged イベントのハンドラーを登録できますが、このイベントは、アドインが excel Online に開かれたスプレッドシートを使用して読み込まれた場合にのみ発生します。また、複数のユーザースプレッドシートを編集しています (共同編集)。Important: Your add-in's code can register a handler for the settingsChanged event when the add-in is running with any Excel client, but the event will fire only when the add-in is loaded with a spreadsheet that is opened in Excel Online, and more than one user is editing the spreadsheet (co-authoring). Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.Therefore, effectively the settingsChanged event is supported only in Excel Online in co-authoring scenarios.

Office.Slice

ドキュメント ファイルのスライスを表します。Represents a slice of a document file. Slice オブジェクトには、 File.getSliceAsyncメソッドを使用してアクセスします。The Slice object is accessed with the File.getSliceAsync method.

Office.TableBinding

バインドを行と列の 2 次元で、必要に応じてヘッダーと共に表します。Represents a binding in two dimensions of rows and columns, optionally with headers.

Office.TextBinding

ドキュメント内のバインドされているテキスト選択を表します。Represents a bound text selection in the document.

textbinding オブジェクトは、id プロパティ、type プロパティ、getdataasync メソッド、および setdataasync メソッドを Office のBindingオブジェクトから継承します。The TextBinding object inherits the id property, type property, getDataAsync method, and setDataAsync method from the Office.Binding object. これ以外に、このオブジェクトが独自に実装するプロパティやメソッドはありません。It does not implement any additional properties or methods of its own.

Office.UI

Office アドインで、ダイアログボックスなどの UI コンポーネントを作成および操作するために使用できるオブジェクトとメソッドを提供します。Provides objects and methods that you can use to create and manipulate UI components, such as dialog boxes, in your Office Add-ins.

Office アドインでダイアログ API を使用する」を参照してください。Visit "Use the Dialog API in your Office Add-ins詳細については、「」を参照してください。" for more information.

OfficeExtension.DebugInfo

エラーに関する情報を提供します。Provides information about an error.

OfficeExtension.EmbeddedOptions

作成されたバインドを構成するためのオプションを提供します。Provides options for configuring the binding that is created.

OfficeExtension.EventInfo

作成されたバインドを構成するためのオプションを提供します。Provides options for configuring the binding that is created.

OfficeExtension.LoadOption

読み込む必要のあるオブジェクトのプロパティを指定します。Specifies which properties of an object should be loaded. この負荷は sync () メソッドが実行されたときに発生します。This load happens when the sync() method is executed. これにより、Office オブジェクトと、それに対応する JavaScript プロキシオブジェクトとの間で状態が同期されます。This synchronizes the states between Office objects and corresponding JavaScript proxy objects.

OfficeExtension.RequestContextDebugInfo

要求コンテキストに関するデバッグ情報が保存されています。Contains debug information about the request context.

OfficeExtension.RequestUrlAndHeaderInfo

要求の URL とヘッダーRequest URL and headers

OfficeExtension.RunOptions

に渡される追加オプション{Host}.run(...)Additional options passed into {Host}.run(...).

OfficeExtension.UpdateOptions

複数のプロパティを設定するために使用されるオブジェクトが読み取り専用プロパティを設定しようとしたときに、エラーを抑制するためのオプションを提供します。Provides an option for suppressing an error when the object that is used to set multiple properties tries to set read-only properties.

列挙型

Office.ActiveView

ユーザーがドキュメントを編集できるかどうかなど、ドキュメントのアクティブなビューの状態を指定します。Specifies the state of the active view of the document, for example, whether the user can edit the document.

Office.AsyncResultStatus

非同期呼び出しの結果を指定します。Specifies the result of an asynchronous call.

Office.BindingType

返されるバインド オブジェクトの種類を指定します。Specifies the type of the binding object that should be returned.

Office.CoercionType

呼び出されたメソッドによって返される、または設定されるデータを強制的に変換する方法を指定します。Specifies how to coerce data returned or set by the invoked method.

Office.CustomXMLNodeType

XML ノードの種類を指定します。Specifies the type of the XML node.

Office.DocumentMode

関連付けられているアプリケーションのドキュメントを読み取り専用または読み取り/書き込みのどちらかに指定します。Specifies whether the document in the associated application is read-only or read-write.

Office.EventType

発生したイベントの種類を指定します。Specifies the kind of event that was raised. * EventArgs オブジェクトtypeのプロパティによって返されます。Returned by the type property of an *EventArgs object.

Project support 用アドインOffice.EventType.ResourceSelectionChangedAdd-ins for Project support the Office.EventType.ResourceSelectionChanged, Office.EventType.TaskSelectionChanged、およびOffice.EventType.ViewSelectionChangedイベントの種類。, and Office.EventType.ViewSelectionChanged event types.

Office.FileType

ドキュメントを返す形式を指定します。Specifies the format in which to return the document.

Office.FilterType

データを取得するときにホスト アプリケーションからのフィルタリングを適用するかどうかを指定します。Specifies whether filtering from the host application is applied when the data is retrieved.

Office.GoToType

ナビゲートする場所またはオブジェクトの種類を指定します。Specifies the type of place or object to navigate to.

Office.HostType

アドインが実行されているホスト Office アプリケーションを指定します。Specifies the host Office application in which the add-in is running.

Office.Index

相対的な PowerPoint スライドを指定します。

Office.InitializationReason

ドキュメントにアドインが挿入されたばかりであるか、既に含まれていたかを指定します。Specifies whether the add-in was just inserted or was already contained in the document.

Office.PlatformType

Office ホスト アプリケーションが実行されている OS またはその他のプラットフォームを指定します。Specifies the OS or other platform on which the Office host application is running.

Office.ProjectProjectFields

ドキュメントのパラメーターとして使用できるプロジェクトフィールドを指定します。Specifies the project fields that are available as a parameter for the Document。 getprojectfieldasync メソッド。.getProjectFieldAsync method.

Office.ProjectResourceFields

文書のパラメーターとして使用できるリソースフィールドを指定します。Specifies the resource fields that are available as a parameter for the Document. getresourcefieldasync メソッド。.getResourceFieldAsync method.

Office.ProjectTaskFields

ドキュメントのパラメーターとして使用できるタスクフィールドを指定します。Specifies the task fields that are available as a parameter for the Document。 gettaskfieldasync メソッド。.getTaskFieldAsync method.

Office.ProjectViewTypes

文書が表示されるビューの種類を指定します。Specifies the types of views that the Document. getselectedviewasync メソッドは、を認識できます。.getSelectedViewAsync method can recognize.

Office.SelectionMode

移動先の場所を選択 (強調表示) するかどうかを指定します (ドキュメントを使用する場合)。Specifies whether to select (highlight) the location to navigate to (when using the Documentdocument.gotobyidasync メソッド)。.goToByIdAsync method).

Office.Table

表の書式設定メソッドの cellformat パラメーターのcellsプロパティに列挙値を指定します。Specifies enumerated values for the cells property in the cellFormat parameter of table formatting methods.

Office.ValueFormat

呼び出されたメソッドによって取得する値 (数字、日付など) に書式を設定するかどうかを指定します。書式を設定すると、その書式が適用された状態で値が返されます。Specifies whether values, such as numbers and dates, returned by the invoked method are returned with their formatting applied.

機能

Office.initialize

ランタイム環境が読み込まれ、アプリケーションやホストされたドキュメントを対話操作するアドインの準備ができたときに発生します。Occurs when the runtime environment is loaded and the add-in is ready to start interacting with the application and hosted document.

Initialize イベントリスナー関数の reason パラメーターは、初期化がInitializationReason行われた方法を指定する列挙値を返します。The reason parameter of the initialize event listener function returns an InitializationReason enumeration value that specifies how initialization occurred. 作業ウィンドウ アドインまたはコンテンツ アドインは、次の 2 つの場合に初期化できます。A task pane or content add-in can be initialized in two ways:

  • ユーザーは、Office ホストアプリケーションのリボンの [挿入] タブにあるアドインのドロップダウンリストの [最近使用したアドイン] セクションから、または [アドインの挿入] ダイアログボックスからアドインを挿入しただけです。The user just inserted it from Recently Used Add-ins section of the Add-in drop-down list on the Insert tab of the ribbon in the Office host application, or from Insert add-in dialog box.

  • 既にアドインが含まれているドキュメントをユーザーが開いた場合。The user opened a document that already contains the add-in.

: initialize イベントリスナー関数の reason パラメーターは、作業ウィンドウアドインInitializationReasonとコンテンツアドインの列挙値のみを返します。Outlook アドインの値を返すことはありません。Note: The reason parameter of the initialize event listener function only returns an InitializationReason enumeration value for task pane and content add-ins. It does not return a value for Outlook add-ins.

Office.onReady

Office JavaScript Api がアドインによって呼び出される準備が整っていることを確認します。Ensures that the Office JavaScript APIs are ready to be called by the add-in. フレームワークがまだ初期化されていない場合、コールバックまたは promise は Office ホストが API 呼び出しを受け入れる準備ができるまで待機します。If the framework hasn't initialized yet, the callback or promise will wait until the Office host is ready to accept API calls. この API は Office アドイン内で使用することを目的としていますが、アドインの外部でも使用できます。Note that though this API is intended to be used inside an Office add-in, it can also be used outside the add-in. その場合は、office ホストアプリケーションの外部で実行されていると判断された後、そのコールバックを呼び出し、ホストとプラットフォームの両方に対して "null" を使用して promise を解決します。In that case, once Office.js determines that it is running outside of an Office host application, it will call the callback and resolve the promise with "null" for both the host and platform.

Office.select

式で記述されたオブジェクトの promise を返します。Returns a promise of an object described in the expression. コールバックは、メソッドが失敗した場合にのみ呼び出されます。Callback is invoked only if method fails.

Office.useShortNamespace

完全なMicrosoft.Office.WebExtension名前空間のOfficeエイリアスをオンまたはオフにします。Toggles on and off the Office alias for the full Microsoft.Office.WebExtension namespace.

関数の詳細

Office.initialize

ランタイム環境が読み込まれ、アプリケーションやホストされたドキュメントを対話操作するアドインの準備ができたときに発生します。Occurs when the runtime environment is loaded and the add-in is ready to start interacting with the application and hosted document.

Initialize イベントリスナー関数の reason パラメーターは、初期化がInitializationReason行われた方法を指定する列挙値を返します。The reason parameter of the initialize event listener function returns an InitializationReason enumeration value that specifies how initialization occurred. 作業ウィンドウ アドインまたはコンテンツ アドインは、次の 2 つの場合に初期化できます。A task pane or content add-in can be initialized in two ways:

  • ユーザーは、Office ホストアプリケーションのリボンの [挿入] タブにあるアドインのドロップダウンリストの [最近使用したアドイン] セクションから、または [アドインの挿入] ダイアログボックスからアドインを挿入しただけです。The user just inserted it from Recently Used Add-ins section of the Add-in drop-down list on the Insert tab of the ribbon in the Office host application, or from Insert add-in dialog box.

  • 既にアドインが含まれているドキュメントをユーザーが開いた場合。The user opened a document that already contains the add-in.

: initialize イベントリスナー関数の reason パラメーターは、作業ウィンドウアドインInitializationReasonとコンテンツアドインの列挙値のみを返します。Outlook アドインの値を返すことはありません。Note: The reason parameter of the initialize event listener function only returns an InitializationReason enumeration value for task pane and content add-ins. It does not return a value for Outlook add-ins.

export function initialize(reason: InitializationReason): void;

パラメーター

reason
Office.InitializationReason

アプリが初期化された方法を示します。Indicates how the app was initialized.

戻り値

void

注釈

サポートの詳細Support details

次の表で、大文字 Y は、このメソッドは、対応する Office ホスト アプリケーションでサポートされていることを示します。空のセルは、Office ホスト アプリケーションでこのメソッドをサポートしないことを示します。A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

Office ホストアプリケーションとサーバーの要件の詳細については、「 Office アドインを実行するための要件」を参照してください。For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

サポートされるホスト (プラットフォーム別)Supported hosts, by platform

Windows デスクトップ版 OfficeOffice for Windows desktop Office Online (ブラウザー)Office Online (in browser) Office for iPadOffice for iPad OWA for DevicesOWA for Devices Office for MacOffice for Mac
接続 Access YY
シート Excel YY YY YY
出席 Outlook YY YY YY YY
しまう PowerPoint YY YY YY
プロジェクト Project YY
段落 Word YY YY YY

Examples

// 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.onReady

Office JavaScript Api がアドインによって呼び出される準備が整っていることを確認します。Ensures that the Office JavaScript APIs are ready to be called by the add-in. フレームワークがまだ初期化されていない場合、コールバックまたは promise は Office ホストが API 呼び出しを受け入れる準備ができるまで待機します。If the framework hasn't initialized yet, the callback or promise will wait until the Office host is ready to accept API calls. この API は Office アドイン内で使用することを目的としていますが、アドインの外部でも使用できます。Note that though this API is intended to be used inside an Office add-in, it can also be used outside the add-in. その場合は、office ホストアプリケーションの外部で実行されていると判断された後、そのコールバックを呼び出し、ホストとプラットフォームの両方に対して "null" を使用して promise を解決します。In that case, once Office.js determines that it is running outside of an Office host application, it will call the callback and resolve the promise with "null" for both the host and platform.

export function onReady(callback?: (info: { host: HostType, platform: PlatformType }) => any): Promise<{ host: HostType, platform: PlatformType }>;

パラメーター

callback
(info: { host: HostType, platform: PlatformType }) => any

ホストおよびプラットフォームの情報を受け取るオプションのコールバックメソッド。An optional callback method, that will receive the host and platform info. または、コールバックを使用するのではなく、関数によって返された Promise を解決するだけでアドインが待機することもあります。Alternatively, rather than use a callback, an add-in may simply wait for the Promise returned by the function to resolve.

戻り値

Promise<{ host: HostType, platform: PlatformType }>

初期化が完了すると、ホストとプラットフォームの情報を含む約束ができます。A Promise that contains the host and platform info, once initialization is completed.

Office.select

式で記述されたオブジェクトの promise を返します。Returns a promise of an object described in the expression. コールバックは、メソッドが失敗した場合にのみ呼び出されます。Callback is invoked only if method fails.

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

パラメーター

expression
string

取得するオブジェクトを指定します。The object to be retrieved. "Bindings#bindingname" の例は、' bindingname ' という名前のバインドのためのバインド保証を取得します。Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'

callback
(result: AsyncResult<any>) => void

省略可能。Optional. コールバックが戻るときに呼び出される関数で、唯一のパラメーターの型がOffice AsyncResultである。A function that is invoked when the callback returns, whose only parameter is of type Office.AsyncResult.

戻り値

Binding

注釈

サポートの詳細Support details

次の表で、大文字 Y は、このメソッドは、対応する Office ホスト アプリケーションでサポートされていることを示します。空のセルは、Office ホスト アプリケーションでこのメソッドをサポートしないことを示します。A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

Office ホストアプリケーションとサーバーの要件の詳細については、「 Office アドインを実行するための要件」を参照してください。For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

サポートされるホスト (プラットフォーム別)Supported hosts, by platform

Windows デスクトップ版 OfficeOffice for Windows desktop Office Online (ブラウザー)Office Online (in browser) Office for iPadOffice for iPad
接続 Access YY
シート Excel YY YY YY
段落 Word YY YY

Examples

// 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

完全なMicrosoft.Office.WebExtension名前空間のOfficeエイリアスをオンまたはオフにします。Toggles on and off the Office alias for the full Microsoft.Office.WebExtension namespace.

export function useShortNamespace(useShortNamespace: boolean): void;

パラメーター

useShortNamespace
boolean

ショートカットエイリアスを使用する場合は True、それ以外の場合は false を無効にします。True to use the shortcut alias; otherwise false to disable it. 既定値は true です。The default is true.

戻り値

void

注釈

サポートの詳細Support details

次の表で、大文字 Y は、このメソッドは、対応する Office ホスト アプリケーションでサポートされていることを示します。空のセルは、Office ホスト アプリケーションでこのメソッドをサポートしないことを示します。A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

Office ホストアプリケーションとサーバーの要件の詳細については、「 Office アドインを実行するための要件」を参照してください。For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

サポートされるホスト (プラットフォーム別)Supported hosts, by platform

Windows デスクトップ版 OfficeOffice for Windows desktop Office Online (ブラウザー)Office Online (in browser) Office for iPadOffice for iPad OWA for DevicesOWA for Devices Office for MacOffice for Mac
接続 Access YY
シート Excel YY YY YY
出席 Outlook YY YY YY YY
しまう PowerPoint YY YY YY
プロジェクト Project YY
段落 Word YY YY YY

Examples

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