CodeStruct Interface
Object representing a structure in source code.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
<GuidAttribute("B1F42511-91CD-4D3A-8B25-A317D8032B24")> _
Public Interface CodeStruct
[GuidAttribute("B1F42511-91CD-4D3A-8B25-A317D8032B24")]
public interface CodeStruct
[GuidAttribute(L"B1F42511-91CD-4D3A-8B25-A317D8032B24")]
public interface class CodeStruct
[<GuidAttribute("B1F42511-91CD-4D3A-8B25-A317D8032B24")>]
type CodeStruct = interface end
public interface CodeStruct
The CodeStruct type exposes the following members.
Properties
Name | Description | |
---|---|---|
Access | Defines the access modifier of this item. | |
Attributes | Gets a collection of CodeElements. | |
Bases | Gets a collection of classes from which this CodeStruct derives. | |
Children | Gets a collection of CodeElements. | |
Collection | Gets a CodeElements collection. | |
Comment | Gets or sets the comment associated with the CodeStruct. | |
DerivedTypes | Gets a collection of objects derived from this CodeStruct. Not implemented in Visual C#. | |
DocComment | Gets or sets the document comment for the current CodeStruct. | |
DTE | Gets the top-level extensibility object. | |
EndPoint | Gets the edit point that is the location of the end of the code item. | |
Extender | Returns the requested Extender object if it is available for this object. Not implemented in Visual C#. | |
ExtenderCATID | Gets the Extender category ID (CATID) for the object. This property is not implemented in Visual C#. | |
ExtenderNames | Gets a list of available Extenders for the object. This property is not implemented in Visual C#. | |
FullName | Gets the full path and name of the object's file. | |
ImplementedInterfaces | Gets a collection of interfaces implemented by this CodeStruct. | |
InfoLocation | Gets the capabilities of the code model object.. | |
IsAbstract | Sets or gets whether or not an item is declared as abstract. | |
IsCodeType | Gets whether a CodeType object can be obtained from this object. | |
IsDerivedFrom | Returns whether a CodeStruct has another object as a base. | |
Kind | Gets an enumeration indicating the type of object. | |
Language | Gets the programming language used to author the code. | |
Members | Gets a collection of CodeElements contained by this CodeStruct. | |
Name | Sets or gets the name of the CodeStruct. | |
Namespace | Gets a CodeNamespace object defining the parent namespace. | |
Parent | Gets the immediate parent object of a CodeStruct object. | |
ProjectItem | Gets the ProjectItem object associated with the CodeStruct object. | |
StartPoint | Gets a TextPoint object that defines the beginning of the code item. |
Top
Methods
Name | Description | |
---|---|---|
AddAttribute | Creates a new attribute code construct and inserts the code in the correct location. | |
AddBase | Adds an item to the list of inherited objects. | |
AddClass | Creates a new class code construct and inserts the code in the correct location. | |
AddDelegate | Creates a new delegate code construct and inserts the code in the correct location. | |
AddEnum | Creates a new enumeration code construct and inserts the code in the correct location. | |
AddFunction | Creates a new function code construct and inserts the code in the correct location. | |
AddImplementedInterface | Adds an interface to the list of inherited objects. | |
AddProperty | Creates a new property code construct and inserts the code in the correct location. | |
AddStruct | Creates a new structure code construct and inserts the code in the correct location. | |
AddVariable | Creates a new variable code construct and inserts the code in the correct location. | |
GetEndPoint | Gets a TextPoint object that marks the end of the code element definition. | |
GetStartPoint | Gets a TextPoint object that defines the beginning of the code element definition. | |
RemoveBase | Removes an object from the list of bases. | |
RemoveInterface | Removes an interface from the list of implemented interfaces. | |
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
Other Resources
How to: Compile and Run the Automation Object Model Code Examples