Version

IDataSourceDataProvider Interface Members

The following tables list the members exposed by IDataSourceDataProvider.

Public Properties
 NameDescription
 PropertyActualSchemaGets the resolved schema for the data provider. Represents which properties are available for the items.  
 PropertyDeferAutoRefreshGets or sets whether the auto refresh mechanism of the data provider is currently defered. The data provider will not react to most setting changes while this is set to true an will instead defer processing. Setting this value to false will queue a new refresh.  
 PropertyExecutionContextGets or sets the execution context that the data provider should synchronize asynchronous actions with, or use to defer delayed actions.  
 PropertyFilterExpressionsGets a collection to add filter expressions to. Changing the filter expressions in this collection will adjust the filter applied to the data provider.  
 PropertyGroupDescriptionsGets a collection to add grouping descriptions to. Changing the grouping descriptions in this collection will adjust the grouping applied to the data provider.  
 PropertyIsFilteringSupportedGets if filtering is supported on the data provider.  
 PropertyIsGroupingSupportedGets if grouping is supported on the data provider.  
 PropertyIsItemIndexLookupSupportedGets whether lookup of an index for a provided item is supported.  
 PropertyIsKeyIndexLookupSupportedGets whether lookup of an index for a provided primary key value is supported.  
 PropertyIsSortingSupportedGets if sorting is supported on the data provider.  
 PropertyNotifyUsingSourceIndexesGets whether, when manually notifying the data source of changes, one should use indexes relative to the actual source data, or relative to the view the data source is maintaining into the data.  
 PropertyPropertiesRequestedGets or sets a list of property references for the properties desired by the consumer of the data provider. If known, the data provider may take steps to request only those properties, or to ensure that those properties are included, rather than the default behavior for this type of data provider.  
 PropertySchemaIncludedPropertiesGets or sets what properties should be included when resolving the datasource schema. If null, all properties are included.  
 PropertySortDescriptionsGets a collection to add sort descriptions to. Changing the sort descriptions in this collection will adjust the sort applied to the data provider.  
 PropertySummaryDescriptionsGets a collection to add summary descriptions to. Changing the summary descriptions in this collection will adjust the summaries applied to the data provider.  
 PropertySummaryScopeGets or sets the scope which summaries are calculated for.  
 PropertyUpdateNotifierGets or sets an DataSource update notifier that the data provider should invoke methods on to indicate various changes have occurred.  
Public Methods
 NameDescription
 MethodAddItemAdds the item to the data.  
 MethodFlushAutoRefreshCalled to make sure a queued refresh of the data provider has been applied before continuing. Should only be needed if you are trying to synchronously examine the results of changing settings on the data provider. Note, for a virtual data provider, the data provider itself may be waiting for other synchronous requests to actualize data. This call will not wait for those, but will only make sure the appropriate requests are in flight from the settings changes  
 MethodGetItemValueGets a property value by name from an item.  
 MethodIndexOfItemCalled to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported.  
 MethodIndexOfKeyCalled to return the index for an primary key value contained in the data source, or -1, if the key can't be found, or this action isn't currently supported.  
 MethodQueueAutoRefreshCalled to manually queue a refresh of the data provider.  
 MethodRefreshCalled to synchronously refresh the data provider.  
 MethodRemoveItemRemoves the item from the data.  
 MethodResolveSchemaPropertyTypeResolve a property or property path to its value type.  
 MethodSetItemValueSets a property value by name for an item.  
Public Events
 NameDescription
 EventSchemaChangedIndicates when teh schema of the data provider has changed.  
See Also