XmlTextReader.BaseURI Property (System.Xml)

BaseURI Property

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

XmlTextReader..::.BaseURI Property

Gets the base URI of the current node.

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

Syntax

Visual Basic (Declaration)

Public Overrides ReadOnly Property BaseURI As String

Visual Basic (Usage)

Dim instance As XmlTextReader
Dim value As String

value = instance.BaseURI

public override string BaseURI { get; }

Visual C++

public:
virtual property String^ BaseURI {
    String^ get () override;
}

JScript

public override function get BaseURI () : String

Property Value

Type: System..::.String
The base URI of the current node.

Remarks

Note:
In the .NET Framework version 2.0 release, the recommended practice is to create XmlReader instances using the XmlReader..::.Create method. This allows you to take full advantage of the new features introduced in this release. For more information, see Creating XML Readers.

A networked XML document is comprised of chunks of data aggregated using various W3C standard inclusion mechanisms and therefore contains nodes that come from different places. DTD entities are an example of this, but this is not limited to DTDs. The base URI tells you where these nodes came from. If there is no base URI for the nodes being returned (for example, they were parsed from an in-memory string), String.Empty is returned.

Examples

The following example displays the base URI for each of the nodes.

Visual Basic

Option Explicit
Option Strict

Imports System
Imports System.IO
Imports System.Xml

Public Class Sample

   Public Shared Sub Main()
      Dim reader As XmlTextReader = Nothing

      Try
         'Load the reader with the XML file.
         reader = New XmlTextReader("http://localhost/baseuri.xml")

         'Parse the file and display the base URI for each node.
         While reader.Read()
            Console.WriteLine("({0}) {1}", reader.NodeType, reader.BaseURI)
         End While

      Finally
         If Not (reader Is Nothing) Then
            reader.Close()
         End If
      End Try
   End Sub 'Main ' End class
End Class 'Sample

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

public class Sample
{
  public static void Main()
  {
    XmlTextReader reader = null;

    try
    {           
        //Load the reader with the XML file.
        reader = new XmlTextReader("http://localhost/baseuri.xml");

        //Parse the file and display the base URI for each node.
        while (reader.Read())
        {
            Console.WriteLine("({0}) {1}", reader.NodeType, reader.BaseURI);
         }           
     }

     finally
     {
       if (reader!=null)
         reader.Close();
     }
  }
} // End class

Visual C++

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlTextReader^ reader = nullptr;
   try
   {

      //Load the reader with the XML file.
      reader = gcnew XmlTextReader( "http://localhost/baseuri.xml" );

      //Parse the file and display the base URI for each node.
      while ( reader->Read() )
      {
         Console::WriteLine( "({0}) {1}", reader->NodeType, reader->BaseURI );
      }
   }
   finally
   {
      if ( reader != nullptr )
            reader->Close();
   }

}

import System.*;
import System.IO.*;
import System.Xml.*;

public class Sample
{  
    public static void main(String[] args)
    {
        XmlTextReader reader = null;
        try {
            //Load the reader with the XML file.
            reader = new XmlTextReader("http://localhost/baseuri.xml");

            //Parse the file and display the base URI for each node.
            while(reader.Read()) {
                Console.WriteLine("({0}) {1}", reader.get_NodeType(),
                reader.get_BaseURI());
            }
        }
        finally {
            if ( reader != null ) {
                reader.Close();
            }
        }
    } //main
} // End class Sample

The example uses the file, baseuri.xml, as input.

<!-- XML fragment -->
<book genre="novel">
  <title>Pride And Prejudice</title>
</book>

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, 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

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