VCCodeMap Interface

 

An object representing a map code element in the source code of a solution.

Namespace:   Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

[GuidAttribute("3FEB2D54-01CF-40B9-94D5-3021BCC981D7")]
public interface VCCodeMap

NameDescription
System_CAPS_pubpropertyBodyText

Gets or sets the body text of the object.

System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyCodeModel

Gets the VCCodeModel object for the project.

System_CAPS_pubpropertyCollection

Gets the collection containing the object supporting this property or contained within this code construct.

System_CAPS_pubpropertyComment

Gets or sets the comment associated with the code element.

System_CAPS_pubpropertyDisplayName

Gets the full name of the object.

System_CAPS_pubpropertyDTE

Gets the top-level extensibility object.

System_CAPS_pubpropertyEndPoint

Gets the edit point that is the location of the end of the code item.

System_CAPS_pubpropertyEndPointOf[vsCMPart, vsCMWhere]

Gets the end point of the object.

System_CAPS_pubpropertyEntries

Gets the entries of the VCCodeMap object.

System_CAPS_pubpropertyExtender[String]

Gets the requested Extender object if it is available for this object.

System_CAPS_pubpropertyExtenderCATID

Gets the Extender category ID (CATID) for the object.

System_CAPS_pubpropertyExtenderNames

Gets a list of available Extenders for the object.

System_CAPS_pubpropertyFile

Gets the file where this object is defined.

System_CAPS_pubpropertyFullName

Gets the full path and name of the object's file.

System_CAPS_pubpropertyInfoLocation

Gets the capabilities of the code model.

System_CAPS_pubpropertyIsCaseSensitive

Gets a value indicating whether a code element is case-sensitive.

System_CAPS_pubpropertyIsCodeType

Gets a value indicating whether a CodeType object can be obtained from this object.

System_CAPS_pubpropertyIsInjected

Gets a value indicating whether a code element has been injected by an attribute or macro expansion.

System_CAPS_pubpropertyIsReadOnly

Gets a value indicating whether the file containing the object is read-only.

System_CAPS_pubpropertyIsZombie

Gets a value indicating whether the object exists.

System_CAPS_pubpropertyKind

Gets an enumeration indicating the type of object.

System_CAPS_pubpropertyLanguage

Gets the programming language used to author the code.

System_CAPS_pubpropertyLocation[vsCMWhere]

Gets the location of the object declaration.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyNamespace

Gets an object defining the namespace.

System_CAPS_pubpropertyParameters

Gets a collection of parameters for this item.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyPicture

Gets a picture automation object to be used as an icon in the user interface.

System_CAPS_pubpropertyProject

Gets the Project associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyStartPoint

Gets a TextPoint object that defines the beginning of the code item.

System_CAPS_pubpropertyStartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the object.

NameDescription
System_CAPS_pubmethodAddEntry(String, Object)

Inserts a map entry into the map code element represented by the VCCodeMap object.

System_CAPS_pubmethodGetEndPoint(vsCMPart)

Gets a TextPoint object that marks the end of the code element definition.

System_CAPS_pubmethodGetStartPoint(vsCMPart)

Gets a TextPoint object that defines the beginning of the code element definition.

System_CAPS_pubmethodIsSelf(Object)

Determines if the specified code element is the same as another code element.

System_CAPS_pubmethodRemoveEntry(Object)

Removes the specified map entry from the map code element represented by the VCCodeMap object.

The main purpose of the VCCodeMap object is to modify an existing map element. Modifications include adding and removing map entries and modifying the properties of existing map entries.

A map element is any code element beginning with a BEGIN_XXX_MAP macro and ending with a END_XXX_MAP macro. Some common examples are:

This example retrieves the first VCCodeMap object of the current solution and displays it in a message box. It assumes a default MFC project is open.

Sub GetFirstMap()
    Dim vcCM As VCCodeModel
    Dim vcMap As VCCodeMap
    vcCM = DTE.Solution.Item(1).CodeModel
    vcMap = vcCM.Maps.Item(1)
    MsgBox(vcMap.DisplayName)
End Sub
Return to top
Show: