XmlConvert.VerifyName Method

Verifies that the name is a valid name according to the W3C Extended Markup Language recommendation.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

public static string VerifyName(
	string name
)

Parameters

name
Type: System.String

The name to verify.

Return Value

Type: System.String
The name, if it is a valid XML name.

ExceptionCondition
XmlException

name is not a valid XML name.

ArgumentNullException

name is null or String.Empty.

This method can be used with the XmlWriter class in the following manner.

 try{
   writer.WriteStartElement(XmlConvert.VerifyName("item"),"bar");
 }
 catch(Exception e)
 {
   Console.WriteLine("error");
 }

The following example uses the VerifyName method to write an element name.

using System;
using System.Xml;

public class Sample{

  public static void Main(){
     XmlTextWriter writer = new XmlTextWriter ("out.xml", null);
     string tag = "item name";

  try{
	
     // Write the root element.
     writer.WriteStartElement("root");

     writer.WriteStartElement(XmlConvert.VerifyName(tag));

     }
     catch (XmlException e){
        Console.WriteLine(e.Message);
        Console.WriteLine("Convert to a valid name...");
        writer.WriteStartElement(XmlConvert.EncodeName(tag));
     }

     writer.WriteString("hammer");
     writer.WriteEndElement();

     // Write the end tag for the root element.
     writer.WriteEndElement();

     writer.Close();

  }

}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft