Share via

CodeAttribute2.Value Property

  • Article

Sets or gets the data for the code attribute.

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

Syntax

'Declaration
Property Value As String

string Value { get; set; }

property String^ Value {
    String^ get ();
    void set (String^ value);
}

abstract Value : string with get, set

function get Value () : String 
function set Value (value : String)

Property Value

Type: System.String
A string value representing the data for the code attribute.

Remarks

If an attribute is in the form name(someval, 2), then the value is someval, 2.

Note

Code attribute argument values, after being assigned, are not retained in memory by Visual Studio, and thus, may or may not be valid when a future update to the code attribute argument occurs. That is, a subsequent argument access may return E_FAIL or a totally different value. (Anything that affects the element's children, however, does not have this problem.)

Because of this non-deterministic behavior, you should retrieve the argument's value prior to changing it. For example, if you set a code attribute argument in your code, such as myAttrArg.Value = """a first value""", then you should explicitly reference it before updating it, such as myAttrArg = myAttr.Arguments.Item("first value"), and then assign the new value, myAttrArg.Value = """a second value""". Doing this ensures that the correct argument is changed.

Also, 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

The following example creates a new namespace and attribute in the current class and lists some of the attribute's properties.

Sub ValueExample(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)

        ' Enumerate the CodeClass's attributes.
        Dim attrs As String = ""
        Dim attr As CodeAttribute
        For Each attr In cls.Attributes
            attrs &= attr.Name & "(" & attr.Value & ")" & vbCrLf
        Next

        MsgBox(cls.Name & " has the following attributes:" & _
            vbCrLf & vbCrLf & attrs)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void ValueExample(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);

        // Enumerate the CodeClass's attributes.
        string attrs = "";
        foreach (CodeAttribute attr in cls.Attributes)
        {
            attrs += attr.Name + "(" + attr.Value + ")" + 
                Environment.NewLine;
        }

        MessageBox.Show(cls.Name + " has the following attributes:" + 
            Environment.NewLine + Environment.NewLine + attrs);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

See Also

Reference

CodeAttribute2 Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)