This topic has not yet been rated - Rate this topic

XmlElement.Prefix Property

.NET Framework 1.1

Gets or sets the namespace prefix of this node.

[Visual Basic]
Overrides Public Property Prefix As String
[C#]
public override string Prefix {get; set;}
[C++]
public: __property String* get_Prefix();
public: __property void set_Prefix(String*);
[JScript]
public override function get Prefix() : String;
public override function set Prefix(String);

Property Value

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

Exceptions

Exception Type	Condition
ArgumentException	This node is read-only
XmlException	The specified prefix contains an illegal character. The specified prefix is malformed. The namespaceURI of this node is a null reference (Nothing in Visual Basic). The specified prefix is "xml" and the namespaceURI of this node is different from http://www.w3.org/XML/1998/namespace .

Exception Type

Condition

ArgumentException

This node is read-only

XmlException

The specified prefix contains an illegal character.

The specified prefix is malformed.

The namespaceURI of this node is a null reference (Nothing in Visual Basic).

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

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.

Example

[Visual Basic, C#, C++] The following example displays information on the ISBN element.

[Visual Basic] 
Imports System
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

[C#] 
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);

  }
}

[C++] 
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;

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

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

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button in the upper-left corner of the page.

Requirements