Export (0) Print
Expand All

XmlDataProvider Class

Enables declarative access to XML data for data binding.

Namespace:  System.Windows.Data
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

[LocalizabilityAttribute(LocalizationCategory.None, Readability = Readability.Unreadable)]
[ContentPropertyAttribute("XmlSerializer")]
public class XmlDataProvider : DataSourceProvider, 
	IUriContext
<XmlDataProvider>
  XmlSerializer
</XmlDataProvider>

The XmlDataProvider type exposes the following members.

  NameDescription
Public methodXmlDataProviderInitializes a new instance of the XmlDataProvider class.
Top

  NameDescription
Protected propertyBaseUri This type or member supports the WPF infrastructure and is not intended to be used directly from your code.
Public propertyDataGets the underlying data object. (Inherited from DataSourceProvider.)
Protected propertyDispatcherGets or sets the current Dispatcher object to the UI thread to use. (Inherited from DataSourceProvider.)
Public propertyDocumentGets or sets the XmlDocument to use as the binding source.
Public propertyErrorGets the error of the last query operation. (Inherited from DataSourceProvider.)
Public propertyIsAsynchronousGets or sets a value that indicates whether node collection creation will be performed in a worker thread or in the active context.
Public propertyIsInitialLoadEnabledGets or sets a value that indicates whether to prevent or delay the automatic loading of data. (Inherited from DataSourceProvider.)
Protected propertyIsRefreshDeferredGets a value that indicates whether there is an outstanding DeferRefresh in use. (Inherited from DataSourceProvider.)
Public propertySourceGets or sets the Uri of the XML data file to use as the binding source.
Public propertyXmlNamespaceManagerGets or sets the XmlNamespaceManager used to run XPath queries.
Public propertyXmlSerializerGets the inline XML content.
Public propertyXPathGets or sets the XPath query used to generate the data collection.
Top

  NameDescription
Protected methodBeginInitIndicates that initialization of this object is about to begin; no implicit Refresh occurs until the matched EndInit method is called. (Inherited from DataSourceProvider.)
Protected methodBeginQueryPrepares the loading of either the inline XML or the external XML file to produce a collection of XML nodes. (Overrides DataSourceProvider.BeginQuery().)
Public methodDeferRefreshEnters a defer cycle that you can use to change properties of the provider and delay automatic refresh. (Inherited from DataSourceProvider.)
Protected methodEndInitIndicates that the initialization of this element has completed; this causes a Refresh if no other DeferRefresh is outstanding. (Overrides DataSourceProvider.EndInit().)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitialLoadStarts the initial query to the underlying data model. The result is returned on the Data property. (Inherited from DataSourceProvider.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnPropertyChangedRaises the PropertyChanged event with the provided arguments. (Inherited from DataSourceProvider.)
Protected methodOnQueryFinished(Object)Derived classes call this method to indicate that a query has finished. (Inherited from DataSourceProvider.)
Protected methodOnQueryFinished(Object, Exception, DispatcherOperationCallback, Object)Derived classes call this method to indicate that a query has finished. (Inherited from DataSourceProvider.)
Public methodRefreshInitiates a refresh operation to the underlying data model. The result is returned on the Data property. (Inherited from DataSourceProvider.)
Public methodShouldSerializeSourceIndicates whether the Source property should be persisted.
Public methodShouldSerializeXmlSerializerIndicates whether the XmlSerializer property should be persisted.
Public methodShouldSerializeXPathIndicates whether the XPath property should be persisted.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventDataChangedOccurs when the Data property has a new value. (Inherited from DataSourceProvider.)
Protected eventPropertyChangedOccurs when a property value changes. (Inherited from DataSourceProvider.)
Top

  NameDescription
Explicit interface implemetationPrivate eventINotifyPropertyChanged.PropertyChangedOccurs when a property value changes. (Inherited from DataSourceProvider.)
Explicit interface implemetationPrivate methodISupportInitialize.BeginInitThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from DataSourceProvider.)
Explicit interface implemetationPrivate methodISupportInitialize.EndInitThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from DataSourceProvider.)
Explicit interface implemetationPrivate propertyIUriContext.BaseUriThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.
Top

Security noteSecurity Note

In a partial-trust sandbox, XmlDataProvider fails when it does not have permissions to access the given data. For more information about partial trust security, see WPF Partial Trust Security.

XmlDataProvider exposes the following ways to access XML data.

  • You can embed inline XML data using the XmlDataProvider class.

  • You can set the Source property to the Uri of an XML data file.

  • You can set the Document property to an XmlDocument.

XmlDataProvider performs a full refresh of all bindings when a XmlDocument.NodeChanged event occurs. There are no optimizations for specific nodes.

The XmlDataProvider.IsAsynchronous property is set to true by default, which means that the XmlDataProvider retrieves data and produces the collection of XML nodes asynchronously by default.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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