CodeProperty Interface
An object defining a property construct in a source file.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
<GuidAttribute("0CFBC2BB-0D4E-11D3-8997-00C04F688DDE")> _
Public Interface CodeProperty
[GuidAttribute("0CFBC2BB-0D4E-11D3-8997-00C04F688DDE")]
public interface CodeProperty
[GuidAttribute(L"0CFBC2BB-0D4E-11D3-8997-00C04F688DDE")]
public interface class CodeProperty
[<GuidAttribute("0CFBC2BB-0D4E-11D3-8997-00C04F688DDE")>]
type CodeProperty = interface end
public interface CodeProperty
The CodeProperty type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Access | Sets or gets the access modifier of this item. |
|
Attributes | Gets a collection of all of the attributes for the parent object. |
|
Children | Gets a collection of objects contained within this CodeProperty object. |
|
Collection | Gets the collection containing the CodeProperty object supporting this property. |
|
Comment | Gets or sets the comment associated with the code element. |
|
DocComment | Gets the document comment for the current code model element. |
|
DTE | Gets the top-level extensibility object. |
|
EndPoint | Gets the edit point that is the location of the end of the code item. |
|
Extender | Gets the requested Extender if it is available for this object. |
|
ExtenderCATID | Gets the Extender category ID (CATID) for the object. |
|
ExtenderNames | Gets a list of available Extenders for the object. |
|
FullName | Gets the full path and name of the object's file. |
|
Getter | Sets or gets an object defining the code to return a property. |
|
InfoLocation | Gets the capabilities of the code model object. |
|
IsCodeType | Gets whether a CodeType object can be obtained from this object. |
|
Kind | Gets an enumeration indicating the type of object. |
|
Language | Gets the programming language used to author the code. |
|
Name | Sets or gets the name of the object. |
|
Parent | Gets the immediate parent object of a CodeProperty object. |
|
ProjectItem | Gets the ProjectItem associated with the given object. |
|
Prototype | Returns a string holding the stub definition of this object. |
|
Setter | Sets or gets an object defining the code to set a property. |
|
StartPoint | Returns a TextPoint object that defines the beginning of the code item. |
|
Type | Sets or gets an object representing the programmatic type. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AddAttribute | Creates a new attribute 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. |
Top
Remarks
The CodeProperty object represents a property and determines how properties are defined in the various languages. For example, in Visual Basic, if you have two separate functions, one for getting a value and one for putting it, together they form a property. In Visual C#, however, there is one declaration form for declaring a property and specifying whether it has a getter and a setter.
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