| Northwoods.Go.Xml Assembly > Northwoods.Go.Xml Namespace > GoXmlReader Class : ConsumeRootElement Method |
'Declaration Protected Overridable Function ConsumeRootElement() As Object
protected virtual object ConsumeRootElement()
The data structure representing the whole document body. If RootObject is non-null, it returns that. If the current element name is associated with a GoXmlBindingTransformer and that transformer's Prototype is a Northwoods.Go.GoDocument, this returns a copy of that Northwoods.Go.GoDocument. Otherwise this returns an empty List.
You could override this to return a particular collection or collection-like object, such as a GoDocument or a GoCollection. If you return a different kind of root object, you may need to override ConsumeRootAttributes and ConsumeRootBody to handle initializing and adding new objects to your root object.
The RootObject property is set to the value of this method. All Consume methods will return this value, after having reset the RootObject property to null.
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2