Partilhar via

Classe COleDocObjectItem

Observação

A biblioteca Microsoft Foundation Classes (MFC) continua a ser suportada. No entanto, já não estamos a adicionar funcionalidades nem a atualizar a documentação.

Implementa a contenção ativa de documentos.

Sintaxe

class COleDocObjectItem : public COleClientItem

Membros

Construtores Públicos

Nome Description
COleDocObjecto::COleDocObjectoItem Constrói um COleDocObject item.

Métodos Públicos

Nome Description
COleDocObjectItem::D oDefaultPrinting Imprime o documento da aplicação do contentor usando as definições padrão da impressora.
COleDocObjectItem::ExecCommand Executa o comando especificado pelo utilizador.
COleDocObjectItem::GetActiveView Recupera a vista ativa do documento.
COleDocObjectItem::GetPageCount Recupera o número de páginas no documento da aplicação contentor.
ColeDocObjectItem::OnPreparePrinting Prepara o documento da aplicação do contentor para impressão.
COleDocObjectItem::OnPrint Imprime o documento da aplicação do contentor.
COleDocObjectItem::QueryCommand Consultas para o estado de um ou mais comandos gerados por eventos da interface do utilizador.
COleDocObjectItem::Release Liberta a ligação a um item ligado OLE e fecha-o se estivesse aberto. Não destrói o item do cliente.

Observações

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

  • A COleDocumentclasse derivada em mantém ainda uma lista dos itens atualmente incorporados; no entanto, estes itens podem ser COleDocObjectItemitens derivados em .

  • Quando um documento ativo está ativo, ocupa toda a área do cliente da vista quando está ativo no local.

  • Um contentor de documentos Ativo tem controlo total sobre o menu de Ajuda .

  • O menu de Ajuda contém itens do menu tanto para o contentor de documentos Ativos como para o servidor.

Como o contentor do documento Ativo é proprietário do menu de Ajuda , o contentor é responsável por encaminhar as mensagens do menu de Ajuda do servidor para o servidor. Esta integração é gerida por COleDocObjectItem.

Para mais informações sobre fusão de menus e ativação ativa de documentos, consulte Visão Geral da Contenção Ativa de Documentos.

Hierarquia de herança

CObject

CCmdTarget

CDocItem

COleClienteItem

COleDocObjectItem

Requerimentos

Cabeçalho: afxole.h

COleDocObjecto::COleDocObjectoItem

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

COleDocObjectItem(COleDocument* pContainerDoc = NULL);

Parâmetros

pContainerDoc
Um apontador para o COleDocument objeto que atua como o contentor ativo do documento. Este parâmetro deve ser NULL para permitir IMPLEMENT_SERIALIZE. Normalmente, os itens OLE são construídos com um ponteiro de documento não NULL.

COleDocObjectItem::D oDefaultPrinting

Chamado pelo framework para um documento usando as definições padrão.

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

Parâmetros

PCaller
Um apontador para um objeto CView que está a enviar o comando print.

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

COleDocObjectItem::ExecCommand

Chame esta função membro para executar o comando especificado pelo utilizador.

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

Parâmetros

nCmdID
O identificador do comando a executar. Deve estar no grupo identificado pelo pguidCmdGroup.

nCmdExecOpt
Especifica opções de execução de comandos. Por defeito, define para executar o comando sem pedir ao utilizador. Consulte OLECMDEXECOPT para uma lista de valores.

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

Valor de retorno

Retorna S_OK se for bem-sucedido; caso contrário, devolve um dos seguintes códigos de erro.

Valor Description
E_UNEXPECTED Ocorreu um erro inesperado.
E_FAIL Ocorreu um erro.
E_NOTIMPL Indica que o próprio MFC deve tentar traduzir e despachar o comando.
OLECMDERR_E_UNKNOWNGROUP 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 pelo nCmdID está desativado e não pode ser executado.
OLECMDERR_NOHELP O chamador pediu ajuda no comando identificado pelo nCmdID , mas não há ajuda disponível.
OLECMDERR_CANCELLED O utilizador cancelou a execução.

Observações

Os parâmetros pguidCmdGroup e nCmdID identificam juntos de forma única o comando a invocar. O parâmetro nCmdExecOpt especifica a ação exata a tomar.

COleDocObjectItem::GetActiveView

Chame esta função membro para obter um ponteiro para a IOleDocumentView interface da vista atualmente ativa.

LPOLEDOCUMENTVIEW GetActiveView() const;

Valor de retorno

Um ponteiro para a interface IOleDocumentView da vista atualmente ativa. Se não houver uma visualização atual, devolve NULL.

Observações

A contagem de referência no ponteiro devolvido IOleDocumentView não é incrementada antes de ser devolvida por esta função.

COleDocObjectItem::GetPageCount

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

BOOL GetPageCount(
    LPLONG pnFirstPage,
    LPLONG pcPages);

Parâmetros

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

pcPages
Um indicador para o número total de páginas do documento. Pode ser NULL, o que indica que o chamador não precisa deste número.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

ColeDocObjectItem::OnPreparePrinting

Esta função de membro é chamada pelo framework para preparar um documento para impressão.

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

Parâmetros

PCaller
Um apontador para um objeto CView que está a enviar o comando print.

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

bPrintAll
Especifica se o documento completo deve ser impresso.

Valor de retorno

Não nulo se for bem-sucedido; caso contrário, 0.

COleDocObjectItem::OnPrint

Esta função membro é chamada pelo framework para imprimir um documento.

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

Parâmetros

PCaller
Um apontador para um objeto CView que está a enviar o comando print.

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

bPrintAll
Especifica se o documento completo deve ser impresso.

COleDocObjectItem::QueryCommand

Consultas para o estado de um ou mais comandos gerados por eventos da interface do utilizador.

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

Parâmetros

nCmdID
identificador do comando que está a ser consultado.

pdwStatus
Um apontador para as bandeiras era devolvido como resultado da consulta. Para uma lista de valores possíveis, veja OLECMDF.

pCmdText
Apontador para uma estrutura OLECMDTEXT na qual devolver informações de nome e estado para um único comando. Pode ser NULL para indicar que o chamador não precisa desta informação.

pguidCmdGroup
Identificador único do grupo de comando; pode ser NULL para especificar o grupo padrão.

Valor de retorno

Para uma lista completa dos valores de retorno, veja IOleCommandTarget::QueryStatus no SDK do Windows.

Observações

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

COleDocObjectItem::Release

Liberta a ligação a um item ligado OLE e fecha-o se estivesse aberto. Não destrói o item do cliente.

virtual void Release(OLECLOSE dwCloseOption = OLECLOSE_NOSAVE);

Parâmetros

dwCloseOption
Flag que especifica em que circunstâncias o item OLE é guardado quando regressa ao estado carregado. Para uma lista de valores possíveis, veja COleClientItem::Close.

Observações

Não destrói o item do cliente.

Consulte também

Exemplo MFC MFCBIND
COleClientItem Classe
Gráfico de Hierarquia
COleClientItem Classe
Classe CDocObjectServerItem

  • Last updated on