CodeModel.IsValidID Method
Returns whether a specified name is a valid programmatic identifier for the current language.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
Function IsValidID ( _
Name As String _
) As Boolean
bool IsValidID(
string Name
)
bool IsValidID(
String^ Name
)
abstract IsValidID :
Name:string -> bool
function IsValidID(
Name : String
) : boolean
Parameters
Name
Type: System.StringRequired. The name of the identifier to check.
Return Value
Type: System.Boolean
A Boolean value indicating True when the identifier is valid; False when it is not, such as when it is a keyword.
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).
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);
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
See Also
Reference
Other Resources
How to: Compile and Run the Automation Object Model Code Examples