XamlReader Class

.NET Framework (current version)
 

Provides base definitions for classes that consume XAML input and produce XAML node streams.

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


public abstract class XamlReader : IDisposable

NameDescription
System_CAPS_protmethodXamlReader()

Initializes the XamlReader class.

NameDescription
System_CAPS_protpropertyIsDisposed

Gets whether Dispose has been called.

System_CAPS_pubpropertyIsEof

When implemented in a derived class, gets a value that reports whether the reader position is at end-of-file.

System_CAPS_pubpropertyMember

When implemented in a derived class, gets the current member at the reader position, if the reader position is on a StartMember.

System_CAPS_pubpropertyNamespace

When implemented in a derived class, gets the XAML namespace information from the current node.

System_CAPS_pubpropertyNodeType

When implemented in a derived class, gets the type of the current node.

System_CAPS_pubpropertySchemaContext

When implemented in a derived class, gets an object that provides XAML schema context information for the information set.

System_CAPS_pubpropertyType

When implemented in a derived class, gets the XamlType of the current node.

System_CAPS_pubpropertyValue

When implemented in a derived class, gets the value of the current node.

NameDescription
System_CAPS_pubmethodClose()

Closes the XAML node stream.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the XamlReader, and optionally, releases the managed resources.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRead()

When implemented in a derived class, provides the next XAML node from the source, if a node is available.

System_CAPS_pubmethodReadSubtree()

Returns a XamlReader that is based on the current XamlReader, where the returned XamlReader is used to iterate through a subtree of the XAML node structure.

System_CAPS_pubmethodSkip()

Skips the current node and advances the reader position to the next node.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable.Dispose()

This API supports the product infrastructure and is not intended to be used directly from your code. Releases all resources used by the current instance of the XamlReader class.

XamlReader is an abstract class and does not provide implementations or definitions that have a working result for all members. Members that do have an implementation in XamlReader are noted in the remarks for that member. Specifically, XamlReader has several abstract members that must be implemented, and several virtual members.

Of the virtual members, ReadSubtree and Skip each provide a default implementation that is appropriate for most cases. However, the ReadSubtree and Skip default implementations rely on other expected behavior of the implementing XAML reader; in particular, they rely on the Read override. Dispose is also a virtual member that has a working default implementation.

The following two classes are the most relevant and practical derived classes in .NET Framework XAML Services and the System.Xaml assembly:

  • XamlObjectReader, which reads an object graph, such as the active object graph of an application at run time.

  • XamlXmlReader, which reads XAML in the form of a XML text file by using a general XmlReader that loads the file as an intermediary helper class.

Other XAML readers from other frameworks include Baml2006Reader and XamlDebuggerXmlReader.

XamlReader differs from XML Document Object Model (DOM) and XmlReader design principles because XamlReader does not have a Create method to return underlying default XAML reader implementations. You must instead instantiate specific derived XAML reader classes by calling their constructors or other class-specific helper APIs.

For the most part, you call XamlReader API in the context of specific XAML reader classes that derive from XamlReader. However, in one particular case, you access XamlReader API on a practical XAML reader instance that is not public and not derived from XamlObjectReader or XamlXmlReader. This case is when you call ReadSubtree, which returns a XamlReader instance. In the default implementation, the XamlReader that is returned by this API is an internal class.

The XamlReader obtained for subtree reading has valid actions for APIs such as Read and NodeType, and those actions are based on the parent reader class. This design enables the internal class to track the frame level where the subtree was entered. The acting subtree XamlReader makes sure that if the current node position is moved beyond the bounds of the subtree, the specific subtree reader reports end-of-file or null at the current node.

Notes about subtree reader usage are included on certain XamlReader APIs.

.NET Framework
Available since 4.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: