XmlWriter.WriteQualifiedName Method (System.Xml)

Switch View

WriteQualifiedName Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

XmlWriter..::.WriteQualifiedName Method

When overridden in a derived class, writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.

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

Syntax

Visual Basic (Declaration)

Public Overridable Sub WriteQualifiedName ( _
    localName As String, _
    ns As String _
)

Visual Basic (Usage)

Dim instance As XmlWriter
Dim localName As String
Dim ns As String

instance.WriteQualifiedName(localName, _
    ns)

public virtual void WriteQualifiedName(
    string localName,
    string ns
)

Visual C++

public:
virtual void WriteQualifiedName(
    String^ localName, 
    String^ ns
)

JScript

public function WriteQualifiedName(
    localName : String, 
    ns : String
)

Parameters

localName: Type: System..::.String
The local name to write.

ns: Type: System..::.String
The namespace URI for the name.

Exceptions

Exception	Condition
ArgumentException	localName is either nullNothingnullptra null reference (Nothing in Visual Basic) or String.Empty. localName is not a valid name.

Exception

Condition

ArgumentException

localName is either nullNothingnullptra null reference (Nothing in Visual Basic) or String.Empty.

localName is not a valid name.

Remarks

If ns maps to the current default namespace, no prefix is generated.

When writing attribute values, this method generates a prefix if ns is not found. When writing element content, it throws an exception if ns is not found.

Note:
If a class derived from the XmlWriter does not override this method localName is not checked to be a valid W3C XML name. In such case, before calling this method, the validity of the string can be checked by IsName method.

Examples

The example writes the following element:

<root xmlns:x="urn:abc">
  <item href="#x:test"/>
</root>

Visual Basic

Dim settings As New XmlWriterSettings()
settings.Indent = True
settings.OmitXmlDeclaration = True
Using writer As XmlWriter = XmlWriter.Create(Console.Out, settings)
  writer.WriteStartElement("root")
  writer.WriteAttributeString("xmlns", "x", Nothing, "urn:abc")
  writer.WriteStartElement("item")
  writer.WriteStartAttribute("href", Nothing)
  writer.WriteString("#")
  writer.WriteQualifiedName("test", "urn:abc")
  writer.WriteEndAttribute()
  writer.WriteEndElement()
  writer.WriteEndElement()
End Using

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.OmitXmlDeclaration = true;
using (XmlWriter writer = XmlWriter.Create(Console.Out, settings))
{
    writer.WriteStartElement("root");
    writer.WriteAttributeString("xmlns", "x", null, "urn:abc");
    writer.WriteStartElement("item");
    writer.WriteStartAttribute("href", null);
    writer.WriteString("#");
    writer.WriteQualifiedName("test", "urn:abc");
    writer.WriteEndAttribute();
    writer.WriteEndElement();
    writer.WriteEndElement();
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

XmlWriter Class

XmlWriter Members

System.Xml Namespace

Other Resources

Writing XML with the XmlWriter