CodeDomProvider.IsValidIdentifier(String) Method

Definition

Namespace:

System.CodeDom.Compiler

Assembly:

System.CodeDom.dll

Package:

System.CodeDom v9.0.0-rc.2.24473.5

Source:

CodeDomProvider.cs

Returns a value that indicates whether the specified value is a valid identifier for the current language.

public:
 virtual bool IsValidIdentifier(System::String ^ value);

public virtual bool IsValidIdentifier (string value);

abstract member IsValidIdentifier : string -> bool
override this.IsValidIdentifier : string -> bool

Public Overridable Function IsValidIdentifier (value As String) As Boolean

Parameters

value

String

The value to verify as a valid identifier.

Returns

Boolean

true if the value parameter is a valid identifier; otherwise, false.

Exceptions

NotImplementedException

Neither this method nor the CreateGenerator() method is overridden in a derived class.

Remarks

This method tests whether an identifier is valid. The IsValidIdentifier method is provider specific. Identifiers that are valid for one provider might not be valid for other providers. If value contains characters outside of the ASCII character range, check the identifier for all the languages that might be used to compile the code.

Note

In the .NET Framework versions 1.0 and 1.1, this method is provided by the ICodeGenerator implementation that is returned by the CreateGenerator method of the provider. In version 2.0, this method can be called directly on the code provider even if it is not overridden by the code provider. If the code provider does not override this method, the ICodeGenerator implementation is called by the base class.

Notes to Inheritors

When overriding IsValidIdentifier(String) in a derived class, design the method to return true only if the value fits the rules of the language and does not conflict with a keyword.

If you override this method, you must not call the corresponding method of the base class. The base-class method creates a generator in the derived class using the obsolete CreateGenerator() method for compatibility with preexisting providers that use code generators. The base-class method then calls the equivalent method in the ICodeGenerator implementation to perform this function. You will get a NotImplementedException if you call the base-class method from a code provider that does not use a code generator.