CodeStruct2 Interface

Object representing a structure in source code.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
<GuidAttribute("F6DC1A01-E65A-404B-8B6D-9CDD603DB4ED")> _
Public Interface CodeStruct2 _
    Inherits CodeStruct
[GuidAttribute("F6DC1A01-E65A-404B-8B6D-9CDD603DB4ED")]
public interface CodeStruct2 : CodeStruct
[GuidAttribute(L"F6DC1A01-E65A-404B-8B6D-9CDD603DB4ED")]
public interface class CodeStruct2 : CodeStruct
[<GuidAttribute("F6DC1A01-E65A-404B-8B6D-9CDD603DB4ED")>]
type CodeStruct2 =  
    interface 
        interface CodeStruct 
    end
public interface CodeStruct2 extends CodeStruct

The CodeStruct2 type exposes the following members.

Properties

  Name Description
Public property Access Gets or sets the access attributes of this item.
Public property Attributes Gets a collection of CodeElements.
Public property Bases Gets a collection of classes from which this CodeStruct derives.
Public property Children Gets a collection of CodeElements.
Public property Collection Gets a CodeElements collection.
Public property Comment Gets or sets the comment associated with the CodeStruct.
Public property DataTypeKind Sets of gets the relationship of this struct with other structs.
Public property DerivedTypes Gets a collection of objects derived from this CodeStruct. Not implemented in Visual C#.
Public property DocComment Gets or sets the document comment for the current CodeStruct.
Public property DTE Gets the top-level extensibility object.
Public property EndPoint Gets the edit point that is the location of the end of the code item.
Public property Extender Gets the requested Extender object if it is available for this object. Not implemented in Visual C#.
Public property ExtenderCATID Gets the Extender category ID (CATID) for the object. Not implemented in Visual C#.
Public property ExtenderNames Gets a list of available Extenders for the object. Not implemented in Visual C#.
Public property FullName Gets the full path and name of the object's file.
Public property ImplementedInterfaces Gets a collection of interfaces implemented by this CodeStruct.
Public property InfoLocation Gets the capabilities of the code model.
Public property IsAbstract Gets or sets a value indicating whether or not an item is declared as abstract.
Public property IsCodeType Gets a value indicating whether a CodeType object can be obtained from this object.
Public property IsDerivedFrom Gets a value indicating whether a CodeStruct has another object as a base.
Public property IsGeneric Gets a value indicating whether the current class or struct is a generic.
Public property Kind Gets an enumeration indicating the type of object.
Public property Language Gets the programming language used to author the code.
Public property Members Gets a collection of CodeElements contained by this CodeStruct.
Public property Name Gets or sets the name of the CodeStruct.
Public property Namespace Gets the CodeNamespace object defining the parent namespace.
Public property Parent Gets the immediate parent object of a CodeStruct object.
Public property Parts Gets partial classes associated with a struct.
Public property ProjectItem Gets the ProjectItem object associated with the CodeStruct object.
Public property StartPoint Gets a TextPoint object that defines the beginning of the code item.

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute code construct and inserts the code in the correct location.
Public method AddBase Adds an item to the list of inherited objects.
Public method AddClass Creates a new class code construct and inserts the code in the correct location.
Public method AddDelegate Creates a new delegate code construct and inserts the code in the correct location.
Public method AddEnum Creates a new enumeration code construct and inserts the code in the correct location.
Public method AddEvent Adds a struct event.
Public method AddFunction Creates a new function code construct and inserts the code in the correct location.
Public method AddImplementedInterface Adds an interface to the list of inherited objects.
Public method AddProperty Creates a new property code construct and inserts the code in the correct location.
Public method AddStruct Creates a new structure code construct and inserts the code in the correct location.
Public method AddVariable Creates a new variable code construct and inserts the code in the correct location.
Public method GetEndPoint Gets a TextPoint object that marks the end of the code element definition.
Public method GetStartPoint Gets a TextPoint object that defines the beginning of the code element definition.
Public method RemoveBase Removes an object from the list of bases.
Public method RemoveInterface Removes an interface from the list of implemented interfaces.
Public method RemoveMember Removes a member code construct.

Top

Remarks

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

See Also

Reference

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)