CodeModel.IsValidID(String) Method

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns whether a specified name is a valid programmatic identifier for the current language.

public:
 bool IsValidID(System::String ^ Name);

public:
 bool IsValidID(Platform::String ^ Name);

bool IsValidID(std::wstring const & Name);

[System.Runtime.InteropServices.DispId(16)]
public bool IsValidID (string Name);

[<System.Runtime.InteropServices.DispId(16)>]
abstract member IsValidID : string -> bool

Public Function IsValidID (Name As String) As Boolean

Parameters

Name: String

Required. The name of the identifier to check.

Returns

Boolean

A Boolean value indicating True when the identifier is valid; False when it is not, such as when it is a keyword.

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

Attributes: DispIdAttribute

Examples

Sub IsValidIDExample(ByVal dte As DTE2)  

    ' Before running this example, open a project.  
    Dim idents() As String = {"Sub", "class", "void", "var"}  

    Dim name, results As String  
    Dim proj As Project  
    For Each proj In dte.Solution  
        results &= "In " & proj.Name & ":" & vbCrLf & vbCrLf  

        ' Validate the names in idents.  
        For Each name In idents  
            If proj.CodeModel.IsValidID(name) Then  
                results &= """" & name & """ is a valid identifier." _  
                    & vbCrLf  
            Else  
                results &= """" & name & _  
                    """ is not a valid identifier." & vbCrLf  
            End If  
        Next  

        results &= vbCrLf & vbCrLf  
    Next  

    MsgBox(results)  

End Sub

public void IsValidIDExample(DTE2 dte)  
{  
    // Before running this example, open a project.  
    string[] idents = {"Sub", "class", "void", "var"};  

    string results = "";  
    foreach (Project proj in dte.Solution)  
    {  
        results += "In " + proj.Name + ":" + Environment.NewLine +   
            Environment.NewLine;  

        // Validate the names in idents.  
        foreach (string name in idents)  
        {  
            if (proj.CodeModel.IsValidID(name))  
                results += "\"" + name + "\" is a valid identifier." +   
                    Environment.NewLine;  
            else  
                results += "\"" + name +   
                    "\" is not a valid identifier." +   
                    Environment.NewLine;  
        }  

        results += Environment.NewLine + Environment.NewLine;  
    }  

    MessageBox.Show(results);  
}

Applies to

Compartilhar via