COleInsertDialog クラス

  • [アーティクル]

OLE の [オブジェクトの挿入] ダイアログ ボックスで使用されます。

構文

class COleInsertDialog : public COleDialog

メンバー

パブリック コンストラクター

名前 説明
COleInsertDialog::COleInsertDialog COleInsertDialog オブジェクトを構築します。

パブリック メソッド

名前 説明
COleInsertDialog::CreateItem ダイアログ ボックスで選択した項目を作成します。
COleInsertDialog::D oModal [OLE オブジェクトの挿入] ダイアログ ボックスを表示します。
COleInsertDialog::GetClassID 選択した項目に関連付けられている CLSID を取得します。
COleInsertDialog::GetDrawAspect 項目をアイコンとして描画するかどうかを示します。
COleInsertDialog::GetIconicMetafile このアイテムの象徴的な形式に関連付けられているメタファイルへのハンドルを取得します。
COleInsertDialog::GetPathName ダイアログ ボックスで選択したファイルへの完全なパスを取得します。
COleInsertDialog::GetSelectionType 選択したオブジェクトの種類を取得します。

パブリック データ メンバー

名前 説明
COleInsertDialog::m_io ダイアログ ボックスの動作を制御する OLEUIINSERTOBJECT 型の構造体。

解説

このダイアログ ボックスを呼び出すときに COleInsertDialog クラスのオブジェクトを作成します。 COleInsertDialog オブジェクトが作成されたら、m_io構造体を使用して、ダイアログ ボックス内のコントロールの値または状態を初期化できます。 m_io構造体は OLEUIINSERTOBJECT 型です。 このダイアログ クラスの使用方法の詳細については、 DoModal メンバー関数を参照してください。

Note

アプリケーション ウィザードによって生成されたコンテナー コードでは、このクラスが使用されます。

詳細については、Windows SDK の OLEUIINSERTOBJECT 構造体を参照してください。

OLE 固有のダイアログ ボックスの詳細については、「OLE のダイアログ ボックス」を参照してください。

継承階層

CObject

CCmdTarget

CWnd

CDialog

CCommonDialog

COleDialog

COleInsertDialog

要件

Header: afxodlgs.h

COleInsertDialog::COleInsertDialog

この関数は、 COleInsertDialog オブジェクトのみを構築します。

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

パラメーター

dwFlags
ビットごとの OR 演算子を使用して結合する次の値の任意の数を含む作成フラグ。

  • IOF_SHOWHELP ダイアログ ボックスが呼び出されたときに [ヘルプ] ボタンを表示することを指定します。

  • IOF_SELECTCREATENEW ダイアログ ボックスが呼び出されたときに[新規作成]オプション ボタンが最初に選択されることを指定します。 これは既定値であり、IOF_SELECTCREATEFROMFILEでは使用できません。

  • IOF_SELECTCREATEFROMFILE ダイアログ ボックスが呼び出されたときに[ファイルから作成]オプション ボタンが最初に選択されることを指定します。 IOF_SELECTCREATENEWでは使用できません。

  • IOF_CHECKLINK ダイアログ ボックスが呼び出されたときに、最初に [リンク] チェック ボックスをオンにすることを指定します。

  • IOF_DISABLELINK ダイアログ ボックスの呼び出し時に [リンク] チェック ボックスを無効にすることを指定します。

  • IOF_CHECKDISPLAYASICON最初に [アイコンとして表示] チェック ボックスがオンになり、現在のアイコンが表示され、ダイアログ ボックスが呼び出されたときに [アイコンの変更] ボタンが有効になります。

  • IOF_VERIFYSERVERSEXIST 登録データベースで指定されたサーバーがダイアログ ボックスを表示する前に存在することを確認することで、ダイアログ ボックスがリスト ボックスに追加するクラスを検証する必要があることを指定します。 このフラグを設定すると、パフォーマンスが大幅に低下する可能性があります。

pParentWnd
ダイアログ オブジェクトが属する親または所有者ウィンドウ オブジェクト ( CWnd 型) をポイントします。 NULL の場合、ダイアログ オブジェクトの親ウィンドウはメイン アプリケーション ウィンドウに設定されます。

解説

ダイアログ ボックスを表示するには、 DoModal 関数を呼び出します。

COleInsertDialog::CreateItem

この関数を呼び出して、COleClientItemdoModal が IDOK を返す場合にのみオブジェクトを作成します。

BOOL CreateItem(COleClientItem* pItem);

パラメーター

pItem
作成する項目をポイントします。

戻り値

項目が作成された場合は 0 以外。それ以外の場合は 0。

解説

この関数を呼び出す前に、 COleClientItem オブジェクトを割り当てる必要があります。

COleInsertDialog::D oModal

[OLE オブジェクトの挿入] ダイアログ ボックスを表示するには、この関数を呼び出します。

virtual INT_PTR
    DoModal();

INT_PTR
    DoModal(DWORD  dwFlags);

パラメーター

dwFlags
次のいずれかの値です。

COleInsertDialog::DocObjectsOnly は DocObject のみを挿入します。

COleInsertDialog::ControlsOnly は ActiveX コントロールのみを挿入します。

0 は DocObject コントロールも ActiveX コントロールも挿入しません。 この値は、上記の最初のプロトタイプと同じ実装になります。

戻り値

ダイアログ ボックスの完了状態。 次のいずれかの値です。

  • ダイアログ ボックスが正常に表示された場合は IDOK。

  • ユーザーがダイアログ ボックスをキャンセルした場合は IDCANCEL。

  • エラーが発生した場合は IDABORT。 IDABORT が返された場合は、 COleDialog::GetLastError メンバー関数を呼び出して、発生したエラーの種類に関する詳細情報を取得します。 考えられるエラーの一覧については、Windows SDK の OleUIInsertObject 関数を参照してください。

解説

m_io構造体のメンバーを設定して、さまざまなダイアログ ボックス コントロールを初期化する場合は、DoModalを呼び出す前に、ダイアログ オブジェクトが構築された後で、これを行う必要があります。

DoModalが IDOK を返す場合は、他のメンバー関数を呼び出して、ユーザーがダイアログ ボックスに入力した設定または情報を取得できます。

COleInsertDialog::GetClassID

この関数を呼び出して、選択した項目に関連付けられている CLSID を取得するのは、 DoModal が IDOK を返し、選択の種類が COleInsertDialog::createNewItem場合のみです。

REFCLSID GetClassID() const;

戻り値

選択した項目に関連付けられている CLSID を返します。

解説

詳細については、Windows SDK CLSID キー を参照してください。

COleInsertDialog::GetDrawAspect

この関数を呼び出して、ユーザーが選択した項目をアイコンとして表示することを選択したかどうかを判断します。

DVASPECT GetDrawAspect() const;

戻り値

オブジェクトをレンダリングするために必要なメソッド。

  • DVASPECT_CONTENTアイコンとして表示] チェック ボックスがオフの場合に返されます。

  • DVASPECT_ICONアイコンとして表示] チェック ボックスがオンになっている場合に返されます。

解説

この関数は、 DoModal が IDOK を返す場合にのみ呼び出します。

描画の側面の詳細については、Windows SDK FORMATETC データ構造に関するページを参照してください。

COleInsertDialog::GetIconicMetafile

選択した項目の象徴的な側面を含むメタファイルへのハンドルを取得するには、この関数を呼び出します。

HGLOBAL GetIconicMetafile() const;

戻り値

ダイアログが閉じられたときに [アイコンとして表示] チェック ボックスがオンになっている場合は、選択した項目のアイコンの側面を含むメタファイルのハンドル OK。それ以外の場合は NULL。

COleInsertDialog::GetPathName

この関数を呼び出して、選択したファイルの完全なパス DoModal が IDOK を返し、選択の種類が COleInsertDialog::createNewItemされていない場合にのみ取得します。

CString GetPathName() const;

戻り値

ダイアログ ボックスで選択したファイルへの完全パス。 選択の種類が createNewItem場合、この関数はリリース モードで意味のない CString を返すか、デバッグ モードでアサーションを発生させます。

COleInsertDialog::GetSelectionType

この関数を呼び出して、[オブジェクトの挿入] ダイアログ ボックスが閉じられたときに選択した選択の種類 OKを取得します。

UINT GetSelectionType() const;

戻り値

選択した項目の種類。

解説

戻り値は、COleInsertDialog クラスで宣言されたSelection列挙型によって指定されます。

enum Selection {
    createNewItem,
    insertFromFile,
    linkToFile
    };

これらの値の簡単な説明は次のとおりです。

  • COleInsertDialog::createNewItem [新規作成] ラジオ ボタンが選択されました。

  • COleInsertDialog::insertFromFile [ファイルから作成] ラジオ ボタンが選択され、[リンク] チェック ボックスがオフになっています。

  • COleInsertDialog::linkToFile [ファイルから作成] ラジオ ボタンが選択され、[リンク] チェック ボックスがオンになっています。

COleInsertDialog::m_io

[オブジェクトの挿入] ダイアログ ボックスの動作を制御するために使用される OLEUIINSERTOBJECT 型の構造体。

OLEUIINSERTOBJECT m_io;

解説

この構造体のメンバーは、直接またはメンバー関数を使用して変更できます。

詳細については、Windows SDK の OLEUIINSERTOBJECT 構造体を参照してください。

関連項目

MFC サンプル OCLIENT
COleDialog クラス
階層図
COleDialog クラス