COleConvertDialog クラス

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

構文

class COleConvertDialog : public COleDialog

メンバー

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

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

パブリック メソッド

名前 説明
COleConvertDialog::D oConvert ダイアログ ボックスで指定された変換を実行します。
COleConvertDialog::D oModal [OLE アイテムの変更] ダイアログ ボックスを表示します。
COleConvertDialog::GetClassID 選択した項目に関連付けられている CLSID を取得します。
COleConvertDialog::GetDrawAspect 項目をアイコンとして描画するかどうかを指定します。
COleConvertDialog::GetIconicMetafile このアイテムの象徴的な形式に関連付けられているメタファイルへのハンドルを取得します。
COleConvertDialog::GetSelectionType 選択した選択の種類を取得します。

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

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

解説

Note

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

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

継承階層

CObject

CCmdTarget

CWnd

CDialog

CCommonDialog

COleDialog

COleConvertDialog

要件

Header: afxodlgs.h

COleConvertDialog::COleConvertDialog

COleConvertDialog オブジェクトのみを構築します。

explicit COleConvertDialog (
    COleClientItem* pItem,
    DWORD dwFlags = CF_SELECTCONVERTTO,
    CLSID* pClassID = NULL,
    CWnd* pParentWnd = NULL);

パラメーター

pItem
変換またはアクティブ化する項目をポイントします。

dwFlags
作成フラグ。ビットごとの演算子または演算子を使用して組み合わせた次の値の任意の数が含まれます。

  • CF_SELECTCONVERTTO ダイアログ ボックスが呼び出されたときに[変換]オプション ボタンが最初に選択されることを指定します。 これが既定です。

  • CF_SELECTACTIVATEAS ダイアログ ボックスが呼び出されたときに[アクティブ化]オプション ボタンが最初に選択されることを指定します。

  • CF_SETCONVERTDEFAULT m_cv構造体のclsidConvertDefault メンバーによって CLSID が指定されたクラスが、[変換] ラジオ ボタンが選択されている場合に、クラス リスト ボックスの既定の選択として使用されることを指定します。

  • CF_SETACTIVATEDEFAULT m_cv 構造体のclsidActivateDefault メンバーによって CLSID が指定されたクラスが、[アクティブ化] ラジオ ボタンが選択されている場合に、クラス リスト ボックスの既定の選択として使用されることを指定します。

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

pClassID
変換またはアクティブ化する項目の CLSID を指します。 NULL の場合、 pItem に関連付けられている CLSID が使用されます。

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

解説

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

詳細については、 CLSID Key および OLEUICONVERT 構造体を参照してください。

COleConvertDialog::D oConvert

DoModal から正常に戻った後、この関数を呼び出して、COleClientItem 型のオブジェクトを変換またはアクティブ化します。

BOOL DoConvert(COleClientItem* pItem);

パラメーター

pItem
変換またはアクティブ化する項目をポイントします。 Nll は指定できません。

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

アイテムは、[変換] ダイアログ ボックスでユーザーが選択した情報に従って変換またはアクティブ化されます。

COleConvertDialog::D oModal

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

virtual INT_PTR DoModal();

戻り値

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

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

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

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

解説

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

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

COleConvertDialog::GetClassID

この関数を呼び出して、[変換] ダイアログ ボックスでユーザーが選択した項目に関連付けられている CLSID を取得します。

REFCLSID GetClassID() const;

戻り値

[変換] ダイアログ ボックスで選択した項目に関連付けられている CLSID。

解説

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

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

COleConvertDialog::GetDrawAspect

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

DVASPECT GetDrawAspect() const;

戻り値

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

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

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

解説

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

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

COleConvertDialog::GetIconicMetafile

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

HGLOBAL GetIconicMetafile() const;

戻り値

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

COleConvertDialog::GetSelectionType

この関数を呼び出して、[変換] ダイアログ ボックスで選択した変換の種類を決定します。

UINT GetSelectionType() const;

戻り値

選択した項目の種類。

解説

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

enum Selection {
    noConversion,
    convertItem,
    activateAs
    };

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

  • COleConvertDialog::noConversion ダイアログ ボックスが取り消されたか、ユーザーが変換を選択しなかった場合に返されます。 IDOK COleConvertDialog::DoModal 返された場合、ユーザーが以前に選択したアイコンとは異なるアイコンを選択した可能性があります。

  • COleConvertDialog::convertItem [変換] オプション ボタンがオンになっている場合に返され、ユーザーが変換する別の項目を選択し、IDOK を返 DoModal

  • COleConvertDialog::activateAs [アクティブ化] ラジオ ボタンがオンになっている場合に返され、ユーザーがアクティブ化する別の項目を選択し、IDOK DoModal 返されます。

COleConvertDialog::m_cv

[変換] ダイアログ ボックスの動作を制御するために使用される OLEUICONVERT 型の構造体。

OLEUICONVERT m_cv;

解説

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

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

関連項目

COleDialog クラス
階層図
COleDialog クラス