Classe COleInsertDialog

Usado para a caixa de diálogo Inserir Objeto OLE.

Sintaxe

class COleInsertDialog : public COleDialog

Membros

Construtores públicos

Métodos públicos

Membros de Dados Públicos

Comentários

Crie um objeto da classe COleInsertDialog quando quiser chamar essa caixa de diálogo. Depois que um objeto COleInsertDialog for construído, você poderá usar a estrutura m_io para inicializar os valores ou estados dos controles na caixa de diálogo. A estrutura m_io é do tipo OLEUIINSERTOBJECT. Para mais informações sobre como usar essa classe de diálogo, confira a função membro DoModal.

Para mais informações, confira a estrutura OLEUIINSERTOBJECT no SDK do Windows.

Para mais informações sobre caixas de diálogo específicas do OLE, confira o artigo Caixas de diálogo no OLE.

Hierarquia de herança

CObject

CCmdTarget

CWnd

CDialog

CCommonDialog

COleDialog

COleInsertDialog

Requisitos

Cabeçalho: afxodlgs.h

COleInsertDialog::COleInsertDialog

Essa função constrói apenas um objeto COleInsertDialog.

COleInsertDialog (
    DWORD dwFlags = IOF_SELECTCREATENEW,
    CWnd* pParentWnd = NULL);

Parâmetros

dwFlags
O sinalizador de criação que contém qualquer número dos seguintes valores a serem combinados usando o operador bit a bit OR:

• IOF_SHOWHELP Especifica que o botão Ajuda será exibido quando a caixa de diálogo for chamada.

• IOF_SELECTCREATENEW Especifica que o botão de opção Criar Novo será selecionado inicialmente quando a caixa de diálogo for chamada. Esse é o padrão e não pode ser usado com IOF_SELECTCREATEFROMFILE.

• IOF_SELECTCREATEFROMFILE Especifica que o botão de opção Criar do Arquivo será selecionado inicialmente quando a caixa de diálogo for chamada. Não pode ser usado com IOF_SELECTCREATENEW.

• IOF_CHECKLINK Especifica que a caixa de seleção Link será marcada inicialmente quando a caixa de diálogo for chamada.

• IOF_DISABLELINK Especifica que a caixa de seleção Link será desabilitada quando a caixa de diálogo for chamada.

• IOF_CHECKDISPLAYASICON Especifica que a caixa de seleção Exibir como Ícone será marcada inicialmente, o ícone atual será exibido e o botão Alterar Ícone será habilitado quando a caixa de diálogo for chamada.

• IOF_VERIFYSERVERSEXIST Especifica que a caixa de diálogo deve validar as classes que ela adiciona à caixa de listagem, garantindo que os servidores especificados no banco de dados de registro existam antes que a caixa de diálogo seja exibida. Definir esse sinalizador pode prejudicar significativamente o desempenho.

pParentWnd
Aponta para o objeto de janela pai ou proprietário (do tipo CWnd) ao qual o objeto de caixa de diálogo pertence. Se for NULL, a janela pai do objeto de caixa de diálogo será definida como a janela principal do aplicativo.

Comentários

Para exibir a caixa de diálogo, chame a função DoModal.

COleInsertDialog::CreateItem

Chame essa função para criar um objeto do tipo COleClientItem somente se DoModal retornar IDOK.

BOOL CreateItem(COleClientItem* pItem);

Parâmetros

pItem
Aponta para o item a ser criado.

Valor de retorno

Diferente de zero se o item foi criado; caso contrário, 0.

Comentários

Você deve alocar o objeto COleClientItem antes de poder chamar essa função.

COleInsertDialog::DoModal

Chame essa função para exibir a caixa de diálogo OLE Inserir Objeto.

virtual INT_PTR
    DoModal();

INT_PTR
    DoModal(DWORD  dwFlags);

Parâmetros

dwFlags
Um dos seguintes valores:

COleInsertDialog::DocObjectsOnly insere apenas DocObjects.

COleInsertDialog::ControlsOnly insere apenas controles ActiveX.

Zero não insere nem um DocObject nem um controle ActiveX. Esse valor resulta na mesma implementação que o primeiro protótipo listado acima.

Valor de retorno

Status de conclusão da caixa de diálogo. Um dos seguintes valores:

• IDOK se a caixa de diálogo foi exibida com êxito.

• IDCANCEL se o usuário cancelou a caixa de diálogo.

• IDABORT se ocorreu um erro. Se IDABORT for retornado, chame a função membro COleDialog::GetLastError para obter mais informações sobre o tipo de erro que ocorreu. Para uma lista de possíveis erros, confira a função OleUIInsertObject no SDK do Windows.

Comentários

Se você quiser inicializar os vários controles da caixa de diálogo definindo membros da estrutura m_io, faça isso antes de chamar DoModal, mas depois que o objeto de caixa de diálogo for construído.

Se retornar DoModal, você poderá chamar outras funções membro para recuperar as configurações ou a entrada de informações do usuário na caixa de diálogo.

COleInsertDialog::GetClassID

Chame essa função para obter o CLSID associado ao item selecionado somente se DoModal retornar IDOK e o tipo de seleção for COleInsertDialog::createNewItem.

REFCLSID GetClassID() const;

Valor de retorno

Retorna o CLSID associado ao item selecionado.

Comentários

Para mais informações, confira Chave CLSID no SDK do Windows.

COleInsertDialog::GetDrawAspect

Chame essa função para determinar se o usuário optou por exibir o item selecionado como um ícone.

DVASPECT GetDrawAspect() const;

Valor de retorno

O método necessário para renderizar o objeto.

• DVASPECT_CONTENT Retornado se a caixa de seleção Exibir como Ícone não tiver sido marcada.

• DVASPECT_ICON Retornado se a caixa de seleção Exibir como Ícone foi marcada.

Comentários

Chame essa função somente se DoModal retornar IDOK.

Para obter mais informações sobre o aspecto do desenho, confira a estrutura de dados FORMATETC no SDK do Windows.

COleInsertDialog::GetIconicMetafile

Chame essa função para obter um identificador para o metarquivo que contém o aspecto icônico do item selecionado.

HGLOBAL GetIconicMetafile() const;

Valor de retorno

O identificador para o metarquivo que contém o aspecto icônico do item selecionado se a caixa de seleção Exibir como Ícone foi marcada quando a caixa de diálogo foi ignorada ao escolher OK; caso contrário, NULL.

COleInsertDialog::GetPathName

Chame essa função para obter o caminho completo do arquivo selecionado somente se DoModal retornar IDOK e o tipo de seleção não for COleInsertDialog::createNewItem.

CString GetPathName() const;

Valor de retorno

O caminho completo para o arquivo selecionado na caixa de diálogo. Se o tipo de seleção for createNewItem, essa função retornará um valor sem sentido CString no modo de liberação ou causará uma declaração no modo de depuração.

COleInsertDialog::GetSelectionType

Chame essa função para obter o tipo de seleção escolhido quando a caixa de diálogo Inserir Objeto for descartada escolhendo OK.

UINT GetSelectionType() const;

Valor de retorno

Tipo de seleção feita.

Comentários

Os valores de tipo retornado são especificados pelo tipo de enumeração Selection declarado na classe COleInsertDialog.

enum Selection {
    createNewItem,
    insertFromFile,
    linkToFile
    };

Breves descrições desses valores estão a seguir:

• COleInsertDialog::createNewItem O botão de opção Criar Novo foi selecionado.

• COleInsertDialog::insertFromFile O botão de opção Criar do Arquivo foi selecionado e a caixa de seleção Link não foi marcada.

• COleInsertDialog::linkToFile O botão de opção Criar do Arquivo foi selecionado e a caixa de seleção Link foi marcada.

COleInsertDialog::m_io

Estrutura do tipo OLEUIINSERTOBJECT usado para controlar o comportamento da caixa de diálogo Inserir Objeto.

OLEUIINSERTOBJECT m_io;

Comentários

Os membros dessa estrutura podem ser modificados diretamente ou por meio de funções de membro.

Para mais informações, confira a estrutura OLEUIINSERTOBJECT no SDK do Windows.

Confira também

OCLIENT de exemplo do MFC
Classe COleDialog
Gráfico da hierarquia
Classe COleDialog