Export (0) Print
Expand All

VCCodeUnion Interface

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

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

[GuidAttribute("A9EC78FA-0C55-4893-8985-900EC8F4BB31")]
public interface VCCodeUnion

The VCCodeUnion type exposes the following members.

  NameDescription
Public propertyAccessSets or gets the access attributes of this item.
Public propertyAttributesGets a collection of all of the attributes for the object.
Public propertyBasesGets a collection of classes from which this item derives.
Public propertyBodyTextGets or sets the body text of the object.
Public propertyChildrenGets a collection of objects contained within this code construct.
Public propertyClassesGets a collection of classes for the object.
Public propertyCodeModelGets the VCCodeModel object for the project.
Public propertyCollectionGets the collection containing the object supporting this property or contained within this code construct.
Public propertyCommentGets or sets the comment associated with the code element.
Public propertyDeclarationTextGets or sets the declaration of the object.
Public propertyDerivedTypesGets a collection of objects derived from this object.
Public propertyDisplayNameGets the formatted name to be displayed to users.
Public propertyDocCommentSets or gets the document comment for the current code model element.
Public propertyDTEGets the top-level extensibility object.
Public propertyEndPointGets the edit point that is the location of the end of the code item.
Public propertyEndPointOfReturns the end point of the object.
Public propertyEnumsGets a collection of enumerations for the object.
Public propertyExtenderReturns the requested Extender object if it is available for this object.
Public propertyExtenderCATIDGets the Extender category ID (CATID) for the object.
Public propertyExtenderNamesGets a list of available Extenders for the object.
Public propertyFileGets the file associated with this VCCodeUnion.
Public propertyFullNameGets the full path and name of the object's file.
Public propertyFunctionsGets a collection of functions for the object.
Public propertyInfoLocationGets the capabilities of the code model.
Public propertyIsCaseSensitiveGets if a code element is case-sensitive.
Public propertyIsCodeTypeGets a value indicating whether a CodeType object can be obtained from this object.
Public propertyIsDerivedFromGets a value indicating whether an object has another object as a base.
Public propertyIsInjectedGets whether a code element has been injected by an attribute.
Public propertyIsReadOnlyGets whether the file containing the object is read-only.
Public propertyIsTemplateGets whether the object is a template.
Public propertyIsZombieGets whether the object exists.
Public propertyKindGets an enumeration indicating the type of object.
Public propertyLanguageGets the programming language used to author the code.
Public propertyLocationReturns the location of the object declaration.
Public propertyMembersGets a collection of items contained by this element.
Public propertyNameGets or sets the name of the object.
Public propertyNamespaceGets an object defining the namespace.
Public propertyParentGets the immediate parent object of a given object.
Public propertyPictureGets a picture automation object to be used as an icon in the user interface.
Public propertyProjectGets the Project associated with the object.
Public propertyProjectItemGets the ProjectItem associated with the given object.
Public propertyReferencesNot currently implemented.
Public propertyStartPointGets a TextPoint object that defines the beginning of the code item.
Public propertyStartPointOfGets the start point of the object.
Public propertyStructsGets the collection of structure elements for the object.
Public propertyTemplateParametersGets a collection of template parameters.
Public propertyTemplatizationsInfrastructure. Microsoft internal use only.
Public propertyTypedefsGets the collection of typedef elements for the object.
Public propertyUnionsGets the collection of union elements for the object.
Public propertyUsingAliases
Public propertyVariablesGets the collection of variables.
Top

  NameDescription
Public methodAddAttributeCreates a new attribute code construct and inserts the code in the correct location.
Public methodAddBaseAdds an item to the list of inherited objects.
Public methodAddClassCreates a new class code construct and inserts the code in the correct location.
Public methodAddEnumCreates a new enumeration code construct and inserts the code in the correct location.
Public methodAddFunctionCreates a new function code construct and inserts the code in the correct location.
Public methodAddStructCreates a new structure code construct and inserts the code in the correct location.
Public methodAddTemplateParameterAdds a parameter to a template definition.
Public methodAddTypedefAdds a typedef statement to the object.
Public methodAddUnionAdds a union statement to the object.
Public methodAddUsingAlias
Public methodAddVariableCreates a new variable code construct and inserts the code in the correct location.
Public methodGetEndPointGets a TextPoint object that marks the end of the code element definition.
Public methodGetStartPointGets a TextPoint object that defines the beginning of the code element definition.
Public methodIsSelfDetermines if the specified code element is the same as the code element.
Public methodRemoveBaseRemoves an object from the list of bases.
Public methodRemoveMemberRemoves a member code construct.
Public methodRemoveTemplateParameterRemoves a parameter from a template definition.
Public methodValidateMemberValidates that the proposed name is a valid C++ name for the kind given in the context of the parent object.
Public methodValidateMemberName
Top

The VCCodeUnion object is used to modify an existing union construct.

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 name of each union code element in the current solution. It assumes a C++ project is open and that it has global unions.

Sub GetAllUnions()
    Dim vcCM As VCCodeModel
    Dim vcUnion As VCCodeUnions
    vcCM = DTE.Solution.Item(1).CodeModel
    For Each vcUnion in vcCM.Unions
        MsgBox(vcUnion.DisplayName)
    Next
End Sub
Show:
© 2014 Microsoft