Struktur CPrintInfo

Menyimpan informasi tentang pekerjaan cetak atau pratinjau cetak.

Sintaks

struct CPrintInfo

Anggota

Metode Publik

Nama	Deskripsi
CPrintInfo::GetFromPage	Mengembalikan jumlah halaman pertama yang sedang dicetak.
CPrintInfo::GetMaxPage	Mengembalikan jumlah halaman terakhir dokumen.
CPrintInfo::GetMinpage	Mengembalikan jumlah halaman pertama dokumen.
CPrintInfo::GetOffsetPage	Mengembalikan jumlah halaman sebelum halaman pertama item DocObject yang dicetak dalam pekerjaan cetak DocObject gabungan.
CPrintInfo::GetToPage	Mengembalikan jumlah halaman terakhir yang sedang dicetak.
CPrintInfo::SetMaxPage	Mengatur jumlah halaman terakhir dokumen.
CPrintInfo::SetMinPage	Mengatur jumlah halaman pertama dokumen.

Anggota Data Publik

Nama	Deskripsi
CPrintInfo::m_bContinuePrinting	Berisi bendera yang menunjukkan apakah kerangka kerja harus melanjutkan perulangan cetak.
CPrintInfo::m_bDirect	Berisi bendera yang menunjukkan apakah dokumen sedang dicetak secara langsung (tanpa menampilkan kotak dialog Cetak).
CPrintInfo::m_bDocObject	Berisi bendera yang menunjukkan apakah dokumen yang sedang dicetak adalah DocObject.
CPrintInfo::m_bPreview	Berisi bendera yang menunjukkan apakah dokumen sedang dipratinjau.
CPrintInfo::m_dwFlags	Menentukan operasi pencetakan DocObject.
CPrintInfo::m_lpUserData	Berisi penunjuk ke struktur yang dibuat pengguna.
CPrintInfo::m_nCurPage	Mengidentifikasi jumlah halaman yang sedang dicetak.
CPrintInfo::m_nJobNumber	Menentukan nomor pekerjaan yang ditetapkan oleh sistem operasi untuk pekerjaan cetak saat ini
CPrintInfo::m_nNumPreviewPages	Mengidentifikasi jumlah halaman yang ditampilkan di jendela pratinjau; baik 1 atau 2.
CPrintInfo::m_nOffsetPage	Menentukan offset halaman pertama DocObject tertentu dalam pekerjaan cetak DocObject gabungan.
CPrintInfo::m_pPD	Berisi penunjuk ke objek yang CPrintDialog digunakan untuk kotak dialog Cetak.
CPrintInfo::m_rectDraw	Menentukan persegi panjang yang menentukan area halaman yang dapat digunakan saat ini.
CPrintInfo::m_strPageDesc	Berisi string format untuk tampilan nomor halaman.

Keterangan

CPrintInfo adalah struktur dan tidak memiliki kelas dasar.

Kerangka kerja membuat objek CPrintInfo setiap kali perintah Cetak atau Pratinjau Cetak dipilih dan menghancurkannya saat perintah selesai.

CPrintInfo berisi informasi tentang pekerjaan cetak secara keseluruhan, seperti rentang halaman yang akan dicetak, dan status pekerjaan cetak saat ini, seperti halaman yang sedang dicetak. Beberapa informasi disimpan dalam objek CPrintDialog terkait; objek ini berisi nilai yang dimasukkan oleh pengguna dalam kotak dialog Cetak.

Objek CPrintInfo diteruskan antara kerangka kerja dan kelas tampilan Anda selama proses pencetakan dan digunakan untuk bertukar informasi antara keduanya. Misalnya, kerangka kerja menginformasikan kelas tampilan halaman dokumen mana yang akan dicetak dengan menetapkan nilai kepada m_nCurPage anggota CPrintInfo; kelas tampilan mengambil nilai dan melakukan pencetakan aktual halaman yang ditentukan.

Contoh lain adalah kasus di mana panjang dokumen tidak diketahui sampai dicetak. Dalam situasi ini, kelas tampilan menguji akhir dokumen setiap kali halaman dicetak. Ketika akhir tercapai, kelas tampilan mengatur m_bContinuePrinting anggota CPrintInfo ke FALSE; ini menginformasikan kerangka kerja untuk menghentikan perulangan cetak.

CPrintInfo digunakan oleh fungsi anggota yang CView tercantum di bawah "Lihat Juga." Untuk informasi selengkapnya tentang arsitektur pencetakan yang disediakan oleh Pustaka Kelas Microsoft Foundation, lihat Bingkai Windows dan Arsitektur Dokumen/Tampilan dan artikel Pencetakan dan Pencetakan: Dokumen Multipage.

Hierarki Warisan

CPrintInfo

Persyaratan

Header: afxext.h

CPrintInfo::GetFromPage

Panggil fungsi ini untuk mengambil jumlah halaman pertama yang akan dicetak.

UINT GetFromPage() const;

Tampilkan Nilai

Jumlah halaman pertama yang akan dicetak.

Keterangan

Ini adalah nilai yang ditentukan oleh pengguna dalam kotak dialog Cetak, dan disimpan dalam objek yang CPrintDialog dirujuk oleh m_pPD anggota. Jika pengguna belum menentukan nilai, defaultnya adalah halaman pertama dokumen.

CPrintInfo::GetMaxPage

Panggil fungsi ini untuk mengambil jumlah halaman terakhir dokumen.

UINT GetMaxPage() const;

Tampilkan Nilai

Jumlah halaman terakhir dokumen.

Keterangan

Nilai ini disimpan dalam objek yang dirujuk CPrintDialog oleh m_pPD anggota.

CPrintInfo::GetMinpage

Panggil fungsi ini untuk mengambil jumlah halaman pertama dokumen.

UINT GetMinPage() const;

Tampilkan Nilai

Jumlah halaman pertama dokumen.

Keterangan

Nilai ini disimpan dalam objek yang dirujuk CPrintDialog oleh m_pPD anggota.

CPrintInfo::GetOffsetPage

Panggil fungsi ini untuk mengambil offset saat mencetak beberapa item DocObject dari klien DocObject.

UINT GetOffsetPage() const;

Tampilkan Nilai

Jumlah halaman sebelum halaman pertama item DocObject dicetak dalam pekerjaan cetak DocObject gabungan.

Keterangan

Nilai ini dirujuk oleh m_nOffsetPage anggota. Halaman pertama dokumen Anda akan diberi m_nOffsetPage nomor nilai + 1 saat dicetak sebagai DocObject dengan dokumen aktif lainnya. Anggota m_nOffsetPage hanya valid jika nilainya m_bDocObject TRUE.

CPrintInfo::GetToPage

Panggil fungsi ini untuk mengambil jumlah halaman terakhir yang akan dicetak.

UINT GetToPage() const;

Tampilkan Nilai

Jumlah halaman terakhir yang akan dicetak.

Keterangan

Ini adalah nilai yang ditentukan oleh pengguna dalam kotak dialog Cetak, dan disimpan dalam objek yang CPrintDialog dirujuk oleh m_pPD anggota. Jika pengguna belum menentukan nilai, defaultnya adalah halaman terakhir dokumen.

CPrintInfo::m_bContinuePrinting

Berisi bendera yang menunjukkan apakah kerangka kerja harus melanjutkan perulangan cetak.

Keterangan

Jika Anda melakukan penomoran halaman waktu cetak, Anda dapat mengatur anggota ini ke FALSE dalam penimpaan CView::OnPrepareDC Setelah akhir dokumen tercapai. Anda tidak perlu mengubah variabel ini jika Anda telah menentukan panjang dokumen di awal pekerjaan cetak menggunakan SetMaxPage fungsi anggota. Anggota m_bContinuePrinting adalah variabel publik jenis BOOL.

CPrintInfo::m_bDirect

Kerangka kerja mengatur anggota ini ke TRUE jika kotak dialog Cetak akan dilewati untuk pencetakan langsung; FALSE jika tidak.

Keterangan

Dialog Cetak biasanya dilewati saat Anda mencetak dari shell atau ketika pencetakan selesai menggunakan ID perintah ID_FILE_PRINT_DIRECT.

Anda biasanya tidak mengubah anggota ini, tetapi jika Anda mengubahnya, ubah sebelum Anda memanggil CView::D oPreparePrinting dalam penimpaan CView::OnPreparePrinting Anda.

CPrintInfo::m_bDocObject

Berisi bendera yang menunjukkan apakah dokumen yang sedang dicetak adalah DocObject.

Keterangan

Anggota m_dwFlags data dan m_nOffsetPage tidak valid kecuali bendera ini TRUE.

CPrintInfo::m_bPreview

Berisi bendera yang menunjukkan apakah dokumen sedang dipratinjau.

Keterangan

Ini diatur oleh kerangka kerja tergantung pada perintah mana yang dijalankan pengguna. Kotak dialog Cetak tidak ditampilkan untuk pekerjaan pratinjau cetak. Anggota m_bPreview adalah variabel publik jenis BOOL.

CPrintInfo::m_dwFlags

Berisi kombinasi bendera yang menentukan operasi pencetakan DocObject.

Keterangan

Valid hanya jika anggota m_bDocObject data TRUE.

Bendera dapat berupa satu atau beberapa nilai berikut:

• PRINTFLAG_MAYBOTHERUSER

• PRINTFLAG_PROMPTUSER

• PRINTFLAG_USERMAYCHANGEPRINTER

• PRINTFLAG_RECOMPOSETODEVICE

• PRINTFLAG_DONTACTUALLYPRINT

• PRINTFLAG_FORCEPROPERTIES

• PRINTFLAG_PRINTTOFILE

CPrintInfo::m_lpUserData

Berisi penunjuk ke struktur yang dibuat pengguna.

Keterangan

Anda dapat menggunakan ini untuk menyimpan data khusus pencetakan yang tidak ingin Anda simpan di kelas tampilan Anda. Anggota m_lpUserData adalah variabel publik jenis LPVOID.

CPrintInfo::m_nCurPage

Berisi jumlah halaman saat ini.

Keterangan

Kerangka kerja memanggil dan CView::OnPrint sekali untuk setiap halaman dokumen, menentukan nilai yang berbeda untuk anggota ini setiap kali; nilainya berkisar CView::OnPrepareDC dari nilai yang dikembalikan oleh GetFromPage ke yang dikembalikan oleh GetToPage. Gunakan anggota ini dalam penimpaan CView::OnPrepareDC Anda dan CView::OnPrint untuk mencetak halaman dokumen yang ditentukan.

Ketika mode pratinjau pertama kali dipanggil, kerangka kerja membaca nilai anggota ini untuk menentukan halaman dokumen mana yang harus dipratinjau pada awalnya. Anda dapat mengatur nilai anggota ini dalam penimpaan CView::OnPreparePrinting Anda untuk mempertahankan posisi pengguna saat ini dalam dokumen saat memasuki mode pratinjau. Anggota m_nCurPage adalah variabel publik jenis UINT.

CPrintInfo::m_nJobNumber

Menunjukkan nomor pekerjaan yang ditetapkan oleh sistem operasi untuk pekerjaan cetak saat ini.

Keterangan

Nilai ini mungkin SP_ERROR jika pekerjaan belum dicetak (yaitu, jika CPrintInfo objek baru dibangun dan belum digunakan untuk mencetak), atau jika ada kesalahan dalam memulai pekerjaan.

CPrintInfo::m_nNumPreviewPages

Berisi jumlah halaman yang ditampilkan dalam mode pratinjau; bisa 1 atau 2.

Keterangan

Anggota m_nNumPreviewPages adalah variabel publik jenis UINT.

CPrintInfo::m_nOffsetPage

Berisi jumlah halaman sebelum halaman pertama DocObject tertentu dalam pekerjaan cetak DocObject gabungan.

CPrintInfo::m_pPD

Berisi penunjuk ke objek yang CPrintDialog digunakan untuk menampilkan kotak dialog Cetak untuk tugas cetak.

Keterangan

Anggota m_pPD adalah variabel publik yang dinyatakan sebagai penunjuk ke CPrintDialog.

CPrintInfo::m_rectDraw

Menentukan area gambar halaman yang dapat digunakan dalam koordinat logis.

Keterangan

Anda mungkin ingin merujuk ke ini dalam penimpaan Anda dari CView::OnPrint. Anda dapat menggunakan anggota ini untuk melacak area apa yang tetap dapat digunakan setelah Anda mencetak header, footer, dan sebagainya. Anggota m_rectDraw adalah variabel publik jenis CRect.

CPrintInfo::m_strPageDesc

Berisi string format yang digunakan untuk menampilkan nomor halaman selama pratinjau cetak; string ini terdiri dari dua substring, satu untuk tampilan satu halaman dan satu untuk tampilan halaman ganda, masing-masing dihentikan oleh karakter '\n'.

Keterangan

Kerangka kerja menggunakan "Halaman %u\nPages %u-%u\n" sebagai nilai default. Jika Anda menginginkan format yang berbeda untuk nomor halaman, tentukan string format dalam penimpaan Anda.CView::OnPreparePrinting Anggota m_strPageDesc adalah variabel publik jenis CString.

CPrintInfo::SetMaxPage

Panggil fungsi ini untuk menentukan jumlah halaman terakhir dokumen.

void SetMaxPage(UINT nMaxPage);

Parameter

nMaxPage
Jumlah halaman terakhir dokumen.

Keterangan

Nilai ini disimpan dalam objek yang dirujuk CPrintDialog oleh m_pPD anggota. Jika panjang dokumen diketahui sebelum dicetak, panggil fungsi ini dari penimpaan Anda dari CView::OnPreparePrinting. Jika panjang dokumen bergantung pada pengaturan yang ditentukan oleh pengguna dalam kotak dialog Cetak, panggil fungsi ini dari penimpaan Anda .CView::OnBeginPrinting Jika panjang dokumen tidak diketahui sampai dicetak, gunakan m_bContinuePrinting anggota untuk mengontrol perulangan cetak.

Contoh

Lihat contoh untuk CView::OnPreparePrinting.

CPrintInfo::SetMinPage

Panggil fungsi ini untuk menentukan jumlah halaman pertama dokumen.

void SetMinPage(UINT nMinPage);

Parameter

nMinPage
Jumlah halaman pertama dokumen.

Keterangan

Nomor halaman biasanya dimulai pada 1. Nilai ini disimpan dalam objek yang dirujuk CPrintDialog oleh m_pPD anggota.

Baca juga

Sampel MFC DIBLOOK
Bagan Hierarki
CView::OnBeginPrinting
CView::OnEndPrinting
CView::OnEndPrintPreview
CView::OnPreparedc
CView::OnPreparePrinting
CView::OnPrint