| description | title | ms.date | f1_keywords | ms.assetid | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Learn more about: Snap-In Object Macros |
Snap-In Object Macros |
11/04/2016 |
|
4e9850c0-e395-4929-86c9-584a81828053 |
These macros provide support for snap-in extensions.
| Name | Description |
|---|---|
| BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP | Marks the beginning of the snap-in extension data class map for a Snap-In object. |
| BEGIN_SNAPINTOOLBARID_MAP | Marks the beginning of the toolbar map for a Snap-In object. |
| END_EXTENSION_SNAPIN_NODEINFO_MAP | Marks the end of the snap-in extension data class map for a Snap-In object. |
| END_SNAPINTOOLBARID_MAP | Marks the end of the toolbar map for a Snap-In object. |
| EXTENSION_SNAPIN_DATACLASS | Creates a data member for the data class of the snap-in extension. |
| EXTENSION_SNAPIN_NODEINFO_ENTRY | Enters a snap-in extension data class into the snap-in extension data class map of the Snap-In object. |
| SNAPINMENUID | Declares the ID of the context menu used by the Snap-In object. |
| SNAPINTOOLBARID_ENTRY | Enters a toolbar into the toolbar map of the Snap-In object. |
Header: atlsnap.h
Marks the beginning of the snap-in extension data class map.
BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP(classname)
classname
[in] The name of the snap-in extension data class.
Start your snap-in extension map with the BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP macro, add entries for each of your snap-in extension data types with the EXTENSION_SNAPIN_NODEINFO_ENTRY macro, and complete the map with the END_EXTENSION_SNAPIN_NODEINFO_MAP macro.
[!code-cppNVC_ATL_Windowing#105]
Declares the beginning of the toolbar ID map for the Snap-In object.
BEGIN_SNAPINTOOLBARID_MAP(_class)
_class
[in] Specifies the Snap-In object class.
[!code-cppNVC_ATL_Windowing#106]
Marks the end of the snap-in extension data class map.
END_EXTENSION_SNAPIN_NODEINFO_MAP()
Start your snap-in extension map with the BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP macro, add entries for each of your extension snap-in data types with the EXTENSION_SNAPIN_NODEINFO_ENTRY macro, and complete the map with the END_EXTENSION_SNAPIN_NODEINFO_MAP macro.
See the example for BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP.
Declares the end of the toolbar ID map for the Snap-In object.
END_SNAPINTOOLBARID_MAP( _class )
_class
[in] Specifies the Snap-In object class.
See the example for BEGIN_SNAPINTOOLBARID_MAP.
Adds a data member to the snap-in extension data class for an ISnapInItemImpl-derived class.
EXTENSION_SNAPIN_DATACLASS(dataClass )
dataClass
[in] The data class of the snap-in extension.
This class should also be entered into a snap-in extension data class map. Start your snap-in extension data class map with the BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP macro, add entries for each of your snap-in extension data types with the EXTENSION_SNAPIN_NODEINFO_ENTRY macro, and complete the map with the END_EXTENSION_SNAPIN_NODEINFO_MAP macro.
[!code-cppNVC_ATL_Windowing#105]
Adds a snap-in extension data class to the snap-in extension data class map.
EXTENSION_SNAPIN_NODEINFO_ENTRY( dataClass )
dataClass
[in] The data class of the snap-in extension.
Start your snap-in extension data class map with the BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP macro, add entries for each of your snap-in extension data types with the EXTENSION_SNAPIN_NODEINFO_ENTRY macro, and complete the map with the END_EXTENSION_SNAPIN_NODEINFO_MAP macro.
See the example for BEGIN_EXTENSION_SNAPIN_NODEINFO_MAP.
Use this macro to declare the context menu resource of the Snap-In object.
SNAPINMENUID( id )
id
[in] Identifies the context menu of the Snap-In object.
Use this macro to enter a toolbar ID into the Snap-In object's toolbar ID map.
SNAPINTOOLBARID_ENTRY( id )
id
[in] Identifies the toolbar control.
The BEGIN_SNAPINTOOLBARID_MAP macro marks the beginning of the toolbar ID map; the END_SNAPINTOOLBARID_MAP macro marks the end.
See the example for BEGIN_SNAPINTOOLBARID_MAP.