CodeClass2.AddProperty 方法

项目
05/17/2015

在类中创建新的属性构造。

命名空间： EnvDTE80
程序集： EnvDTE80（在 EnvDTE80.dll 中）

语法

声明
Function AddProperty ( _
    GetterName As String, _
    PutterName As String, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeProperty

CodeProperty AddProperty(
    string GetterName,
    string PutterName,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

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

abstract AddProperty : 
        GetterName:string * 
        PutterName:string * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeProperty

function AddProperty(
    GetterName : String, 
    PutterName : String, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeProperty

参数

GetterName
类型：String

必选。获取属性值的函数名。

PutterName
类型：String

必选。设置该属性的函数名。

Type
类型：Object

必选。属性的类型。它可以是 CodeTypeRef 对象、vsCMTypeRef 值或完全限定的类型名。

Position
类型：Object

可选。默认值 = 0。将在其后添加新元素的代码元素。

如果该值为 Long 数据类型，则 Position 方法指示在哪个元素后添加新元素。

因为集合从 1 开始计数，所以传递 0 指示应将新元素放置在集合的开始处。值为 -1 表示应将元素放在结尾处。

Access
类型：vsCMAccess

可选。一个指示访问类型的 vsCMAccess 常数值。

Location
类型：Object

可选。新函数的位置。

返回值

类型：CodeProperty
一个 CodeProperty 对象。

备注

本机 Visual C++ 要求其完全限定类型名使用以冒号 (::) 分隔的格式。所有其他语言都支持以句点分隔的格式。

参数正确与否由代码模型后面的语言决定。

备注

在进行某些类型的编辑之后，代码模型元素（如类、结构、函数、特性、委托等）的值可能是非确定性的，这意味着不能指望它们的值总是保持不变。有关更多信息，请参见使用代码模型查找代码 (Visual Basic) 中的“代码模型元素的值可能会更改”一节。

示例

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