Edit

IPerPropertyBrowsingImpl Class

  • Article

This class implements IUnknown and allows a client to access the information in an object's property pages.

Important

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

Syntax

template <class T>
class ATL_NO_VTABLE IPerPropertyBrowsingImpl :
    public IPerPropertyBrowsing

Parameters

T
Your class, derived from IPerPropertyBrowsingImpl.

Members

Public Methods

Name Description
IPerPropertyBrowsingImpl::GetDisplayString Retrieves a string describing a given property.
IPerPropertyBrowsingImpl::GetPredefinedStrings Retrieves an array of strings corresponding to the values that a given property can accept.
IPerPropertyBrowsingImpl::GetPredefinedValue 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. The ATL implementation returns E_NOTIMPL.
IPerPropertyBrowsingImpl::MapPropertyToPage Retrieves the CLSID of the property page associated with a given property.

Remarks

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.

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

Inheritance Hierarchy

IPerPropertyBrowsing

IPerPropertyBrowsingImpl

Requirements

Header: atlctl.h

IPerPropertyBrowsingImpl::GetDisplayString

Retrieves a string describing a given property.

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

Remarks

See IPerPropertyBrowsing::GetDisplayString in the Windows SDK.

IPerPropertyBrowsingImpl::GetPredefinedStrings

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.

IPerPropertyBrowsingImpl::GetPredefinedValue

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.

IPerPropertyBrowsingImpl::MapPropertyToPage

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.

See also

IPropertyPageImpl Class
ISpecifyPropertyPagesImpl Class
Class Overview