VCCodeClass Interface

 

An object providing access to any class element collected in a VCCodeModel object.

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

[GuidAttribute("CAA1BBC0-A35F-4E2E-96CE-1361F4B4FA72")]
public interface VCCodeClass

NameDescription
System_CAPS_pubpropertyAccess

Sets or gets 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_pubpropertyClasses

Gets a collection of classes for the parent object.

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 VCCodeClass.

System_CAPS_pubpropertyDataTypeKind

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]

Gets the end point of the parent object.

System_CAPS_pubpropertyEnums

Gets a collection of enumerations for the parent object.

System_CAPS_pubpropertyEvents

Gets a collection of events for 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 VCCodeClass is declared.

System_CAPS_pubpropertyFullName

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

System_CAPS_pubpropertyFunctions

Gets a collection of functions for the parent object.

System_CAPS_pubpropertyImplementedInterfaces

Gets a collection of interfaces implemented by this object.

System_CAPS_pubpropertyInfoLocation

Gets the capabilities of the code model.

System_CAPS_pubpropertyIsAbstract

Gets or sets a value indicating whether or not an item is declared as abstract.

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_pubpropertyIsFinal

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 VCCodeClass object is managed.

System_CAPS_pubpropertyIsReadOnly

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

System_CAPS_pubpropertyIsSealed

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

System_CAPS_pubpropertyIsTemplate

Gets a value indicating whether the VCCodeClass object is a template.

System_CAPS_pubpropertyIsValue

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

System_CAPS_pubpropertyIsZombie

Gets a value indicating whether the VCCodeClass 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 VCCodeClass object declaration.

System_CAPS_pubpropertyMaps

Gets the collection of maps for the VCCodeClass object.

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

System_CAPS_pubpropertyParent

Gets the immediate parent object of a given object.

System_CAPS_pubpropertyParts

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_pubpropertyProperties

Gets the collection of properties for the parent 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]

Returns the start point of the parent object.

System_CAPS_pubpropertyStructs

Gets the collection of structure elements for the VCCodeClass object.

System_CAPS_pubpropertyTemplateParameters

Gets a collection of parameters contained in a class template.

System_CAPS_pubpropertyTemplatizations

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubpropertyTypedefs

Gets the collection of VCCodeTypedef elements for the parent object.

System_CAPS_pubpropertyUnions

Gets the collection of VCCodeUnion elements for the VCCodeClass object.

System_CAPS_pubpropertyUsingAliases

System_CAPS_pubpropertyVariables

Gets the collection of variables for the VCCodeClass 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_pubmethodAddClass(String, Object, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddDelegate(String, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddEnum(String, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddEvent(String, Object, Object, vsCMAccess)

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

System_CAPS_pubmethodAddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object)

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

System_CAPS_pubmethodAddImplementedInterface(Object, Object)

Adds an interface to the list of inherited objects.

System_CAPS_pubmethodAddMap(String, String, Object, Object)

Adds a map entry to the parent object.

System_CAPS_pubmethodAddProperty(String, String, Object, Object, vsCMAccess, Object)

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

System_CAPS_pubmethodAddStruct(String, Object, Object, Object, vsCMAccess)

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

System_CAPS_pubmethodAddTemplateParameter(String, Object, Object)

Adds a parameter to a template definition.

System_CAPS_pubmethodAddTypedef(String, Object, Object, vsCMAccess)

Adds a Typedef statement to the parent object.

System_CAPS_pubmethodAddUnion(String, Object, vsCMAccess)

Adds a union statement to the parent object.

System_CAPS_pubmethodAddUsingAlias(String, Object, Object, vsCMAccess)

System_CAPS_pubmethodAddVariable(String, Object, Object, vsCMAccess, Object)

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

System_CAPS_pubmethodGetEndPoint(vsCMPart)

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

System_CAPS_pubmethodGetStartPoint(vsCMPart)

Returns 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_pubmethodRemoveInterface(Object)

Removes an interface from the list of implemented interfaces.

System_CAPS_pubmethodRemoveMember(Object)

Removes a member code construct.

System_CAPS_pubmethodRemoveTemplateParameter(Object)

Removes a parameter from a template definition.

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)

The VCCodeClass object provides code model functionality to existing Visual C++ IDE solutions at the class level. Primarily, this object is used to modify any class element accessible within a project.

System_CAPS_noteNote

A large part of the functionality of this object is provided by the Visual Studio CodeClass object. For more information, see CodeClass object.

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

Sub GetClass()
    Dim vcCM as VCCodeModel
    Dim vcClass as VCCodeClass
    vcCM = DTE.Solution.Item(1).CodeModel
    vcClass = vcCM.Classes.Find("CAboutDlg")
End Sub
Return to top
Show: