VCCodeEnum Interface

VCCodeEnum Interface

 

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

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

[GuidAttribute("661A36DC-B9C8-4C0D-B481-F9D9D8305DA0")]
public interface VCCodeEnum

NameDescription
System_CAPS_pubpropertyAccess

Gets or sets the access attributes of this item.

System_CAPS_pubpropertyAttributes

Gets a collection of all of the attributes for the parent object.

System_CAPS_pubpropertyBases

Gets a collection of classes from which this item derives.

System_CAPS_pubpropertyBodyText

Gets or sets the body text of the parent object.

System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyCodeModel

Gets the VCCodeModel 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_pubpropertyDeclarationText

Gets or sets the declaration of the parent object.

System_CAPS_pubpropertyDerivedTypes

Gets a collection of objects derived from this object.

System_CAPS_pubpropertyDisplayName

Gets the full name of the parent object.

System_CAPS_pubpropertyDocComment

Gets or sets the document comment for the current code model element.

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]

Returns the end point of the parent 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 in which the parent object is declared.

System_CAPS_pubpropertyFullName

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

System_CAPS_pubpropertyInfoLocation

Describes 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_pubpropertyIsDerivedFrom[String]

Gets a value indicating whether an object has another object as a base.

System_CAPS_pubpropertyIsInjected

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

System_CAPS_pubpropertyIsManaged

Gets or sets a value indicating whether the parent object is managed.

System_CAPS_pubpropertyIsReadOnly

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

System_CAPS_pubpropertyIsValue

Gets or sets a value indicating whether the __value keyword is applied to the parent object.

System_CAPS_pubpropertyIsZombie

Gets a value indicating whether the VCCodeEnum 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_pubpropertyMembers

Gets a collection of items contained by this element.

System_CAPS_pubpropertyName

Gets or sets the name of the object.

System_CAPS_pubpropertyNamespace

Gets an object defining the namespace.

System_CAPS_pubpropertyParent

Gets the immediate parent object of a VCCodeEnum 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 object associated with the object.

System_CAPS_pubpropertyProjectItem

Gets the ProjectItem object associated with the given object.

System_CAPS_pubpropertyReferences

Not currently implemented.

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 parent object.

NameDescription
System_CAPS_pubmethodAddAttribute(String, String, Object)

Creates a new attribute code construct and inserts the code in the correct location.

System_CAPS_pubmethodAddBase(Object, Object)

Adds an item to the list of inherited objects.

System_CAPS_pubmethodAddMember(String, Object, Object)

Creates a new member code construct and inserts the code in the correct location.

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 the parent code element.

System_CAPS_pubmethodRemoveBase(Object)

Removes an object from the list of bases.

System_CAPS_pubmethodRemoveMember(Object)

Removes a member code construct.

System_CAPS_pubmethodValidateMember(String, vsCMElement, String)

Validates that the proposed name is a valid C++ name for the kind given in the context of the parent object.

System_CAPS_pubmethodValidateMemberName(String, vsCMElement, vcCMNameValidationOption)

A large part of the functionality of this object is provided by the Visual Studio CodeEnum object.

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.

This example displays the variables used by the first enumeration of the CAboutDlg class. It assumes a CAboutDlg class exists and has enumerations.

Sub GetEnums()
    Dim vcCM As VCCodeModel
    Dim vcEnum As VCCodeEnum
    Dim vcVariable As VCCodeVariable
    vcCM = DTE.Solution.Item(1).CodeModel
    vcEnum = vcCM.Classes.Item("CAboutDlg").Enums.Item(1)
    For Each vcVariable In vcEnum.Members
        MsgBox(vcVariable.DisplayName)
    Next
End Sub
Return to top
Show:
© 2016 Microsoft