Estrutura CPrintInfo

Armazena informação sobre um trabalho de impressão ou pré-visualização.

Sintaxe

struct CPrintInfo

Membros

Métodos Públicos

Membros de Dados Públicos

Observações

CPrintInfo é uma estrutura e não tem uma classe base.

O framework cria um objeto de CPrintInfo cada vez que o comando Print ou Print Preview é escolhido e destrói-o quando o comando é concluído.

CPrintInfo contém informação tanto sobre o trabalho de impressão como um todo, como o intervalo de páginas a imprimir, como o estado atual do trabalho de impressão, como a página que está a ser impressa. Alguma informação é armazenada num objeto CPrintDialog associado; este objeto contém os valores introduzidos pelo utilizador na caixa de diálogo Imprimir.

Um CPrintInfo objeto é passado entre o framework e a sua classe view durante o processo de impressão e é usado para trocar informação entre os dois. Por exemplo, o framework informa a classe view qual página do documento deve imprimir, atribuindo um valor ao m_nCurPage membro de CPrintInfo; a classe view recupera o valor e realiza a impressão efetiva da página especificada.

Outro exemplo é o caso em que o comprimento do documento não é conhecido até ser impresso. Nesta situação, a classe view testa o final do documento cada vez que uma página é impressa. Quando o fim é alcançado, a classe view define o m_bContinuePrinting membro de CPrintInfo como FALSE; isto informa o framework para parar o loop de impressão.

CPrintInfo é utilizado pelas funções membros de CView listadas em "Ver Também." Para mais informações sobre a arquitetura de impressão fornecida pela Microsoft Foundation Class Library, consulte Janelas Enquadradas e Arquitetura de Documentos/Visualizações e os artigos Impressão e Impressão: Documentos Multipágina.

Hierarquia de herança

CPrintInfo

Requerimentos

Cabeçalho: afxext.h

CPrintInfo::GetFromPage

Chame esta função para recuperar o número da primeira página a imprimir.

UINT GetFromPage() const;

Valor de retorno

O número da primeira página a ser impressa.

Observações

Este é o valor especificado pelo utilizador na caixa de diálogo Imprimir, e é armazenado no CPrintDialog objeto referenciado pelo m_pPD membro. Se o utilizador não tiver especificado um valor, o padrão é a primeira página do documento.

CPrintInfo::GetMaxPage

Chame esta função para recuperar o número da última página do documento.

UINT GetMaxPage() const;

Valor de retorno

O número da última página do documento.

Observações

Este valor é armazenado no CPrintDialog objeto referenciado pelo m_pPD membro.

CPrintInfo::GetMinPage

Chame esta função para recuperar o número da primeira página do documento.

UINT GetMinPage() const;

Valor de retorno

O número da primeira página do documento.

Observações

Este valor é armazenado no CPrintDialog objeto referenciado pelo m_pPD membro.

CPrintInfo::GetOffsetPage

Chame esta função para recuperar o offset ao imprimir múltiplos itens DocObject de um cliente DocObject.

UINT GetOffsetPage() const;

Valor de retorno

O número de páginas que precedem a primeira página de um item DocObject a serem impressas num trabalho combinado de impressão DocObject.

Observações

Este valor é referenciado pelo m_nOffsetPage membro. A primeira página do seu documento será numerada com o m_nOffsetPage valor + 1 quando impresso como um DocObject com outros documentos ativos. O m_nOffsetPage membro só é válido se o m_bDocObject valor for VERDADEIRO.

CPrintInfo::GetToPage

Chame esta função para recuperar o número da última página a imprimir.

UINT GetToPage() const;

Valor de retorno

O número da última página a ser impressa.

Observações

Este é o valor especificado pelo utilizador na caixa de diálogo Imprimir, e é armazenado no CPrintDialog objeto referenciado pelo m_pPD membro. Se o utilizador não tiver especificado um valor, o padrão é a última página do documento.

CPrintInfo::m_bContinuePrinting

Contém uma bandeira que indica se a estrutura deve continuar o ciclo de impressão.

Observações

Se estiver a fazer paginação em tempo de impressão, pode definir este membro como FALSE na sua sobreposição quando CView::OnPrepareDC o documento terminar. Não é necessário modificar esta variável se tiver especificado o comprimento do documento no início do trabalho de impressão usando a SetMaxPage função membro. O m_bContinuePrinting membro é uma variável pública do tipo BOOL.

CPrintInfo::m_bDirect

O framework define este membro para TRUE se a caixa de diálogo Imprimir for ignorada para impressão direta; FALSO, caso contrário.

Observações

A caixa de diálogo Imprimir é normalmente ignorada quando imprime a partir do shell ou quando a impressão é feita usando o comando ID ID_FILE_PRINT_DIRECT.

Normalmente não mudas este membro, mas se o mudares, muda-o antes de chamares CView::D oPreparePrinting na tua substituição de CView::OnPreparePrinting.

CPrintInfo::m_bDocObject

Contém um flag indicando se o documento a ser impresso é um DocObject.

Observações

Os membros dos dados m_dwFlags e m_nOffsetPage são inválidos, a menos que esta flag seja VERDADEIRA.

CPrintInfo::m_bPreview

Contém uma bandeira indicando se o documento está a ser pré-visualizado.

Observações

Isto é definido pelo framework dependendo do comando que o utilizador executou. A caixa de diálogo Imprimir não é exibida para um trabalho de pré-visualização de impressão. O m_bPreview membro é uma variável pública do tipo BOOL.

CPrintInfo::m_dwFlags

Contém uma combinação de flags que especificam operações de impressão DocObject.

Observações

Válido apenas se o membro m_bDocObject de dados for VERDADEIRO.

As bandeiras podem ter um ou mais dos seguintes valores:

• PRINTFLAG_MAYBOTHERUSER

• PRINTFLAG_PROMPTUSER

• PRINTFLAG_USERMAYCHANGEPRINTER

• PRINTFLAG_RECOMPOSETODEVICE

• PRINTFLAG_DONTACTUALLYPRINT

• PRINTFLAG_FORCEPROPERTIES

• PRINTFLAG_PRINTTOFILE

CPrintInfo::m_lpUserData

Contém um ponteiro para uma estrutura criada pelo utilizador.

Observações

Pode usar isto para armazenar dados específicos de impressão que não quer armazenar na sua classe de visualização. O m_lpUserData membro é uma variável pública do tipo LPVOID.

CPrintInfo::m_nCurPage

Contém o número da página atual.

Observações

O framework chama CView::OnPrepareDC e CView::OnPrint uma vez para cada página do documento, especificando um valor diferente para este membro a cada vez; os seus valores variam do valor devolvido por GetFromPage ao valor devolvido por GetToPage. Use este membro nas suas sobreposições de CView::OnPrepareDC e CView::OnPrint para imprimir a página especificada do documento.

Quando o modo de pré-visualização é invocado pela primeira vez, o framework lê o valor desse membro para determinar qual a página do documento que deve ser pré-visualizada inicialmente. Pode definir o valor deste membro na sua sobreposição de CView::OnPreparePrinting para manter a posição atual do utilizador no documento ao entrar no modo de pré-visualização. O m_nCurPage membro é uma variável pública do tipo UINT.

CPrintInfo::m_nJobNumber

Indica o número do trabalho atribuído pelo sistema operativo para o trabalho de impressão atual.

Observações

Este valor pode ser SP_ERROR se o trabalho ainda não tiver sido impresso (isto é, se o CPrintInfo objeto for recém-construído e ainda não foi usado para imprimir), ou se houve um erro no início do trabalho.

CPrintInfo::m_nNumPreviewPages

Contém o número de páginas exibidas no modo de pré-visualização; Pode ser 1 ou 2.

Observações

O m_nNumPreviewPages membro é uma variável pública do tipo UINT.

CPrintInfo::m_nOffsetPage

Contém o número de páginas que precedem a primeira página de um determinado DocObject num trabalho combinado de impressão DocObject.

CPrintInfo::m_pPD

Contém um ponteiro para o CPrintDialog objeto usado para mostrar a caixa de diálogo Imprimir para o trabalho de impressão.

Observações

O m_pPD membro é uma variável pública declarada como um apontador para CPrintDialog.

CPrintInfo::m_rectDraw

Especifica a área de desenho utilizável da página em coordenadas lógicas.

Observações

Pode querer referir-se a isto na sua sobreposição de CView::OnPrint. Pode usar este membro para registar que área permanece utilizável depois de imprimir cabeçalhos, rodapés, e assim por diante. O m_rectDraw membro é uma variável pública do tipo CRect.

CPrintInfo::m_strPageDesc

Contém uma cadeia de formato usada para mostrar os números das páginas durante a pré-visualização de impressão; Esta cadeia consiste em duas substrings, uma para exibição de página única e outra para exibição de página dupla, cada uma terminada por um carácter '\n'.

Observações

O framework utiliza "Page %u\nPages %u-%u\n" como valor predefinido. Se quiser um formato diferente para os números de página, especifique uma string de formato no seu sobreposição de CView::OnPreparePrinting. O m_strPageDesc membro é uma variável pública do tipo CString.

CPrintInfo::SetMaxPage

Chame esta função para especificar o número da última página do documento.

void SetMaxPage(UINT nMaxPage);

Parâmetros

nMaxPage
Número da última página do documento.

Observações

Este valor é armazenado no CPrintDialog objeto referenciado pelo m_pPD membro. Se o comprimento do documento for conhecido antes de ser impresso, chame esta função a partir da sua sobreposição de CView::OnPreparePrinting. Se o comprimento do documento depender de uma definição especificada pelo utilizador na caixa de diálogo Imprimir, chame esta função a partir do seu sobrescrito de CView::OnBeginPrinting. Se o comprimento do documento não for conhecido até ser impresso, use o m_bContinuePrinting elemento para controlar o loop de impressão.

Example

Veja o exemplo do CView::OnPreparePrinting.

CPrintInfo::SetMinPage

Chame esta função para especificar o número da primeira página do documento.

void SetMinPage(UINT nMinPage);

Parâmetros

nMinPage
Número da primeira página do documento.

Observações

Os números das páginas normalmente começam em 1. Este valor é armazenado no CPrintDialog objeto referenciado pelo m_pPD membro.

Consulte também

DIBLOOK de Exemplo MFC
Gráfico de Hierarquia
CView::OnBeginPrinting
CView::OnEndPrinting
CView::OnEndPrintPreview
CView::OnPrepareDC
CView::OnPreparePrinting
CView::OnPrint