CodeClass2::AddProperty Method (String^, String^, Object^, Object^, vsCMAccess, Object^)

Visual Studio 2015

Creates a new property construct in the class.

Namespace: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.dll)

Syntax

CodeProperty^ AddProperty(
	String^ GetterName,
	String^ PutterName,
	Object^ Type,
	Object^ Position,
	vsCMAccess Access = vsCMAccess::vsCMAccessDefault,
	Object^ Location
)

Parameters

GetterName: Type: System::String^
Required. The name of the function that gets the property's value.

PutterName: Type: System::String^
Required. The name of the function that sets the property.

Type: Type: System::Object^
Required. The type of property. This can be a CodeTypeRef object, a vsCMTypeRef value, or a fully qualified type name.

Position

Type: System::Object^

Optional. Default = 0. The code element after which to add the new element.

If the value is a Long data type, then the Position method indicates the element after which to add the new element.

Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Access: Type: EnvDTE::vsCMAccess
Optional. A vsCMAccess constant value indicating the access type.

Location: Type: System::Object^
Optional. Location of the new function.

Return Value

Type: EnvDTE::CodeProperty^

A CodeProperty object.

Implements

CodeClass::AddProperty(String^, String^, Object^, Object^, vsCMAccess, Object^)

Remarks

Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.

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).

Examples

[Visual Basic]

Sub AddPropertyExample(ByVal dte As DTE2)
    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a class definition.
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)

        ' Create a new member property.
        cls.AddProperty("TestProperty", "TestProperty", _
            vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

[C#]

public void AddPropertyExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Create a new member property.
        cls.AddProperty("TestProperty", "TestProperty", 
            vsCMTypeRef.vsCMTypeRefInt, -1, 
            vsCMAccess.vsCMAccessPublic, null);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}