XmlElement.Prefix Property

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlElement.cs

Gets or sets the namespace prefix of this node.

public:
 virtual property System::String ^ Prefix { System::String ^ get(); void set(System::String ^ value); };

public override string Prefix { get; set; }

member this.Prefix : string with get, set

Public Overrides Property Prefix As String

Property Value

String

The namespace prefix of this node. If there is no prefix, this property returns String.Empty.

Exceptions

ArgumentException

This node is read-only.

XmlException

The specified prefix contains an invalid character.

The specified prefix is malformed.

The namespaceURI of this node is null.

The specified prefix is "xml" and the namespaceURI of this node is different from http://www.w3.org/XML/1998/namespace.

Examples

The following example displays information on the ISBN element.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlDocument^ doc = gcnew XmlDocument;
   doc->LoadXml( "<book xmlns:bk='urn:samples'>"
   "<bk:ISBN>1-861001-57-5</bk:ISBN>"
   "<title>Pride And Prejudice</title>"
   "</book>" );
   
   // Display information on the ISBN element.
   XmlElement^ elem = dynamic_cast<XmlElement^>(doc->DocumentElement->FirstChild);
   Console::Write( "{0}:{1} = {2}", elem->Prefix, elem->LocalName, elem->InnerText );
   Console::WriteLine( "\t namespaceURI={0}", elem->NamespaceURI );
}

// This code produces the following output.
// bk:ISBN = 1-861001-57-5  namespaceURI=urn:samples

using System;
using System.IO;
using System.Xml;

public class Sample
{
  public static void Main()
  {

    XmlDocument doc = new XmlDocument();
    doc.LoadXml("<book xmlns:bk='urn:samples'>" +
                "<bk:ISBN>1-861001-57-5</bk:ISBN>" +
                "<title>Pride And Prejudice</title>" +
                "</book>");

    // Display information on the ISBN element.
    XmlElement elem = (XmlElement) doc.DocumentElement.FirstChild;
    Console.Write("{0}:{1} = {2}", elem.Prefix, elem.LocalName, elem.InnerText);
    Console.WriteLine("\t namespaceURI=" + elem.NamespaceURI);
  }
}

// This code produces the following output.
// bk:ISBN = 1-861001-57-5  namespaceURI=urn:samples

Imports System.IO
Imports System.Xml

public class Sample

  public shared sub Main()

    Dim doc as XmlDocument = new XmlDocument()
    doc.LoadXml("<book xmlns:bk='urn:samples'>" & _
                "<bk:ISBN>1-861001-57-5</bk:ISBN>" & _
                "<title>Pride And Prejudice</title>" & _
                "</book>")

    ' Display information on the ISBN element.
    Dim elem as XmlElement 
    elem = CType(doc.DocumentElement.ChildNodes.Item(0),XmlElement) 
    Console.Write("{0}:{1} = {2}", elem.Prefix, elem.LocalName, elem.InnerText)
    Console.WriteLine("  namespaceURI=" + elem.NamespaceURI)
  end sub
end class

' This code produces the following output.
' bk:ISBN = 1-861001-57-5  namespaceURI=urn:samples

Remarks

Setting this property changes the Name property, which holds the qualified name for an XmlElement. However, changing the prefix does not change the namespace URI of the element.