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
Public property Access Sets or gets the access modifier of this item.
Public property Attributes Gets a collection of all attributes for the CodeFunction object.
Public property CanOverride Sets or gets whether or not the function can be overridden.
Public property Children Gets a collection of objects contained within this code construct.
Public property Collection Gets the collection containing the CodeFunction object supporting this property.
Public property Comment Gets or sets the comment associated with the code element.
Public property DocComment Gets or sets the document comment for the current code model element.
Public property DTE Gets the top-level extensibility object.
Public property EndPoint Gets the text point that is the location of the end of the code item.
Public property Extender Returns the requested Extender object if it is available for this object.
Public property ExtenderCATID Gets the Extender category ID (CATID) for the object.
Public property ExtenderNames Gets a list of available Extenders for the object.
Public property FullName Gets the full path and name of the object's file.
Public property FunctionKind Gets an enumeration describing how a function is used.
Public property InfoLocation Gets the capabilities of the code model object..
Public property IsCodeType Returns whether a CodeType object can be obtained from this object.
Public property IsOverloaded Gets whether or not a function is overloaded.
Public property 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.
Public property Kind Returns an enumeration indicating the type of object.
Public property Language Returns the programming language used to author the code.
Public property MustImplement Sets or gets whether or not the item is declared abstract and thus requires an implementation.
Public property Name Sets or gets the name of the object.
Public property Overloads Gets a collection of overloaded methods for this item.
Public property Parameters Gets a collection of parameters for this item.
Public property Parent Gets the immediate parent object of a CodeFunction object.
Public property ProjectItem Gets the ProjectItem object associated with the CodeFunction object.
Public property Prototype Returns a string holding the stub definition of this object.
Public property StartPoint Gets a TextPoint object that defines the beginning of the code item.
Public property Type Sets or gets an object representing the programmatic type.

Top

Methods

  Name Description
Public method AddAttribute Creates a new attribute code construct and inserts the code in the correct location.
Public method AddParameter Creates a new parameter code construct and inserts the code in the correct location.
Public method GetEndPoint Returns a TextPoint object that marks the end of the code element definition.
Public method GetStartPoint Returns a TextPoint object that defines the beginning of the code element definition.
Public method 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

EnvDTE 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#)