VCCodeMap Interface

Definition

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

public interface class VCCodeMap
public interface class VCCodeMap
__interface VCCodeMap
[System.Runtime.InteropServices.Guid("B0BBA023-150C-4D33-B48C-6AD66A74CE41")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
public interface VCCodeMap
[<System.Runtime.InteropServices.Guid("B0BBA023-150C-4D33-B48C-6AD66A74CE41")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
type VCCodeMap = interface
Public Interface VCCodeMap
Attributes

Examples

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  

Remarks

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:

Properties

BodyText

Gets or sets the body text of the object.

Children

Gets a collection of objects contained within this code construct.

CodeModel

Gets the VCCodeModel object for the project.

Collection

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

Comment

Gets or sets the comment associated with the code element.

DisplayName

Gets the full name of the object.

DTE

Gets the top-level extensibility object.

EndPoint

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

EndPointOf[vsCMPart, vsCMWhere]

Gets the end point of the object.

Entries

Gets the entries of the VCCodeMap object.

Extender[String]

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

ExtenderCATID

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

ExtenderNames

Gets a list of available Extenders for the object.

File

Gets the file where this object is defined.

FullName

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

InfoLocation

Gets the capabilities of the code model.

IsCaseSensitive

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

IsCodeType

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

IsInjected

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

IsReadOnly

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

IsZombie

Gets a value indicating whether the object exists.

Kind

Gets an enumeration indicating the type of object.

Language

Gets the programming language used to author the code.

Location[vsCMWhere]

Gets the location of the object declaration.

Name

Gets or sets the name of the object.

Namespace

Gets an object defining the namespace.

Parameters

Gets a collection of parameters for this item.

Parent

Gets the immediate parent object of a given object.

Picture

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

Project

Gets the Project associated with the object.

ProjectItem

Gets the ProjectItem object associated with the given object.

StartPoint

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

StartPointOf[vsCMPart, vsCMWhere]

Gets the start point of the object.

Methods

AddEntry(String, Object)

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

GetEndPoint(vsCMPart)

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

GetStartPoint(vsCMPart)

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

IsSelf(Object)

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

RemoveEntry(Object)

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

Applies to