IsValidID Method

CodeModel2.IsValidID Method (String)

 

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

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

bool IsValidID(
	string Name
)

Parameters

Name
Type: System.String

Required. The name of the identifier to check.

Return Value

Type: System.Boolean

A Boolean value that is true when the identifier is valid; false when it is not, such as if it is a keyword.

System_CAPS_noteNote

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.

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);
}
Return to top
Show:
© 2016 Microsoft