CodeFunction Interface
An object defining a function construct in a source file.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
<GuidAttribute("0CFBC2B9-0D4E-11D3-8997-00C04F688DDE")> _
Public Interface CodeFunction
[GuidAttribute("0CFBC2B9-0D4E-11D3-8997-00C04F688DDE")]
public interface CodeFunction
[GuidAttribute(L"0CFBC2B9-0D4E-11D3-8997-00C04F688DDE")]
public interface class CodeFunction
[<GuidAttribute("0CFBC2B9-0D4E-11D3-8997-00C04F688DDE")>]
type CodeFunction = interface end
public interface CodeFunction
The CodeFunction 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 attributes for the CodeFunction object. |
|
CanOverride | Sets or gets whether or not the function can be overridden. |
|
Children | Gets a collection of objects contained within this code construct. |
|
Collection | Gets the collection containing the CodeFunction object supporting this property. |
|
Comment | Gets or sets the comment associated with the code element. |
|
DocComment | Gets or sets the document comment for the current code model element. |
|
DTE | Gets the top-level extensibility object. |
|
EndPoint | Gets the text 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. |
|
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. |
|
FunctionKind | Gets an enumeration describing how a function is used. |
|
InfoLocation | Gets the capabilities of the code model object.. |
|
IsCodeType | Returns whether a CodeType object can be obtained from this object. |
|
IsOverloaded | Gets whether or not a function is overloaded. |
|
IsShared | Sets or gets whether or not the item is statically defined, that is, whether the item is common to all instances of this object type or only to this object specifically. |
|
Kind | Returns an enumeration indicating the type of object. |
|
Language | Returns the programming language used to author the code. |
|
MustImplement | Sets or gets whether or not the item is declared abstract and thus requires an implementation. |
|
Name | Sets or gets the name of the object. |
|
Overloads | Gets a collection of overloaded methods for this item. |
|
Parameters | Gets a collection of parameters for this item. |
|
Parent | Gets the immediate parent object of a CodeFunction object. |
|
ProjectItem | Gets the ProjectItem object associated with the CodeFunction object. |
|
Prototype | Returns a string holding the stub definition of this object. |
|
StartPoint | Gets 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. |
|
AddParameter | Creates a new parameter code construct and inserts the code in the correct location. |
|
GetEndPoint | Returns a TextPoint object that marks the end of the code element definition. |
|
GetStartPoint | Returns a TextPoint object that defines the beginning of the code element definition. |
|
RemoveParameter | Removes a parameter from the argument list. |
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