使用filecodemodel添加属性

本文关键字:属性 添加 filecodemodel 使用 | 更新日期: 2023-09-27 18:06:14

我正在尝试使用插件为类添加一些属性。我可以让下面的代码工作,除了我希望在新行中每个属性都包含在[]中。我该怎么做呢?

if (element2.Kind == vsCMElement.vsCMElementFunction)
{
    CodeFunction2 func = (CodeFunction2)element2;
    if (func.Access == vsCMAccess.vsCMAccessPublic)
    {
        func.AddAttribute("Name", "'"" + func.Name + "'"", 0);
        func.AddAttribute("Active", "'"" + "Yes" + "'"", 0);
        func.AddAttribute("Priority", "1", 0);
    }
}

属性被添加到公共方法中,如

[Name("TestMet"), Active("Yes"), Priority(1)]

Where I want it as

[Name("TestMet")]
[Active("Yes")]
[Priority(1)]
public void TestMet()
{}

我也可以添加一个属性没有任何值,像[PriMethod]。

使用filecodemodel添加属性

您正在使用的方法的签名:

CodeAttribute AddAttribute(
    string Name,
    string Value,
    Object Position
)
  1. 如果不需要属性值,则使用String.Empty字段作为第二个参数
  2. 第三个参数为Position。在您的代码中,您为0设置了三次这个参数,VS认为这是相同的属性。所以使用一些索引,比如:

func.AddAttribute("Name", "'"" + func.Name + "'"", 1);
func.AddAttribute("Active", "'"" + "Yes" + "'"", 2);
func.AddAttribute("Priority", "1", 3);

如果您不想使用索引,请使用-1 value -这将在集合结束时添加新属性。

关于MSDN的更多信息

基本的AddAttribute方法不支持这个,所以我写了一个扩展方法来为我做这个:

public static class Extensions
{
    public static void AddUniqueAttributeOnNewLine(this CodeFunction2 func, string name, string value)
    {
        bool found = false;
        // Loop through the existing elements and if the attribute they sent us already exists, then we will not re-add it.
        foreach (CodeAttribute2 attr in func.Attributes)
        {
            if (attr.Name == name)
            {
                found = true;
            }
        }
        if (!found)
        {
            // Get the starting location for the method, so we know where to insert the attributes
            var pt = func.GetStartPoint();
            EditPoint p = (func.DTE.ActiveDocument.Object("") as TextDocument).CreateEditPoint(pt);
            // Insert the attribute at the top of the function
            p.Insert(string.Format("[{0}({1})]'r'n", name, value));
            // Reformat the document, so the new attribute is properly aligned with the function, otherwise it will be at the beginning of the line.
            func.DTE.ExecuteCommand("Edit.FormatDocument");
        }
    }
}