CodeDomProvider.CreateValidIdentifier(String) Method

Definition

Namespace:

System.CodeDom.Compiler

Assembly:

System.CodeDom.dll

Source:

CodeDomProvider.cs

Creates a valid identifier for the specified value.

public:
 virtual System::String ^ CreateValidIdentifier(System::String ^ value);

public virtual string CreateValidIdentifier (string value);

abstract member CreateValidIdentifier : string -> string
override this.CreateValidIdentifier : string -> string

Public Overridable Function CreateValidIdentifier (value As String) As String

Parameters

value

String

The string for which to generate a valid identifier.

Returns

String

A valid identifier for the specified value.

Exceptions

NotImplementedException

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

Remarks

CreateValidIdentifier tests whether the identifier conflicts with reserved or language keywords, and if so, attempts to return a valid identifier name that does not conflict. Usually the returned identifier is only slightly modified to differentiate the identifier from the keyword; for example, the name might be preceded by the underscore ("_") character.

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

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.