Word Automation Services オブジェクト モデル
最終更新日: 2010年4月1日
適用対象: SharePoint Server 2010
ここでは、Word Automation Services を使用して開発するときに使用する主なオブジェクトについて説明します。
概要
Word Automation Services のプログラミング モデルは、アプリケーションが、次のアクションを実行することによって非同期で変換を要求するときに使用するサーバー側オブジェクト モデルを提供します。
変換を実行するサービス アプリケーションを指定する。
この変換グループの必須プロパティとオプションのプロパティを設定する。
1 つ以上の変換するファイルを指定する。
ドキュメント キューに変換を送信する。
アプリケーションが変換要求を送信すると、サービスは、サービス アプリケーションに設定されているスケジュールに基づいて、自動的に先入れ先出し法 (FIFO) キューを使用して変換を開始します。各変換要求では、変換要求の状態情報のクエリを実行するときに使用できる GUID も指定します。
変換ジョブの作成
Word Automation Services を使用してファイルを変換するために、オブジェクト モデルでは、ConversionJob オブジェクトを使用して 1 セットの変換を 1 つの単位として追跡します。たとえば、15 個のファイルを PFD 形式に変換し、30 個のファイルを XPS 形式に変換するには、同じプロパティを持つ変換セットごとに 1 つの ConversionJob オブジェクトが必要で、合計で 2 つのオブジェクトが必要です。
ConversionJob オブジェクトを初期化するには、サービス アプリケーションに対応する名前、ID、またはサービス アプリケーション プロキシを指定した 1 つのパラメーターがコードに必要です。一般的に、作成時に指定するサービス アプリケーションの名前が最も簡単に使用できます。
ConversionJob オブジェクトを作成したら、一意の ID を割り当てます。ConversionJob オブジェクトは、その JobId プロパティを使用してこの ID を公開します。これにより、変換ジョブの送信後にその変換ジョブのクエリを実行できます。
設定の構成
ConversionJob オブジェクトを作成すると、ConversionJob の複数の設定を使用して、変換の実行方法を指定できます。
この設定で最も重要なのは、UserToken プロパティです。このプロパティでは、変換するドキュメントにアクセスし、そのドキュメントを SharePoint Server 2010 リストに書き戻すときに使用されるユーザーの資格情報を指定します。既定では、匿名アクセスが使用されます。ベスト プラクティスとして、確実にドキュメントが正常に変換されるようにするために、変換ジョブを送信するユーザーの資格情報を UserToken プロパティに割り当てます。
UserToken プロパティ以外に、Settings プロパティには、他の変換設定のコレクションがあります。このコレクションには、以下を指定する設定が含まれます。
フィールドを自動的に更新するかどうか
既存のファイルを出力ファイルで自動的に上書きするかどうか
出力ファイルの形式
進行状況の監視
ジョブを送信すると、ジョブは、ドキュメント キューに追加された順序で非同期に処理されます。ただし、ConversionJobStatus オブジェクトで使用できるメソッドを使用して変換ジョブをいつでも監視できます。
GetAllJobs(String, Nullable<Guid>) メソッドは、(同様に、インスタンス名、ID、またはプロキシでフィルター処理された) 特定のサービス インスタンスのすべての変換ジョブの ID を返します。この変換ジョブは、必要に応じて特定のユーザーが送信したジョブにフィルター処理できます。
GetAllActiveJobs(String, Nullable<Guid>) メソッドは、(同様に、インスタンス名、ID、またはプロキシでフィルター処理された) 1 つ以上のアイテムがまだ処理されていない特定のサービス インスタンスのすべての変換ジョブの ID を返します。この変換ジョブは、必要に応じて特定のユーザーが送信したジョブにフィルター処理できます。
変換ジョブ レベルで、特定のジョブの ID (上記のメソッドから取得した ID またはジョブ作成時に使用した ID) を使用して、そのジョブの ConversionJobStatus オブジェクトを作成できます。このオブジェクトには、処理が成功した変換アイテム、処理が失敗した変換アイテム、およびまだ処理されていない変換アイテムを含むすべての変換アイテムのリストが格納されます。