CodeEnum.AddMember 方法
创建新的成员代码构造,并将代码插入正确的位置。
命名空间: EnvDTE
程序集: EnvDTE(在 EnvDTE.dll 中)
语法
声明
Function AddMember ( _
Name As String, _
Value As Object, _
Position As Object _
) As CodeVariable
CodeVariable AddMember(
string Name,
Object Value,
Object Position
)
CodeVariable^ AddMember(
String^ Name,
Object^ Value,
Object^ Position
)
abstract AddMember :
Name:string *
Value:Object *
Position:Object -> CodeVariable
function AddMember(
Name : String,
Value : Object,
Position : Object
) : CodeVariable
参数
- Name
类型:System.String
必选。新成员的名称。
- Value
类型:System.Object
可选。返回的 CodeVariable 对象的 InitExpression。可作为字符串或作为表达式对象传入。
- Position
类型:System.Object
可选。默认值 = 0。将在其后添加新元素的代码元素。如果该值为 CodeElement,则紧跟在其后添加新元素。
如果该值为 Long 数据类型,则 AddMember 指示在哪个元素的后面添加新元素。
因为集合从 1 开始计数,所以传递 0 指示应将新元素放置在集合的开始处。值为 -1 表示应将元素放在结尾处。
返回值
类型:EnvDTE.CodeVariable
一个 CodeVariable 对象。
备注
AddMember 向枚举添加一个成员并返回一个 IsConstant 设置为 true 的 CodeVariable 对象。
将 Value设置为字符串时,如果该变量还没有初始化表达式,则 AddMember 插入所需的任何语法,如等号或分号。 根据语言以及在传入字符串上执行的语法或语义检查,设置此参数可能会失败。 不要求语言检查字符串,而且因为字符串必须是语言相关的,所以如果该字符串有任何错误格式的内容,则设置此参数可能导致未定义的行为。
将 Value 设置为 CodeElement 时,是否必须新建 CodeElement 取决于代码模型的语言实现。 如果传入的代码元素已经存在于源文件中,则一些语言可能实现复制语义。
参数正确与否由代码模型后面的语言决定。
备注
代码模型元素(如类、结构、功能、属性、委托)的值并不一定总是相同的。有关更多信息,请参见 使用代码模型查找代码 (Visual Basic) 中的“代码模型元素的值可能会更改”一节。
示例
Sub AddMemberExample(ByVal dte As DTE2)
' Before running this example, open a code document from a project
' and place the insertion point inside an enumeration.
Try
' Retrieve the CodeEnum at the insertion point.
Dim sel As TextSelection = _
CType(dte.ActiveDocument.Selection, TextSelection)
Dim enm As CodeEnum = _
CType(sel.ActivePoint.CodeElement( _
vsCMElement.vsCMElementEnum), CodeEnum)
' Add a member to the enumeration.
enm.AddMember("TestMember")
Catch ex As Exception
MsgBox(ex.Message)
End Try
End Sub
public void AddMemberExample(DTE2 dte)
{
// Before running this example, open a code document from a project
// and place the insertion point inside an enumeration.
try
{
// Retrieve the CodeEnum at the insertion point.
TextSelection sel =
(TextSelection)dte.ActiveDocument.Selection;
CodeEnum enm =
(CodeEnum)sel.ActivePoint.get_CodeElement(
vsCMElement.vsCMElementEnum);
// Add a member to the enumeration.
enm.AddMember("TestMember", null, -1);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
}
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。