Share via


CSnapInItemImpl Class

This class provides methods for implementing a snap-in node object.

Important

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

template < 
class T, 
BOOL bIsExtension= FALSE 
> 
class ATL_NO_VTABLE CSnapInItemImpl : 
public CSnapInItem

Parameters

  • T
    Your class, derived from CSnapInItemImpl.

  • bIsExtension
    TRUE if the object is a snap-in extension; otherwise FALSE.

Members

Public Constructors

Name

Description

CSnapInItemImpl::CSnapInItemImpl

Constructor.

Public Methods

Name

Description

CSnapInItemImpl::AddMenuItems

Adds menu items to a context menu.

CSnapInItemImpl::Command

Called by the console when a custom menu item is selected.

CSnapInItemImpl::CreatePropertyPages

Adds pages to the property sheet of the snap-in.

CSnapInItemImpl::FillData

Copies information on the snap-in object into a specified stream.

CSnapInItemImpl::GetResultPaneInfo

Retrieves the RESULTDATAITEM structure of the snap-in.

CSnapInItemImpl::GetResultViewType

Determines the type of view used by the result pane.

CSnapInItemImpl::GetScopePaneInfo

Retrieves the SCOPEDATAITEM structure of the snap-in.

CSnapInItemImpl::Notify

Called by the console to notify the snap-in of actions taken by the user.

CSnapInItemImpl::QueryPagesFor

Called to see if the snap-in node supports property pages.

CSnapInItemImpl::SetMenuInsertionFlags

Modifies the menu insertion flags for a snap-in object.

CSnapInItemImpl::SetToolbarButtonInfo

Sets the information of the specified toolbar button.

CSnapInItemImpl::UpdateMenuState

Updates the state of a context menu item.

CSnapInItemImpl::UpdateToolbarButton

Updates the state of the specified toolbar button.

Public Data Members

Name

Description

CSnapInItemImpl::m_bstrDisplayName

The name of the snap-in object.

CSnapInItemImpl::m_resultDataItem

The Windows RESULTDATAITEM structure used by the CSnapInItemImpl object.

CSnapInItemImpl::m_scopeDataItem

The Windows SCOPEDATAITEM structure used by the CSnapInItemImpl object.

Remarks

CSnapInItemImpl provides a basic implementation for a snap-in node object, such as adding menu items and toolbars, and forwarding commands for the snap-in node to the appropriate handler function. These features are implemented using several different interfaces and map types. The default implementation handles notifications sent to the node object by determining the correct instance of the derived class and then forwarding the message to the correct instance.

Inheritance Hierarchy

CSnapInItem

CSnapInItemImpl

Requirements

Header: atlsnap.h

See Also

Other Resources

ATL Class Overview