COlePropertiesDialog Class

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at COlePropertiesDialog Class.

Encapsulates the Windows common OLE Object Properties dialog box.

Syntax

class COlePropertiesDialog : public COleDialog  

Members

Public Constructors

Public Methods

Public Data Members

Remarks

Common OLE Object Properties dialog boxes provide an easy way to display and modify the properties of an OLE document item in a manner consistent with Windows standards. These properties include, among others, information on the file represented by the document item, options for displaying the icon and image scaling, and information on the item's link (if the item is linked).

To use a COlePropertiesDialog object, first create the object using the COlePropertiesDialog constructor. After the dialog box has been constructed, call the DoModal member function to display the dialog box and allow the user to modify any properties of the item. DoModal returns whether the user selected the OK ( IDOK) or the Cancel ( IDCANCEL) button. In addition to the OK and Cancel buttons, there is an Apply button. When the user selects Apply, any changes made to the properties of the document item are applied to the item and its image is automatically updated, but remains active.

The m_psh data member is a pointer to a PROPSHEETHEADER structure, and in most cases you will not need to access it explicitly. One exception is when you need additional property pages beyond the default General, View, and Link pages. In this case, you can modify the m_psh data member to include your custom pages before calling the DoModal member function.

For more information on OLE dialog boxes, see the article Dialog Boxes in OLE.

Inheritance Hierarchy

CObject

CCmdTarget

CWnd

CDialog

CCommonDialog

COleDialog

COlePropertiesDialog

Requirements

Header: afxodlgs.h

COlePropertiesDialog::COlePropertiesDialog

Creates a COlePropertiesDialog object.

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

Parameters

pItem
Pointer to the document item whose properties are being accessed.

nScaleMin
Minimum scaling percentage for the document item image.

nScaleMax
Maximum scaling percentage for the document item image.

pParentWnd
Pointer to the dialog box's parent or owner.

Remarks

Derive your common OLE Object Properties dialog class from COlePropertiesDialog in order to implement scaling for your document items. Any dialog boxes implemented by an instance of this class will not support scaling of the document item.

By default, the common OLE Object Properties dialog box has three default pages:

• General

  This page contains system information for the file represented by the selected document item. From this page, the user can convert the selected item to another type.

• View

  This page contains options for displaying the item, changing the icon, and changing the scaling of the image.

• Link

  This page contains options for changing the location of the linked item and updating the linked item. From this page, the user can break the link of the selected item.

To add pages beyond those provided by default, modify the m_psh member variable before exiting the constructor of your COlePropertiesDialog-derived class. This is an advanced implementation of the COlePropertiesDialog constructor.

COlePropertiesDialog::DoModal

Call this member function to display the Windows common OLE Object Properties dialog box and allow the user to view and/or change the various properties of the document item.

virtual INT_PTR DoModal();

Return Value

IDOK or IDCANCEL if successful; otherwise 0. IDOK and IDCANCEL are constants that indicate whether the user selected the OK or Cancel button.

If IDCANCEL is returned, you can call the Windows CommDlgExtendedError function to determine whether an error occurred.

COlePropertiesDialog::m_gp

A structure of type OLEUIGNRLPROPS, used to initialize the General page of the OLE Object Properties dialog box.

OLEUIGNRLPROPS m_gp;  

Remarks

This page shows the type and size of an embedding and allows the user access to the Convert dialog box. This page also shows the link destination if the object is a link.

For more information on the OLEUIGNRLPROPS structure, see the Windows SDK.

COlePropertiesDialog::m_lp

A structure of type OLEUILINKPROPS, used to initialize the Link page of the OLE Object Properties dialog box.

OLEUILINKPROPS m_lp;  

Remarks

This page shows the location of the linked item and allows the user to update, or break, the link to the item.

For more information on the OLEUILINKPROPS structure, see the Windows SDK.

COlePropertiesDialog::m_op

A structure of type OLEUIOBJECTPROPS, used to initialize the common OLE Object Properties dialog box.

OLEUIOBJECTPROPS m_op;  

Remarks

This structure contains members used to initialize the General, Link, and View pages.

For more information, see the OLEUIOBJECTPROPS and OLEUILINKPROPS structures in the Windows SDK.

COlePropertiesDialog::m_psh

A structure of type PROPSHEETHEADER, whose members store the characteristics of the dialog object.

PROPSHEETHEADER m_psh;  

Remarks

After constructing a COlePropertiesDialog object, you can use m_psh to set various aspects of the dialog box before calling the DoModal member function.

If you modify the m_psh data member directly, you will override any default behavior.

For more information on the PROPSHEETHEADER structure, see the Windows SDK.

COlePropertiesDialog::m_vp

A structure of type OLEUIVIEWPROPS, used to initialize the View page of the OLE Object Properties dialog box.

OLEUIVIEWPROPS m_vp;  

Remarks

This page allows the user to toggle between "content" and "iconic" views of the object, and change its scaling within the container. It also allows the user access to the Change Icon dialog box when the object is being displayed as an icon.

For more information on the OLEUIVIEWPROPS structure, see the Windows SDK.

COlePropertiesDialog::OnApplyScale

Called by the framework when the scaling value has changed and either OK or Apply was selected.

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

Parameters

pItem
Pointer to the document item whose properties are being accessed.

nCurrentScale
Numerical value of the dialog scale.

bRelativeToOrig
Indicates whether scaling applies to the original size of the document item.

Return Value

Nonzero if handled; otherwise 0.

Remarks

The default implementation does nothing. You must override this function to enable the scaling controls.

See Also

MFC Sample CIRC
COleDialog Class
Hierarchy Chart
COleDialog Class
CPropertyPage Class