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

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

System_CAPS_pubpropertyChildren

Gets a collection of objects contained within this code construct.

System_CAPS_pubpropertyClasses

Gets a collection of classes for the 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 code element.

System_CAPS_pubpropertyDeclarationText

Gets or sets the declaration of the object.

System_CAPS_pubpropertyDerivedTypes

Gets a collection of objects derived from this object.

System_CAPS_pubpropertyDisplayName

Gets the formatted name to be displayed to users.

System_CAPS_pubpropertyDocComment

Sets or gets 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 object.

System_CAPS_pubpropertyEnums

Gets a collection of enumerations for the object.

System_CAPS_pubpropertyExtender[String]

Returns 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 associated with this VCCodeUnion.

System_CAPS_pubpropertyFullName

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

System_CAPS_pubpropertyFunctions

Gets a collection of functions for the object.

System_CAPS_pubpropertyInfoLocation

Gets the capabilities of the code model.

System_CAPS_pubpropertyIsCaseSensitive

Gets if 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 whether a code element has been injected by an attribute.

System_CAPS_pubpropertyIsReadOnly

Gets whether the file containing the object is read-only.

System_CAPS_pubpropertyIsTemplate

Gets whether the object is a template.

System_CAPS_pubpropertyIsZombie

Gets 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]

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

System_CAPS_pubpropertyStructs

Gets the collection of structure elements for the object.

System_CAPS_pubpropertyTemplateParameters

Gets a collection of template parameters.

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 typedef elements for the object.

System_CAPS_pubpropertyUnions

Gets the collection of union elements for the object.

System_CAPS_pubpropertyUsingAliases

System_CAPS_pubpropertyVariables

Gets the collection of variables.

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_pubmethodAddEnum(String, Object, Object, vsCMAccess)

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

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

System_CAPS_pubmethodAddUnion(String, Object, vsCMAccess)

Adds a union statement to the 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)

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 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_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 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
Return to top
Show: