• Article

XmlObjectSerializer.IsStartObject Method (XmlDictionaryReader)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets a value that specifies whether the XmlDictionaryReader is positioned over an XML element that can be read.

Namespace:  System.Runtime.Serialization
Assembly:  System.Runtime.Serialization (in System.Runtime.Serialization.dll)

Syntax

'Declaration
Public MustOverride Function IsStartObject ( _
    reader As XmlDictionaryReader _
) As Boolean

public abstract bool IsStartObject(
    XmlDictionaryReader reader
)

Parameters

Return Value

Type: System.Boolean
true if the reader can read the data; otherwise, false.

Remarks

This method checks whether the reader is positioned on an element to read, and returns true if the element is the top-level element for the object found in the XML stream or document. The XmlObjectSerializer implementation determines when to return true. Implementations may check that they are positioned on an element or look for an expected element name. One implementation of the XmlObjectSerializer, the DataContractSerializer, checks that it is positioned on an element and also checks that the element name is the top-level expected name for the type currently being deserialized.

If required, additional attributes in the XML stream can be read while positioned on the top level element before reading XML content using the ReadObject method.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.