CodeVariable.IsConstant Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets or sets whether or not the item is a constant.

public:
 property bool IsConstant { bool get(); void set(bool value); };

public:
 property bool IsConstant { bool get(); void set(bool value); };

[System.Runtime.InteropServices.DispId(37)]
public bool IsConstant { [System.Runtime.InteropServices.DispId(37)] get; [System.Runtime.InteropServices.DispId(37)] set; }

[<System.Runtime.InteropServices.DispId(37)>]
[<get: System.Runtime.InteropServices.DispId(37)>]
[<set: System.Runtime.InteropServices.DispId(37)>]
member this.IsConstant : bool with get, set

Public Property IsConstant As Boolean

Property Value

Boolean

A Boolean value indicating true if the item is a constant; false otherwise.

Attributes

DispIdAttribute

Examples

Sub IsConstantExample(ByVal dte As DTE2)  

    ' Before running this example, open a code document from a project  
    ' and place the insertion point inside a variable definition.  
    Try  
        ' Retrieve the CodeVariable at the insertion point.  
        Dim sel As TextSelection = _  
            CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim var As CodeVariable = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementVariable), CodeVariable)  

        ' Display whether the variable is a constant.  
        If var.IsConstant Then  
            MsgBox(var.Name & " is a constant.")  
        Else  
            MsgBox(var.Name & " is not a constant.")  
        End If  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  

End Sub  

public void IsConstantExample(DTE2 dte)  
{  
    // Before running this example, open a code document from a project  
    // and place the insertion point inside a variable definition.  
    try  
    {  
        // Retrieve the CodeVariable at the insertion point.  
        TextSelection sel =   
            (TextSelection)dte.ActiveDocument.Selection;  
        CodeVariable var =   
            (CodeVariable)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementVariable);  

        // Display whether the variable is a constant.  
        if (var.IsConstant)  
            MessageBox.Show(var.Name + " is a constant.");  
        else  
            MessageBox.Show(var.Name + " is not a constant.");  
            }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

Remarks

IsConstant returns whether or not the storage location represented by this code variable can be set.

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