IPerPropertyBrowsingImpl Class

 

For the latest documentation on Visual Studio 2017, see Visual Studio 2017 Documentation.

For the latest documentation on Visual Studio 2017, see IPerPropertyBrowsingImpl Class on docs.microsoft.com. This class implements IUnknown and allows a client to access the information in an object's property pages.

System_CAPS_ICON_important.jpg Important

This class and its members cannot be used in applications that execute in the Windows Runtime.


template <class T>
class ATL_NO_VTABLE IPerPropertyBrowsingImpl :
    public IPerPropertyBrowsing

Parameters

T
Your class, derived from IPerPropertyBrowsingImpl.

Public Methods

NameDescription
IPerPropertyBrowsingImpl::GetDisplayStringRetrieves a string describing a given property.
IPerPropertyBrowsingImpl::GetPredefinedStringsRetrieves an array of strings corresponding to the values that a given property can accept.
IPerPropertyBrowsingImpl::GetPredefinedValueRetrieves a VARIANT containing the value of a property identified by a given DISPID. The DISPID is associated with the string name retrieved from GetPredefinedStrings. The ATL implementation returns E_NOTIMPL.
IPerPropertyBrowsingImpl::MapPropertyToPageRetrieves the CLSID of the property page associated with a given property.

The IPerPropertyBrowsing interface allows a client to access the information in an object's property pages. Class IPerPropertyBrowsingImpl provides a default implementation of this interface and implements IUnknown by sending information to the dump device in debug builds.

System_CAPS_ICON_note.jpg Note

If you are using Microsoft Access as the container application, you must derive your class from IPerPropertyBrowsingImpl. Otherwise, Access will not load your control.

Related Articles ATL Tutorial, Creating an ATL Project

IPerPropertyBrowsing

IPerPropertyBrowsingImpl

Header: atlctl.h

Retrieves a string describing a given property.

STDMETHOD(GetDisplayString)(
    DISPID dispID,
    BSTR* pBstr);

Remarks

See IPerPropertyBrowsing::GetDisplayString in the Windows SDK.

Fills each array with zero items.

STDMETHOD(GetPredefinedStrings)(
    DISPID dispID,
    CALPOLESTR* pCaStringsOut,
    CADWORD* pCaCookiesOut);

Return Value

ATL's implementation of GetPredefinedValue returns E_NOTIMPL.

Remarks

See IPerPropertyBrowsing::GetPredefinedStrings in the Windows SDK.

Retrieves a VARIANT containing the value of a property identified by a given DISPID. The DISPID is associated with the string name retrieved from GetPredefinedStrings.

STDMETHOD(GetPredefinedValue)(
    DISPID dispID,
    DWORD dwCookie,
    VARIANT* pVarOut);

Return Value

Returns E_NOTIMPL.

Remarks

ATL's implementation of GetPredefinedStrings retrieves no corresponding strings.

See IPerPropertyBrowsing::GetPredefinedValue in the Windows SDK.

Retrieves the CLSID of the property page associated with the specified property.

STDMETHOD(MapPropertyToPage)(
    DISPID dispID,
    CLSID* pClsid);

Remarks

ATL uses the object's property map to obtain this information.

See IPerPropertyBrowsing::MapPropertyToPage in the Windows SDK.

IPropertyPageImpl Class
ISpecifyPropertyPagesImpl Class
Class Overview

Show: