IPrint

複合ドキュメント全般、特にアクティブドキュメントがプログラムによる印刷をサポートできるようにします。

ドキュメントの読み込み後、コンテナーやその他のクライアントは IPrint::Print を呼び出して、ドキュメント自身に印刷を指示できます。その際、印刷制御フラグ、ターゲットデバイス、印刷する特定のページ、その他のオプションを指定します。クライアントは IContinueCallback インターフェイスを呼び出すことで、印刷の継続を制御できます。

IPrint を実装するオブジェクトは、自身の CLSID の下に格納された Printable キーを使用して、次のように自身を登録します。

HKEY_CLASSES_ROOT\CLSID{...}\Printable

呼び出し元は、レジストリでこのキーを調べることにより、特定のオブジェクトクラスが永続状態のプログラムによる印刷をサポートしているかどうかを判断します。

ドキュメントの最初のページのページ番号を設定します。

このメソッドは、標準的な戻り値 E_UNEXPECTED、E_FAIL、および S_OK を返すことがあります。

最初のページに負の数を設定することは有効です。これは、通常のページ付けからのオフセットを指定するページ番号でドキュメントの一部を印刷する場合に役立つことがあります。

すべての実装が最初のページ番号の設定を許可しているわけではありません。一部の実装では、最終出力でページ番号をどのように表示すべきかに関する情報を単純に持っていないためです。

ドキュメントの最初のページの番号と総ページ数を取得します。

このメソッドは、標準的な戻り値 E_UNEXPECTED および S_OK を返すことがあります。

指定されたジョブ要件を使用して、指定されたプリンター上にオブジェクトを印刷します。

このメソッドは、標準的な戻り値 E_UNEXPECTED のほか、次の値を返すことがあります。

オブジェクトを印刷するプリンターは、pptd が指す DVTARGETDEVICE 構造体によって示されます。ターゲットデバイス内の DEVMODE 構造体は、部数、用紙サイズ、印刷品質など、ジョブ全体に対するプリンター固有のオプションを示します。DEVMODE 構造体には、dmOrientation メンバーに用紙の向きの情報が含まれることもあります(これは dmFields メンバーで示されます)。存在する場合は、この用紙の向きを使用する必要があります。存在しない場合は、オブジェクトのコンテンツによって決定される自然な向きが使用されます。

ユーザー入力の可能性があるため、パラメーター pptd および ppPageSet はいずれも [in,out] 構造体です。ユーザーの操作がない場合(つまり PRINTFLAG_PROMPTUSER フラグが設定されていない場合)、ターゲットデバイスとページセットは入力時と出力時で必ず同じになります。ただし、ユーザーに印刷オプションの入力を求める場合、オブジェクトはユーザーが実際に選択した内容に応じたターゲットデバイスとページセットの情報を返します。

pstgmOptions パラメーターも [in,out] です。終了時に、オブジェクトはこの印刷ジョブを正確に再現するために必要となるオブジェクト固有の情報を *pstgmOptions に書き込む必要があります。例としては、スプレッドシートアプリケーションでユーザーが「シート、メモ、または両方」のいずれを選択したかなどが挙げられます。渡されるデータは、シリアル化されたプロパティセットの形式です。このデータは通常、同じオブジェクトへの後続の呼び出しに渡された場合にのみ有用です。後続の呼び出しでは異なるユーザー操作フラグ、ターゲットデバイス、その他の設定が指定される可能性があるため、呼び出し元は、わずかに異なる印刷コンテキストで同じ方法によりドキュメントを複数回印刷させることができます。