Compartilhar via


CodeClass.AddProperty Method

Definition

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

EnvDTE::CodeProperty AddProperty(std::wstring const & GetterName, std::wstring const & PutterName, winrt::Windows::Foundation::IInspectable const & Type, winrt::Windows::Foundation::IInspectable const & Position, EnvDTE::vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault, winrt::Windows::Foundation::IInspectable const & Location);
[System.Runtime.InteropServices.DispId(66)]
public EnvDTE.CodeProperty AddProperty (string GetterName, string PutterName, object Type, object Position, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault, object Location);
[<System.Runtime.InteropServices.DispId(66)>]
abstract member AddProperty : string * string * obj * obj * EnvDTE.vsCMAccess * obj -> EnvDTE.CodeProperty
Public Function AddProperty (GetterName As String, PutterName As String, Type As Object, Optional Position As Object, Optional Access As vsCMAccess = EnvDTE.vsCMAccess.vsCMAccessDefault, Optional Location As Object) As CodeProperty

Parameters

GetterName
String

Required. The name of the function that gets the property's value.

PutterName
String

Required. The name of the function that sets the property.

Type
Object

Required. The type of property. This can be a CodeTypeRef object, a vsCMTypeRef value, or a fully qualified type name.

Position
Object

Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

If the value is a Long, then AddProperty(String, String, Object, Object, vsCMAccess, Object) 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
vsCMAccess

Optional. The access. A vsCMAccess constant value.

Location
Object

Optional. The location.

Returns

A CodeProperty object.

Attributes

Examples

 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  
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);  
    }  
}  

Remarks

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

Applies to