CPrintInfo 構造体

印刷ジョブまたは印刷プレビュー ジョブに関する情報を格納します。

構文

struct CPrintInfo

メンバー

パブリック メソッド

名前	説明
CPrintInfo::GetFromPage	印刷される最初のページの番号を返します。
CPrintInfo::GetMaxPage	ドキュメントの最後のページの番号を返します。
CPrintInfo::GetMinPage	ドキュメントの最初のページの番号を返します。
CPrintInfo::GetOffsetPage	結合された DocObject 印刷ジョブで印刷される DocObject 項目の最初のページの前にあるページ数を返します。
CPrintInfo::GetToPage	印刷される最後のページの番号を返します。
CPrintInfo::SetMaxPage	ドキュメントの最後のページの番号を設定します。
CPrintInfo::SetMinPage	ドキュメントの最初のページの番号を設定します。

パブリック データ メンバー

名前	説明
CPrintInfo::m_bContinuePrinting	フレームワークが印刷ループを続行するかどうかを示すフラグを格納します。
CPrintInfo::m_bDirect	([印刷] ダイアログ ボックスを表示せずに) ドキュメントを直接印刷するかどうかを示すフラグを格納します。
CPrintInfo::m_bDocObject	印刷されるドキュメントが DocObject かどうかを示すフラグを格納します。
CPrintInfo::m_bPreview	ドキュメントがプレビューされているかどうかを示すフラグを格納します。
CPrintInfo::m_dwFlags	DocObject の印刷操作を指定します。
CPrintInfo::m_lpUserData	ユーザーが作成した 構造体へのポインターを格納します。
CPrintInfo::m_nCurPage	現在印刷されているページの数を識別します。
CPrintInfo::m_nJobNumber	現在の印刷ジョブに対してオペレーティング システムによって割り当てられたジョブ番号を指定します
CPrintInfo::m_nNumPreviewPages	プレビュー ウィンドウに表示されるページ数を識別します。1 または 2 のいずれか。
CPrintInfo::m_nOffsetPage	結合された DocObject 印刷ジョブ内の特定の DocObject の最初のページのオフセットを指定します。
CPrintInfo::m_pPD	[印刷] ダイアログ ボックスに使用 CPrintDialog される オブジェクトへのポインターを格納します。
CPrintInfo::m_rectDraw	現在使用できるページ領域を定義する四角形を指定します。
CPrintInfo::m_strPageDesc	ページ番号表示の書式指定文字列を格納します。

注釈

CPrintInfo は 構造体であり、基本クラスを持ちではありません。

フレームワークは、印刷または CPrintInfo 印刷プレビュー コマンドが選択されるごとに オブジェクトを作成し、コマンドの完了時に破棄します。

CPrintInfo には、印刷するページの範囲や印刷ジョブの現在の状態 (現在印刷されているページなど) など、印刷ジョブ全体に関する情報が含まれます。 一部の情報は、関連付けられている CPrintDialog オブジェクトに格納 されます。このオブジェクトには、ユーザーが [印刷] ダイアログ ボックスに入力した値が含まれます。

オブジェクト CPrintInfo は、印刷プロセス中にフレームワークとビュー クラスの間で渡され、2 つの間で情報を交換するために使用されます。 m_nCurPageCPrintInfoたとえば、フレームワークは、 のメンバーに値を割り当て、印刷するドキュメントのページをビュー クラスに通知します。ビュー クラスは値を取得し、指定したページの実際の印刷を実行します。

もう 1 つの例は、ドキュメントが印刷されるまでドキュメントの長さが分からない場合です。 この状況では、ビュー クラスは、ページが印刷されるたび、ドキュメントの末尾をテストします。 終了に達すると、ビュー クラスm_bContinuePrintingCPrintInfoは のメンバーを FALSE に設定します。これにより、印刷ループを停止するメッセージがフレームワークに通知されます。

CPrintInfoは、"See Also" の下にCView一覧表示されている のメンバー関数によって使用されます。Microsoft Foundation Class ライブラリ によって提供される印刷アーキテクチャの詳細については、「フレーム Windows とドキュメント/ビュー アーキテクチャ」および「印刷と印刷: マルチページ ドキュメント」を参照してください。

継承階層

CPrintInfo

必要条件

ヘッダー: afxext.h

CPrintInfo::GetFromPage

この関数を呼び出して、印刷する最初のページの番号を取得します。

UINT GetFromPage() const;

戻り値

印刷する最初のページの番号。

注釈

これは、ユーザーが [印刷] ダイアログ CPrintDialog ボックスで指定した値であり、メンバーによって参照される オブジェクトに格納 m_pPD されます。 ユーザーが値を指定していない場合、既定値はドキュメントの最初のページです。

CPrintInfo::GetMaxPage

この関数を呼び出して、ドキュメントの最後のページの番号を取得します。

UINT GetMaxPage() const;

戻り値

ドキュメントの最後のページの番号。

注釈

この値は、 メンバーによって参照 CPrintDialog される オブジェクトに格納 m_pPD されます。

CPrintInfo::GetMinPage

この関数を呼び出して、ドキュメントの最初のページの番号を取得します。

UINT GetMinPage() const;

戻り値

ドキュメントの最初のページの番号。

注釈

この値は、 メンバーによって参照 CPrintDialog される オブジェクトに格納 m_pPD されます。

CPrintInfo::GetOffsetPage

DocObject クライアントから複数の DocObject 項目を印刷するときにオフセットを取得するには、この関数を呼び出します。

UINT GetOffsetPage() const;

戻り値

結合された DocObject 印刷ジョブで印刷される DocObject 項目の最初のページの前のページ数。

注釈

この値は、 メンバーによって参照 m_nOffsetPage されます。 ドキュメントの最初のページには、 m_nOffsetPage 他のアクティブなドキュメントを含む DocObject として出力された場合、値 + 1 の番号が付きます。 メンバー m_nOffsetPage は、値が TRUE の場合 m_bDocObject にのみ有効です。

CPrintInfo::GetToPage

この関数を呼び出して、印刷する最後のページの番号を取得します。

UINT GetToPage() const;

戻り値

印刷する最後のページの番号。

注釈

これは、ユーザーが [印刷] ダイアログ CPrintDialog ボックスで指定した値であり、メンバーによって参照される オブジェクトに格納 m_pPD されます。 ユーザーが値を指定していない場合、既定値はドキュメントの最後のページです。

CPrintInfo:: m_bContinuePrinting

フレームワークで印刷ループを続行するかどうかを示すフラグが含まれています。

注釈

印刷時の改ページ位置の自動修正を実行している場合は、ドキュメントの末尾に達したときにの CView::OnPrepareDC オーバーライドで、このメンバーを FALSE に設定できます。 メンバー関数を使用して SetMaxPage 印刷ジョブの開始時にドキュメントの長さを指定している場合は、この変数を変更する必要はありません。 m_bContinuePrintingメンバーは、BOOL 型のパブリック変数です。

CPrintInfo:: m_bDirect

[印刷] ダイアログボックスが直接印刷のためにバイパスされる場合、フレームワークはこのメンバーを TRUE に設定します。それ以外の場合は FALSE。

注釈

通常、[印刷] ダイアログは、シェルから印刷するとき、またはコマンド ID ID_FILE_PRINT_DIRECT を使用して印刷を行うときにバイパスされます。

通常、このメンバーは変更しませんが、変更する場合は、cview: : OnPreparePrintingのオーバーライドでCview::D oPreparePrintingを呼び出す前に変更してください。

CPrintInfo:: m_bDocObject

印刷されるドキュメントが DocObject であるかどうかを示すフラグが含まれています。

注釈

データメンバー m_dwFlags とは、 m_nOffsetPage このフラグが TRUE でない限り無効です。

CPrintInfo:: m_bPreview

ドキュメントがプレビューされているかどうかを示すフラグが含まれています。

注釈

これは、ユーザーが実行したコマンドに応じて、フレームワークによって設定されます。 印刷プレビュージョブの場合、[印刷] ダイアログボックスは表示されません。 m_bPreviewメンバーは、BOOL 型のパブリック変数です。

CPrintInfo:: m_dwFlags

DocObject 印刷操作を指定するフラグの組み合わせが含まれています。

注釈

データメンバー m_bDocObject が TRUE の場合にのみ有効です。

フラグには、次の値の1つ以上を指定できます。

• PRINTFLAG_MAYBOTHERUSER

• PRINTFLAG_PROMPTUSER

• PRINTFLAG_USERMAYCHANGEPRINTER

• PRINTFLAG_RECOMPOSETODEVICE

• PRINTFLAG_DONTACTUALLYPRINT

• PRINTFLAG_FORCEPROPERTIES

• PRINTFLAG_PRINTTOFILE

CPrintInfo:: m_lpUserData

ユーザーが作成した構造体へのポインターを格納します。

注釈

これを使用すると、ビュークラスに格納しない印刷固有のデータを格納できます。 m_lpUserDataメンバーは、LPVOID 型のパブリック変数です。

CPrintInfo:: m_nCurPage

現在のページの番号を格納します。

注釈

フレームワークは、ドキュメントの各ページに対してとを CView::OnPrint 1 回呼び出し CView::OnPrepareDC 、このメンバーに対して毎回異なる値を指定します。値は、によって返さ GetFromPage れる値から、によって GetToPage 返される値までの範囲です。 このメンバーをおよび CView::OnPrint の CView::OnPrepareDC オーバーライドで使用して、指定したドキュメントのページを印刷します。

プレビューモードが最初に呼び出されたときに、フレームワークはこのメンバーの値を読み取って、ドキュメントのどのページを最初にプレビューするかを決定します。 の CView::OnPreparePrinting オーバーライドでこのメンバーの値を設定して、プレビューモードに入るときにドキュメント内のユーザーの現在の位置を維持することができます。 m_nCurPageメンバーは、UINT 型のパブリック変数です。

CPrintInfo:: m_nJobNumber

現在の印刷ジョブに対してオペレーティングシステムによって割り当てられたジョブ番号を示します。

注釈

この値は、ジョブがまだ印刷されていない場合 (つまり、 CPrintInfo オブジェクトが新しく構築されていて、まだ印刷に使用されていない場合)、またはジョブの開始中にエラーが発生した場合に SP_ERROR ます。

CPrintInfo:: m_nNumPreviewPages

プレビューモードで表示されるページ数を含みます。1または2のいずれかを指定できます。

注釈

m_nNumPreviewPagesメンバーは、UINT 型のパブリック変数です。

CPrintInfo:: m_nOffsetPage

結合された DocObject print ジョブ内の特定の DocObject の最初のページの前のページ数を含みます。

CPrintInfo:: m_pPD

印刷ジョブの [印刷] ダイアログボックスを表示するために使用するオブジェクトへ CPrintDialog のポインターを格納します。

注釈

m_pPDメンバーは、へ CPrintDialog のポインターとして宣言されたパブリック変数です。

CPrintInfo:: m_rectDraw

ページの使用可能な描画領域を論理座標で指定します。

注釈

の CView::OnPrint オーバーライドでこれを参照することもできます。 このメンバーを使用すると、ヘッダーやフッターなどを印刷した後に使用できる領域を追跡できます。 m_rectDrawメンバーは型 CRect のパブリック変数です。

CPrintInfo:: m_strPageDesc

印刷プレビュー中にページ番号を表示するために使用される書式設定文字列が含まれています。この文字列は2つの部分文字列で構成されます。1ページ表示の場合は1つ、2ページ表示の場合は1つであり、それぞれ ' \n ' 文字で終了します。

注釈

フレームワークでは、"ページ% u\nページ% u-% u\n" が既定値として使用されます。 ページ番号に別の形式を使用する場合は、の CView::OnPreparePrinting オーバーライドで書式設定文字列を指定します。 m_strPageDescメンバーは型 CString のパブリック変数です。

CPrintInfo:: SetMaxPage

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

void SetMaxPage(UINT nMaxPage);

パラメーター

nMaxPage
ドキュメントの最後のページ番号。

注釈

この値は、 m_pPD メンバーによって参照されるオブジェクトに CPrintDialog 格納されます。 ドキュメントが印刷される前にその長さがわかっている場合は、の CView::OnPreparePrinting オーバーライドからこの関数を呼び出します。 ドキュメントの長さが、[印刷] ダイアログボックスでユーザーが指定した設定に依存している場合は、の CView::OnBeginPrinting オーバーライドからこの関数を呼び出します。 ドキュメントの長さが印刷されるまでわからない場合は、メンバーを使用 m_bContinuePrinting して印刷ループを制御します。

例

CView:: OnPreparePrintingの例を参照してください。

CPrintInfo:: SetMinPage

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

void SetMinPage(UINT nMinPage);

パラメーター

nMinPage
ドキュメントの最初のページの番号。

注釈

通常、ページ番号は1から始まります。 この値は、 m_pPD メンバーによって参照されるオブジェクトに CPrintDialog 格納されます。

こちらもご覧ください

MFC のサンプル DIBLOOK
階層図
CView::OnBeginPrinting
CView:: OnEndPrinting
CView:: OnEndPrintPreview
CView:: OnPrepareDC
CView:: OnPreparePrinting
CView::OnPrint