CodeProperty2 Interface

Definition

An object defining a property construct in a source file.

public interface class CodeProperty2 : EnvDTE::CodeProperty
public interface class CodeProperty2 : EnvDTE::CodeProperty
__interface CodeProperty2 : EnvDTE::CodeProperty
[System.Runtime.InteropServices.Guid("33770C02-21B7-4224-A577-6877BDBA60EA")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface CodeProperty2 : EnvDTE.CodeProperty
[<System.Runtime.InteropServices.Guid("33770C02-21B7-4224-A577-6877BDBA60EA")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type CodeProperty2 = interface
    interface CodeProperty
Public Interface CodeProperty2
Implements CodeProperty
Attributes
Implements

Remarks

The CodeProperty2 object represents a property and determines how properties are defined in the various languages. For example, Visual Basic has two separate functions, one that gets a value and another that puts it. Together they form a property. In Visual C#, however, one declaration form declares a property and 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.

Properties

Access

Gets or sets the access attributes of this item.

Attributes

Gets a collection of all attributes for the parent object.

Children

Gets a collection of objects contained within this CodeProperty2 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 or sets 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[String]

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

Gets or sets an object defining the code to return a property.

InfoLocation

Gets the capabilities of the code model.

IsCodeType

Gets a value indicating whether a CodeType object can be obtained from this object.

IsDefault

Sets or gets whether this is the default property.

IsGeneric

Gets a value indicating whether or not the property is a generic.

IsShared

Gets or sets the shared status of the property.

Kind

Gets an enumeration indicating the type of object.

Language

Gets the programming language used to author the code.

Name

Gets or sets the name of the object.

OverrideKind

Gets or sets the override modifiers on a Property.

Parameters

Gets CodeParameter2 objects for any parameters to the property.

Parent

Gets the immediate parent object of a CodeProperty object.

Parent2

Gets the parent of the element.

ProjectItem

Gets the ProjectItem associated with the given object.

Prototype[Int32]

Returns a string holding the stub definition of this object.

ReadWrite

Returns whether the property is readable, writeable, or both.

Setter

Gets or sets an object defining the code to set a property.

StartPoint

Gets a TextPoint object that defines the beginning of the code item.

Type

Gets or sets an object representing the programmatic type.

Methods

AddAttribute(String, String, Object)

Creates a new attribute code construct and inserts the code in the correct location.

AddParameter(String, Object, Object)

Adds a parameter to a property definition.

GetEndPoint(vsCMPart)

Gets a TextPoint object that marks the end of the code element definition.

GetStartPoint(vsCMPart)

Gets a TextPoint object that defines the beginning of the code element definition.

RemoveParameter(Object)

Removes a parameter from the property's signature.

Applies to