ドキュメント コンバータのオブジェクト モデル
Windows SharePoint Services 3.0 オブジェクト モデルには、指定した Web アプリケーション内のドキュメント コンバータを表すメンバや、指定したドキュメント ライブラリ内の変換後のコピーを表すメンバが含まれます。
ドキュメント コンバータを表すオブジェクト モデルのメンバ
Microsoft.SharePoint.Administration 名前空間の以下のメンバを使用すると、特定の Web アプリケーション内のドキュメント コンバータをプログラム的に構成できます。
DocumentConverters Web アプリケーションに現在インストールされているドキュメント トランスフォーマを表す SPDocumentConverterCollection オブジェクトを返します。
DocumentConversionsEnabled Web アプリケーションでドキュメント トランスフォーマが有効になっているかどうかを取得します。または、有効にするかどうかを設定します。
DocumentConversionsLoadBalancerUrl Web アプリケーションのために DocConversionLoadBalancerService サービスを実行しているサーバーの URI を取得または設定します。
DocumentConversionsSchedule ドキュメント コンバータのスケジュールを取得または設定します。
SPDocumentConverterCollection Web アプリケーションに現在インストールされているドキュメント トランスフォーマを表します。
SPDocumentConverter Web アプリケーションに現在インストールされている単一のドキュメント トランスフォーマを表します。このオブジェクトには、ドキュメント コンバータ定義スキーマで定義されている、コンバータ名、アセンブリ名、変換先と変換元のファイル名拡張子、コンバータのユーザー インターフェイス ページなどのコンバータ設定を表す読み取り専用のプロパティが含まれています。さらに、それぞれの SPDocumentConverter インスタンスには、管理者によって Web アプリケーション レベルで設定されたコンバータ設定も含まれています。これらの Web アプリケーション固有の設定には、ドキュメント コンバータをエンド ユーザー用のユーザー インターフェイスに表示するかどうか、再試行の最大数、変換での最大ファイル サイズ、およびタイムアウトまでの長さの設定が含まれます。
詳細については、「ドキュメント コンバータ定義スキーマ」を参照してください。
変換されたドキュメントを表すオブジェクト モデルのメンバ
SPFile オブジェクトの以下のメンバを使用すると、元のファイルと、それらの変換後のコピーをプログラム的に識別し、操作することができます。
Convert このメソッドは、指定されたドキュメント コンバータを使用して、指定されたドキュメントの変換後のコピーを作成します。ドキュメント コンバータに渡すカスタム構成情報、変換後のコピーのファイル名、変換の優先度、通知先のユーザーの電子メール アドレス、および変換後のコピーを添付ファイルとして通知に含めるかどうかを指定することもできます。変換後のコピーに対して、Microsoft Office SharePoint Server 2007 ではなくカスタム アセンブリによって後処理を実行する場合は、カスタム ハンドラのアセンブリとクラスを指定できます。カスタム ハンドラを指定しない場合は、Office SharePoint Server 2007 が、変換後のコピーの通常の後処理を実行します。
カスタム処理の詳細については、「変換されたドキュメントのカスタム処理」を参照してください。
Office SharePoint Server 2007 が既定で実行する後処理の詳細については、「変換されたドキュメント」を参照してください。戻り値の型 SPFileConversionResult は、ドキュメント変換の結果を示します。
GetConvertedFile 指定されたドキュメント コンバータを使用してこのファイルから生成された、変換後のコピーを返します。指定されたコンバータによって生成された変換後のコピーがない場合は null を返します。
GetConversionState 指定されたドキュメント コンバータを使用した変換の状態を表す SPFileConversionState 列挙を返します。このメソッドを呼び出すと、このドキュメント コンバータを使用した変換が可能かどうかも判断できます。SPFileConversionState 列挙に含まれる値は以下のとおりです。
Available 指定されたドキュメント コンバータを使用したこのファイルの変換は、このシステムでサポートされています。
Completed 指定されたドキュメント コンバータを使用したこのファイルの変換は完了していません。
NotAvailable 指定されたドキュメント コンバータを使用したこのファイルの変換は、このシステムではサポートされていません。
Pending 指定されたドキュメント コンバータを使用したこのファイルの変換が要求されましたが、まだ完了していません。
IsConvertedFile ファイルが別のドキュメントの変換後のコピーである場合は true を返します。
SPFile.ParentFile この変換後のコピーを作成するために使用された元のドキュメントを表す SPFile オブジェクトを返します。選択されたファイルが変換後のコピーでない場合は null を返します。
GeneratingConverterId この変換後のコピーを作成するために使用されたドキュメント コンバータの GUID を返します。選択されたファイルが変換後のコピーでない場合は null を返します。
Generator この変換後のコピーを作成するために使用されたドキュメント コンバータの名前を返します。