COleChangeSourceDialog クラス

OLE の [ソースの変更] ダイアログ ボックスに使用します。

構文

class COleChangeSourceDialog : public COleDialog

メンバー

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

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

パブリック メソッド

名前	説明
COleChangeSourceDialog::D oModal	[OLE ソースの変更] ダイアログ ボックスを表示します。
COleChangeSourceDialog::GetDisplayName	完全なソース表示名を取得します。
COleChangeSourceDialog::GetFileName	ソース名からファイル名を取得します。
COleChangeSourceDialog::GetFromPrefix	前のソースのプレフィックスを取得します。
COleChangeSourceDialog::GetItemName	ソース名から項目名を取得します。
COleChangeSourceDialog::GetToPrefix	新しいソースのプレフィックスを取得します。
COleChangeSourceDialog::IsValidSource	ソースが有効かどうかを示します。

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

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

解説

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

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

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

継承階層

CObject

CCmdTarget

CWnd

Cdialog

CCommonDialog

COleDialog

COleChangeSourceDialog

必要条件

ヘッダー: afxodlgs.h

COleChangeSourceDialog::COleChangeSourceDialog

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

explicit COleChangeSourceDialog(
    COleClientItem* pItem,
    CWnd* pParentWnd = NULL);

パラメーター

pItem
ソースが更新されるリンクされた COleClientItem へのポインター。

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

解説

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

詳細については、Windows SDK の OLEUICHANGESOURCE 構造体と OleUIChangeSource 関数を参照してください。

COleChangeSourceDialog::D oModal

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

virtual INT_PTR DoModal();

戻り値

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

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

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

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

解説

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

IDOK が返された場合 DoModal は、メンバー関数を呼び出して、ダイアログ ボックスからユーザーが入力した設定または情報を取得できます。 次の一覧では、一般的なクエリ関数の名前を指定します。

• GetFileName

• GetDisplayName

• GetItemName

COleChangeSourceDialog::GetDisplayName

この関数を呼び出して、リンクされたクライアント項目の完全な表示名を取得します。

CString GetDisplayName();

戻り値

コンストラクターで指定された COleClientItem の完全なソース表示名 (モニカー)。

COleChangeSourceDialog::GetFileName

この関数を呼び出して、リンクされたクライアント項目の表示名のファイル モニカー部分を取得します。

CString GetFileName();

戻り値

コンストラクターで指定された COleClientItem のソース表示名のファイル モニカー部分。

解説

ファイル モニカーとアイテム モニカーは、完全な表示名を提供します。

COleChangeSourceDialog::GetFromPrefix

ソースの前のプレフィックス文字列を取得するには、この関数を呼び出します。

CString GetFromPrefix();

戻り値

ソースの前のプレフィックス文字列。

解説

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

この値は、 lpszFrom OLEUICHANGESOURCE 構造体の メンバーから直接取得されます 。

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

COleChangeSourceDialog::GetItemName

この関数を呼び出して、リンクされたクライアント アイテムの表示名のアイテム モニカー部分を取得します。

CString GetItemName();

戻り値

コンストラクターで指定された COleClientItem のソース表示名の項目モニカー部分。

解説

ファイル モニカーとアイテム モニカーは、完全な表示名を提供します。

COleChangeSourceDialog::GetToPrefix

この関数を呼び出して、ソースの新しいプレフィックス文字列を取得します。

CString GetToPrefix();

戻り値

ソースの新しいプレフィックス文字列。

解説

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

この値は、 lpszTo OLEUICHANGESOURCE 構造体の メンバーから直接取得されます 。

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

COleChangeSourceDialog::m_cs

このデータ メンバーは OLEUICHANGESOURCE 型 の構造体です。

OLEUICHANGESOURCE m_cs;

解説

OLEUICHANGESOURCE は、[OLE ソースの変更] ダイアログ ボックスの動作を制御するために使用します。 この構造体のメンバーは直接変更できます。

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

COleChangeSourceDialog::IsValidSource

この関数を呼び出して、新しいソースが有効かどうかを判断します。

BOOL IsValidSource();

戻り値

新しいソースが有効な場合は 0 以外、それ以外の場合は 0。

解説

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

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

関連項目

COleDialog クラス
階層図
COleDialog クラス