Partilhar via

Classe COleDocObjectItem

  • Artigo

Implementa independência de documento Active.

Sintaxe

class COleDocObjectItem : public COleClientItem

Membros

Construtores públicos

Nome Descrição
COleDocObjectItem::COleDocObjectItem Constrói um novo item COleDocObject.

Métodos públicos

Nome Descrição
COleDocObjectItem::DoDefaultPrinting Imprime o documento do aplicativo de contêiner usando as configurações padrão da impressora.
COleDocObjectItem::ExecCommand Executa o comando especificado pelo usuário.
COleDocObjectItem::GetActiveView Recupera o modo de exibição ativo do documento.
COleDocObjectItem::GetPageCount Recupera o número de páginas no documento do aplicativo de contêiner.
COleDocObjectItem::OnPreparePrinting Prepara o documento do aplicativo de contêiner para impressão.
COleDocObjectItem::OnPrint Imprime o documento do aplicativo de contêiner.
COleDocObjectItem::QueryCommand Consulta o status de um ou mais comandos gerados pelos eventos da interface do usuário.
COleDocObjectItem::Release Libera a conexão com um item vinculado OLE e fecha-a se ela estava aberta. Não destrói o item do cliente.

Comentários

No MFC, um documento Active é tratado de forma semelhante a uma inserção editável regular no local, com as seguintes diferenças:

  • A classe derivada de COleDocument ainda mantém uma lista dos itens inseridos no momento; no entanto, esses itens podem ser itens derivados de COleDocObjectItem.

  • Quando um documento Active está ativo, ele ocupa toda a área de cliente do modo de exibição quando está ativo no local.

  • Um contêiner de documentos Active tem controle total do menu de Ajuda.

  • O menu de Ajuda contém itens de menu para o contêiner de documentos Active e o servidor.

Como o contêiner de documentos Active possui a propriedade do menu de Ajuda, o contêiner é responsável por encaminhar mensagens do menu de Ajuda do servidor para o servidor. Essa integração é tratada por COleDocObjectItem.

Para obter mais informações sobre a mesclagem de menus e a ativação de documentos Active, consulte a visão geral da Independência de documentos Active.

Hierarquia de herança

CObject

CCmdTarget

CDocItem

COleClientItem

COleDocObjectItem

Requisitos

Cabeçalho: afxole.h

COleDocObjectItem::COleDocObjectItem

Chame essa função membro para inicializar o objeto COleDocObjectItem.

COleDocObjectItem(COleDocument* pContainerDoc = NULL);

Parâmetros

pContainerDoc
Um ponteiro para o objeto COleDocument que atua como o contêiner do documento ativo. Esse parâmetro deve ser NULL para habilitar IMPLEMENT_SERIALIZE. Normalmente, os itens OLE são construídos com um ponteiro de documento não NULL.

COleDocObjectItem::DoDefaultPrinting

Chamado pela estrutura para um documento usando as configurações padrão.

static HRESULT DoDefaultPrinting(
    CView* pCaller,
    CPrintInfo* pInfo);

Parâmetros

pCaller
Um ponteiro para um objeto CView que está enviando o comando de impressão.

pInfo
Um ponteiro para um objeto CPrintInfo que descreve o trabalho a ser impresso.

COleDocObjectItem::ExecCommand

Chame essa função membro para executar o comando especificado pelo usuário.

HRESULT ExecCommand(
    DWORD nCmdID,
    DWORD nCmdExecOpt = OLECMDEXECOPT_DONTPROMPTUSER,
    const GUID* pguidCmdGroup = NULL);

Parâmetros

nCmdID
O identificador do comando a ser executado. Deve estar no grupo identificado por pguidCmdGroup.

nCmdExecOpt
Especifica opções de execução de comando. Por padrão, defina para executar o comando sem solicitar ao usuário. Confira OLECMDEXECOPT para obter uma lista de valores.

pguidCmdGroup
Identificador exclusivo do grupo de comando. Por padrão, NULL, que especifica o grupo padrão. O comando passado em nCmdID deve pertencer ao grupo.

Valor de retorno

Retorna S_OK se tiver êxito; caso contrário, retorna um dos seguintes códigos de erro.

Valor Descrição
E_UNEXPECTED Ocorreu um erro inesperado.
E_FAIL ocorreu um erro.
E_NOTIMPL Indica que o próprio MFC deve tentar traduzir e expedir o comando.
OLECMDERR_E_UNKNOWNGROUP O pguidCmdGroup não é NULL, mas não especifica um grupo de comandos reconhecido.
OLECMDERR_E_NOTSUPPORTED O nCmdID não é reconhecido como um comando válido no grupo pGroup.
OLECMDERR_DISABLED O comando identificado por nCmdID está desabilitado e não pode ser executado.
OLECMDERR_NOHELP O chamador pediu ajuda no comando identificado por nCmdID, mas nenhuma ajuda está disponível.
OLECMDERR_CANCELLED O usuário cancelou a execução.

Comentários

Os parâmetros pguidCmdGroup e nCmdID juntos identificam exclusivamente o comando a ser invocado. O parâmetro nCmdExecOpt especifica a ação exata a ser tomada.

COleDocObjectItem::GetActiveView

Chame essa função membro para obter um ponteiro para a interface IOleDocumentView do modo de exibição ativo no momento.

LPOLEDOCUMENTVIEW GetActiveView() const;

Valor de retorno

Um ponteiro para a interface IOleDocumentView do modo de exibição ativo no momento. Se não houver nenhum modo de exibição atual, ele retornará NULL.

Comentários

A contagem de referências no ponteiro IOleDocumentView retornado não é incrementada antes de ser retornada por essa função.

COleDocObjectItem::GetPageCount

Chame essa função membro para recuperar o número de páginas no documento.

BOOL GetPageCount(
    LPLONG pnFirstPage,
    LPLONG pcPages);

Parâmetros

pnFirstPage
Um ponteiro para o número da primeira página do documento. Pode ser NULL, o que indica que o chamador não precisa desse número.

pcPages
Um ponteiro para o número total de páginas no documento. Pode ser NULL, o que indica que o chamador não precisa desse número.

Valor de retorno

Diferente de zero se tiver êxito; caso contrário, 0.

COleDocObjectItem::OnPreparePrinting

Essa função membro é chamada pela estrutura para preparar um documento para impressão.

static BOOL OnPreparePrinting(
    CView* pCaller,
    CPrintInfo* pInfo,
    BOOL bPrintAll = TRUE);

Parâmetros

pCaller
Um ponteiro para um objeto CView que está enviando o comando de impressão.

pInfo
Um ponteiro para um objeto CPrintInfo que descreve o trabalho a ser impresso.

bPrintAll
Especifica se o documento inteiro deve ser impresso.

Valor de retorno

Diferente de zero se tiver êxito; caso contrário, 0.

COleDocObjectItem::OnPrint

Essa função membro é chamada pela estrutura para imprimir um documento.

static void OnPrint(
    CView* pCaller,
    CPrintInfo* pInfo,
    BOOL bPrintAll = TRUE);

Parâmetros

pCaller
Um ponteiro para um objeto CView que está enviando o comando de impressão.

pInfo
Um ponteiro para um objeto CPrintInfo que descreve o trabalho a ser impresso.

bPrintAll
Especifica se o documento inteiro deve ser impresso.

COleDocObjectItem::QueryCommand

Consulta o status de um ou mais comandos gerados pelos eventos da interface do usuário.

HRESULT QueryCommand(
    ULONG nCmdID,
    DWORD* pdwStatus,
    OLECMDTEXT* pCmdText =NULL,
    const GUID* pguidCmdGroup =NULL);

Parâmetros

nCmdID
Identificador do comando que está sendo consultado.

pdwStatus
Um ponteiro para os sinalizadores retornado como resultado da consulta. Para obter uma lista de valores possíveis, consulte OLECMDF.

pCmdText
Ponteiro para uma estrutura OLECMDTEXT na qual retornar as informações de nome e status para um único comando. Pode ser NULL para indicar que o chamador não precisa dessas informações.

pguidCmdGroup
Identificador exclusivo do grupo de comandos; pode ser NULL para especificar o grupo padrão.

Valor de retorno

Para obter uma listagem completa de valores retornados, consulte IOleCommandTarget::QueryStatus no SDK do Windows.

Comentários

Essa função membro emula a funcionalidade do método IOleCommandTarget::QueryStatus, conforme descrito no SDK do Windows.

COleDocObjectItem::Release

Libera a conexão com um item vinculado OLE e fecha-a se ela estava aberta. Não destrói o item do cliente.

virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);

Parâmetros

dwCloseOption
Sinalizador especificando em quais circunstâncias o item OLE é salvo quando ele retorna ao estado carregado. Para obter uma lista de valores possíveis, confira COleClientItem::Close.

Comentários

Não destrói o item do cliente.

Confira também

MFCBIND de exemplo do MFC
Classe COleClientItem
Gráfico da hierarquia
Classe COleClientItem
Classe de CDocObjectServerItem