COleChangeSourceDialog 类
用于 OLE“更改源”对话框。
语法
class COleChangeSourceDialog : public COleDialog
成员
公共构造函数
名称 | 描述 |
---|---|
COleChangeSourceDialog::COleChangeSourceDialog | 构造 COleChangeSourceDialog 对象。 |
公共方法
名称 | 描述 |
---|---|
COleChangeSourceDialog::DoModal | 显示 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 中的对话框。
继承层次结构
COleChangeSourceDialog
要求
标头:afxodlgs.h
COleChangeSourceDialog::COleChangeSourceDialog
此函数构造一个 COleChangeSourceDialog
对象。
explicit COleChangeSourceDialog(
COleClientItem* pItem,
CWnd* pParentWnd = NULL);
参数
pItem
指向要更新其源的链接 COleClientItem 的指针。
pParentWnd
指向对话框对象所属的父窗口对象或所有者窗口对象(CWnd
类型)。 如果为 NULL,对话框的父窗口将设置为主应用程序窗口。
备注
要显示对话框,请调用 DoModal 函数。
有关详细信息,请参阅 Windows SDK 中的 OLEUICHANGESOURCE 结构和 OleUIChangeSource 函数。
COleChangeSourceDialog::DoModal
调用此函数以显示 OLE“更改源”对话框。
virtual INT_PTR DoModal();
返回值
对话框的完成状态。 以下值之一:
如果对话框成功显示,为 IDOK。
如果用户取消了对话框,为 IDCANCEL。
如果发生错误,为 IDABORT。 如果返回 IDABORT,请调用 COleDialog::GetLastError 成员函数以获取有关所发生错误类型的详细信息。 有关可能的错误列表,请参阅 Windows SDK 中的 OleUIChangeSource 函数。
注解
如果要通过设置 m_cs 结构的成员来初始化各种对话框控件,则应在调用 DoModal
之前但在构造对话框对象之后执行此操作。
如果 DoModal
返回 IDOK,可以调用成员函数从对话框中检索用户输入的设置或信息。 以下列表列出了典型的查询函数:
COleChangeSourceDialog::GetDisplayName
调用此函数以检索链接的客户端项的完整显示名称。
CString GetDisplayName();
返回值
构造函数中指定的 COleClientItem 的完整源显示名称(名字对象)。
COleChangeSourceDialog::GetFileName
调用此函数以检索链接客户端项的显示名称的文件名字对象部分。
CString GetFileName();
返回值
构造函数中指定的 COleClientItem 的源显示名称的文件名字对象部分。
注解
文件名字对象与项名字对象一起提供完整的显示名称。
COleChangeSourceDialog::GetFromPrefix
调用此函数以获取源的上一个前缀字符串。
CString GetFromPrefix();
返回值
源的上一个前缀字符串。
备注
仅在 DoModal 返回 IDOK 后调用此函数。
此值直接来自 OLEUICHANGESOURCE 结构的 lpszFrom
成员。
有关详细信息,请参阅 Windows SDK 中的 OLEUICHANGESOURCE 结构。
COleChangeSourceDialog::GetItemName
调用此函数以检索链接的客户端项的显示名称的项目名字对象部分。
CString GetItemName();
返回值
构造函数中指定的 COleClientItem 的源显示名称的项目名字对象部分。
注解
文件名字对象与项名字对象一起提供完整的显示名称。
COleChangeSourceDialog::GetToPrefix
调用此函数以获取源的新前缀字符串。
CString GetToPrefix();
返回值
源的新前缀字符串。
备注
仅在 DoModal 返回 IDOK 后调用此函数。
此值直接来自 OLEUICHANGESOURCE 结构的 lpszTo
成员。
有关详细信息,请参阅 Windows SDK 中的 OLEUICHANGESOURCE 结构。
COleChangeSourceDialog::m_cs
此数据成员是 OLEUICHANGESOURCE 类型的结构。
OLEUICHANGESOURCE m_cs;
备注
OLEUICHANGESOURCE
用于控制 OLE“更改源”对话框的行为。 可直接修改此结构的成员。
有关详细信息,请参阅 Windows SDK 中的 OLEUICHANGESOURCE 结构。
COleChangeSourceDialog::IsValidSource
调用此函数以确定新源是否有效。
BOOL IsValidSource();
返回值
如果新源有效,则为非零,否则为 0。
备注
仅在 DoModal 返回 IDOK 后调用此函数。
有关详细信息,请参阅 Windows SDK 中的 OLEUICHANGESOURCE 结构。