Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

XmlConvert Class

Encodes and decodes XML names and provides methods for converting between common language runtime types. When converting data types the values returned are locale independent.

System.Object
  System.Xml.XmlConvert

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)
'Declaration
Public Class XmlConvert

The XmlConvert type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360XmlConvertInitializes a new instance of the XmlConvert class.
Top
  NameDescription
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360DecodeNameDecodes a name. This method does the reverse of the EncodeName and EncodeLocalName methods.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360EncodeLocalNameConverts the name to a valid XML local name.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360EncodeNameConverts the name to a valid XML name.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360EncodeNmTokenVerifies the name is valid according to the XML specification.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Equals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360GetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360IsNCNameCharChecks if the passed-in character is a valid Name Character type.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360IsPublicIdCharChecks if the passed in character is a valid PUBLIC ID character.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360IsStartNCNameCharChecks if the passed-in character is a valid Start Name Character type.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360IsWhitespaceCharChecks if the passed in character is a valid XML whitespace character.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360IsXmlCharChecks if the passed in character is a valid XML character.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360IsXmlSurrogatePairChecks if the passed in surrogate pair of characters is a valid XML character.
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToBooleanConverts the String to a Boolean equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToByteConverts the String to a Byte equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToCharConverts the String to a Char equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDateTime(String, String)Converts the String to a DateTime equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDateTime(String, String())Converts the String to a DateTime equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDateTime(String, XmlDateTimeSerializationMode)Converts the String to a DateTime using the XmlDateTimeSerializationMode specified
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDateTimeOffset(String)Converts the supplied String to a DateTimeOffset equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDateTimeOffset(String, String)Converts the supplied String to a DateTimeOffset equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDateTimeOffset(String, String())Converts the supplied String to a DateTimeOffset equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDecimalConverts the String to a Decimal equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDoubleConverts the String to a Double equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToGuidConverts the String to a Guid equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToInt16Converts the String to a Int16 equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToInt32Converts the String to a Int32 equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToInt64Converts the String to a Int64 equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToSByteConverts the String to a SByte equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToSingleConverts the String to a Single equivalent.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Boolean)Converts the Boolean to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Char)Converts the Char to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(DateTimeOffset)Converts the supplied DateTimeOffset to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Decimal)Converts the Decimal to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Double)Converts the Double to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Guid)Converts the Guid to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Int16)Converts the Int16 to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Int32)Converts the Int32 to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Int64)Converts the Int64 to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(SByte)Converts the SByte to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(Single)Converts the Single to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(TimeSpan)Converts the TimeSpan to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(UInt32)Converts the UInt32 to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(UInt64)Converts the UInt64 to a String.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(DateTime, XmlDateTimeSerializationMode)Converts the DateTime to a String using the XmlDateTimeSerializationMode specified.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToString(DateTimeOffset, String)Converts the supplied DateTimeOffset to a String in the specified format.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToTimeSpanConverts the String to a TimeSpan equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToUInt16Converts the String to a UInt16 equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToUInt32Converts the String to a UInt32 equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360ToUInt64Converts the String to a UInt64 equivalent.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360VerifyNameVerifies that the name is a valid name according to the W3C Extended Markup Language recommendation.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360VerifyNCNameVerifies that the name is a valid NCName according to the W3C Extended Markup Language recommendation.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360VerifyNMTOKENVerifies that the string is a valid NMTOKEN according to the W3C XML Schema Part2: Datatypes recommendation
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360VerifyPublicIdVerifies whether all the character is in the string argument are valid PUBLIC ID characters.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360VerifyWhitespaceVerifies whether all the characters in the string argument are valid whitespace characters.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360VerifyXmlCharsVerifies if all the characters and surrogate pair characters in the passed in string are valid XML characters.
Top

Element and attribute names or ID values are limited to a range of XML characters according to the Extensible Markup Language (XML) 1.0 (Fourth Edition) recommendation, located at http://www.w3.org/TR/2006/REC-xml-20060816/. When names contain invalid characters, the EncodeName and DecodeName methods are used to translate them into valid XML names.

Many languages and applications such as Microsoft SQL Server and Microsoft Word, allow Unicode characters in their names, which are not valid in XML names. For example, if 'Order Detail' were a column heading in a database, the database allows the space between the words Order and Detail. However, in XML, the space between Order and Detail is considered an invalid XML character. Thus, the space, the invalid character, needs to be converted into an escaped hexadecimal encoding and can be decoded later.

The EncodeName method can be used with the XmlWriter class to ensure the names being written are valid XML names. The following C# code converts the name 'Order Detail' into a valid XML name and writes the element <Order_0x0020_Detail>My order</Order_0x0020_Detail>.

 writer.WriteElementString(XmlConvert.EncodeName("Order Detail"),"My order");

XmlConvert also provides methods that enable you to convert from a string to a.NET Framework data type and vice-versa. Locale settings are not taken into account during data conversion.


'Define the order data.  They will be converted to string 
'before being written out.
Dim custID As Int16 = 32632
Dim orderID As String = "367A54"
Dim orderDate As New DateTime()
orderDate = DateTime.Now
Dim price As Double = 19.95

Dim output As New StringBuilder()

'Create a writer that outputs to the console.
Dim writer As XmlWriter = XmlWriter.Create(output)

'Write an element (this one is the root)
writer.WriteStartElement("order")

'Write the order date.
writer.WriteAttributeString("date", XmlConvert.ToString(orderDate, "yyyy-MM-dd"))

'Write the order time.
writer.WriteAttributeString("time", XmlConvert.ToString(orderDate, "HH:mm:ss"))

'Write the order data.
writer.WriteElementString("orderID", orderID)
writer.WriteElementString("custID", XmlConvert.ToString(custID))
writer.WriteElementString("price", XmlConvert.ToString(price))

'Write the close tag for the root element
writer.WriteEndElement()

'Write the XML and close the writer
writer.Close()


' Display the output to the TextBlock control
OutputTextBlock.Text = output.ToString()


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.