COlePropertiesDialog 类

项目
10/18/2023

封装 Windows 公共 OLE“对象属性”对话框。

语法

class COlePropertiesDialog : public COleDialog

成员

公共构造函数

名称	描述
COlePropertiesDialog::COlePropertiesDialog	构造 `COlePropertiesDialog` 对象。

公共方法

名称	描述
COlePropertiesDialog::DoModal	显示对话框并允许用户做出选择。
COlePropertiesDialog::OnApplyScale	当文档项的缩放发生更改时由框架调用。

公共数据成员

“属性”	描述
COlePropertiesDialog::m_gp	用于初始化 `COlePropertiesDialog` 对象的“常规”页的结构。
COlePropertiesDialog::m_lp	用于初始化 `COlePropertiesDialog` 对象的“链接”页的结构。
COlePropertiesDialog::m_op	用于初始化 `COlePropertiesDialog` 对象的结构。
COlePropertiesDialog::m_psh	用于添加其他自定义属性页的结构。
COlePropertiesDialog::m_vp	用于自定义 `COlePropertiesDialog` 对象的“视图”页的结构。

备注

“通用 OLE 对象属性”对话框提供了一种简单方法，使你能够采用与 Windows 标准一致的方式来显示和修改 OLE 文档项的属性。这些属性包括有关由文档项表示的文件的信息、用于显示图标和图像缩放的选项，以及有关项的链接的信息（如果已链接该项）。

若要使用 COlePropertiesDialog 对象，请先使用 COlePropertiesDialog 构造函数创建该对象。构造对话框后，调用 DoModal 成员函数以显示对话框并允许用户修改项的任何属性。 DoModal 返回用户选择的是“确定”(IDOK) 还是“取消”(IDCANCEL) 按钮。除了“确定”和“取消”按钮外，还有一个“应用”按钮。当用户选择“应用”时，对文档项的属性所做的任何更改将应用于该项，并且其图像会自动更新，但仍保持活动状态。

m_psh 数据成员是指向 PROPSHEETHEADER 结构的指针，在大多数情况下，你不需要显式访问它。一种例外情况是需要默认的“常规”、“视图”和“链接”页之外的其他属性页时。在这种情况下，可以在调用 DoModal 成员函数之前修改 m_psh 数据成员以包含自定义页。

有关 OLE 对话框的详细信息，请参阅文章 OLE 中的对话框。

继承层次结构

COlePropertiesDialog

要求

标头：afxodlgs.h

COlePropertiesDialog::COlePropertiesDialog

创建一个 COlePropertiesDialog 对象。

COlePropertiesDialog(
    COleClientItem* pItem,
    UINT nScaleMin = 10,
    UINT nScaleMax = 500,
    CWnd* pParentWnd = NULL);

参数

pItem
指向正在访问其属性的文档项的指针。

nScaleMin
文档项图像的最小缩放百分比。

nScaleMax
文档项图像的最大缩放百分比。

pParentWnd
指向对话框的父级或所有者的指针。

备注

从 COlePropertiesDialog 派生通用 OLE 对象属性对话框类，以实现文档项的缩放。此类的实例实现的任何对话框都不支持文档项缩放。

默认情况下，通用 OLE 对象属性对话框具有三个默认页：

常规

此页包含选定文档项表示的文件的系统信息。在此页中，用户可将选定项转换为另一种类型。
视图

此页包含用于显示项、更改图标和更改图像缩放的选项。
链接

此页包含用于更改链接项的位置和更新链接项的选项。在此页中，用户可以断开选定项的链接。

若要添加除默认提供的页之外的页，请在退出 COlePropertiesDialog 派生类的构造函数之前修改 m_psh 成员变量。这是 COlePropertiesDialog 构造函数的高级实现。

COlePropertiesDialog::DoModal

调用此成员函数可显示 Windows 通用 OLE 对象属性对话框，并允许用户查看和/或更改文档项的各种属性。

virtual INT_PTR DoModal();

返回值

如果成功，则返回 IDOK 或 IDCANCEL；否则返回 0。 IDOK 和 IDCANCEL 是常量，指示用户选择的是“确定”还是“取消”按钮。

如果返回了 IDCANCEL，则可以调用 Windows CommDlgExtendedError 函数以确定是否发生了错误。

COlePropertiesDialog::m_gp

OLEUIGNRLPROPS 类型的结构，用于初始化 OLE 对象属性对话框的“常规”页。

OLEUIGNRLPROPS m_gp;

注解

此页显示嵌入的类型和大小，并允许用户访问“转换”对话框。如果对象是链接，则此页还会显示链接目标。

有关 OLEUIGNRLPROPS 结构的详细信息，请参阅 Windows SDK。

COlePropertiesDialog::m_lp

OLEUILINKPROPS 类型的结构，用于初始化 OLE 对象属性对话框的“链接”页。

OLEUILINKPROPS m_lp;

备注

此页显示链接项的位置，并允许用户更新或断开该项的链接。

有关 OLEUILINKPROPS 结构的详细信息，请参阅 Windows SDK。

COlePropertiesDialog::m_op

OLEUIOBJECTPROPS 类型的结构，用于初始化通用 OLE 对象属性对话框。

OLEUIOBJECTPROPS m_op;

备注

此结构包含用于初始化“常规”、“链接”和“视图”页的成员。

有关详细信息，请参阅 Windows SDK 中的 OLEUIOBJECTPROPS 和 OLEUILINKPROPS 结构。

COlePropertiesDialog::m_psh

PROPSHEETHEADER 类型的结构，其成员存储对话框对象的特征。

PROPSHEETHEADER m_psh;

备注

构造 COlePropertiesDialog 对象后，可以在调用 DoModal 成员函数之前使用 m_psh 来设置对话框的各个方面。

如果直接修改 m_psh 数据成员，你将替代任何默认行为。

有关 PROPSHEETHEADER 结构的详细信息，请参阅 Windows SDK。

COlePropertiesDialog::m_vp

OLEUIVIEWPROPS 类型的结构，用于初始化 OLE 对象属性对话框的“视图”页。

OLEUIVIEWPROPS m_vp;

备注

此页允许用户在对象的“内容”和“图标”视图之间切换，以及更改其在容器中的缩放。它还允许用户在对象显示为图标时访问“更改图标”对话框。

有关 OLEUIVIEWPROPS 结构的详细信息，请参阅 Windows SDK。

COlePropertiesDialog::OnApplyScale

当缩放值发生更改并选择了“确定”或“应用”时由框架调用。

virtual BOOL OnApplyScale(
    COleClientItem* pItem,
    int nCurrentScale,
    BOOL bRelativeToOrig);

参数

pItem
指向正在访问其属性的文档项的指针。

nCurrentScale
对话框缩放数值。

bRelativeToOrig
指示缩放是否应用于文档项的原始大小。

返回值

如果已处理，则返回非零值；否则返回 0。

备注

默认实现不执行任何操作。必须重写此函数才能启用缩放控件。

注意

在显示通用 OLE 对象属性对话框之前，框架会调用此函数并为 pItem 指定 NULL，为 nCurrentScale 指定 -1。这样做是为了确定是否应启用缩放控件。

另请参阅

MFC 示例 CIRC
COleDialog 类
 层次结构图
 COleDialog 类
 CPropertyPage 类

通过