Version

VirtualDataSource Class Members

The following tables list the members exposed by VirtualDataSource.

Public Constructors
 NameDescription
Public ConstructorVirtualDataSource ConstructorInitializes a new VirtualDataSource.  
Public Properties
 NameDescription
Public PropertyActualCountGets the current actual full count of the items in the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyActualDataProviderGets the actual data provider being used with this data source.  
Public PropertyActualPageSizeGets the actual resolved page size that will be used.  
Public PropertyActualPrimaryKeyGets the current actual primary key of the data source. This may have been auto detected, if possible, or provided or overriden by the user. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyActualSchemaGets the resolved schema for the data source. Represents which properties are available for the items. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyDataProviderGets or sets the virtual data provider to use with this data source.  
Public PropertyDeferAutoRefreshGets or sets whether the auto refresh mechanism of the data source is currently defered. The data source 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. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyExecutionContextGets or sets the execution context that the data source should synchronize asynchronous actions with, or use to defer delayed actions. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyFilterExpressionsGets a collection to add filter expressions to. Changing the filter expressions in this collection will adjust the filter applied to the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyFirstVisibleIndexRequestedGets or sets which index consumers of the data source desire to be the current first visible index. A grid, for example, would indicate the current visible top row, and update this as that changes. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyGroupDescriptionsGets a collection to add group descriptions to. Changing the group descriptions in this collection will adjust the grouping applied to the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIncludeSummaryRowsInSection (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsFilteringSupportedGets if filtering is supported on the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsGroupingSupportedGets whether this datasource supports grouping. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsItemIndexLookupSupportedGets whether lookup of an index for a provided item is supported. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsKeyIndexLookupSupportedGets whether lookup of an index for a provided primary key value is supported. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsSectionCollapsableGets or sets if sections are collapsable. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsSectionContentVisibleGets or sets whether content besides the section headers are displayed. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsSectionExpandedDefaultGets or sets whether sections default to expanded or collapsed when they are created. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsSectionHeaderNormalRowGets or sets whether the section headers are treated as normal rows. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsSectionSummaryRowsAtBottom (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsSortingSupportedGets if sorting is supported on the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyIsVirtualGets if the current data source is a virtual data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyLastVisibleIndexRequestedGets or sets which index consumers of the data source desire to be the current last visible index. A grid, for example, would indicate the current visible top row, and update this as that changes. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyMaxCachedPagesGets or sets the maximum number of data pages to cache in the data source before the oldest pages will start being evicted.  
Public 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. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyPageSizeRequestedGets or sets the desired page size. This may or may not be respected by the underlying provider, or its connected services.  
Public PropertyPrimaryKeyGets or sets a list of property references that indicate the user provided primary key of the items in the data source. Consumers of the data source will often need to uniquely identify items in the data source. For this purpose a primary key should be specified. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyPropertiesRequestedGets or sets a list of property references for the properties desired by the consumer of the data source. If known, the data source 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 source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertySectionHeaderDisplayModeGets or sets how section headers are displayed. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyShouldEmitSectionFootersGets or sets whether this datasource should include section footers in its view of the data. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyShouldEmitSectionHeadersGets or sets whether this datasource should include section headers in its view of the data. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyShouldEmitShiftedRowsGets or sets whether this datasource should include shifted rows in its view of the data. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertySortDescriptionsGets a collection to add sort descriptions to. Changing the sort descriptions in this collection will adjust the sort applied to the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertySummaryDescriptionsGets a collection to add summary descriptions to. Changing the summary descriptions in this collection will adjust the summaries applied to the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertySummaryScopeGets or sets the scope which summaries are calculated for. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public PropertyUpdateNotifierGets or sets an IDataSourceUpdateNotifier that the data source should invoke methods on to indicate various changes have occurred. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public Methods
 NameDescription
Public MethodClearPinnedRows (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodCloneClones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodFlushAutoRefreshCalled to make sure a queued refresh of the data source has been applied before continuing. Should only be needed if you are trying to synchronously examine the results of changing settings on the data source. Note, for a virtual data source, the data source 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 (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetEnumeratorReturns an enumerator that can iterate through the items of this data source.  
Public MethodGetIsRowExpandedAtIndex (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetItemAtIndexReturns the item at the specific index in the data source. This index is based on the data source's current view of the data, not the actual underlying indexes of the original source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetItemPropertyExtracts the value of a named property for an item contained in the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetItemPropertyAtIndexExtracts a named property value from the item at a specified index. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetMainValuePath (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetRootSummaryResults (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetRootSummaryRowCount (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetRowLevel (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetRowType (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetSectionSummaryResults (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetStickyRowPriority (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetStickyRows (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetStickyRowsInRange (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodGetUnrealizedCountGets the number of unrealized or virtual items.  
Public 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. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public 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. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodIsExclusivelySticky (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodIsPlaceholderItemReturns true if the item at the requested index is a placeholder item and has not been actualized. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodIsRowPinned (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodIsRowSpanning (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodNotifyClearItemsManually notifies the data source that the data it has bound to has been cleared and needs to be re-examined. This should not be necessary to call if the data that the data source is bound to is already observable. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodNotifyInsertItemManually notifies the data source that an item has been inserted in the data it is bound to. This should not be necessary to call if the data that the data source is bound to is already observable. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodNotifyRemoveItemManually notifies the data source that an item has been removed in the data it is bound to. This should not be necessary to call if the data that the data source is bound to is already observable. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodNotifySetItemManually notifies the data source that an item has been changed in the data it is bound to. This should not be necessary to call if the data that the data source is bound to is already observable. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodPinRow (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodQueueAutoRefreshCalled to manually queue a refresh of the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodRefreshCalled to synchronously refresh the data source. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodResetCacheResets the internal caches for this virtual data source.  
Public MethodResolveDataProviderReturns the default data provider for this data source.  
Public MethodResolveSchemaPropertyType (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodSetIsRowExpandedAtIndex (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public MethodUnpinRow (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Protected Methods
 NameDescription
Protected MethodOnPropertyChangedUsed to invoke the PropertyChanged event. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Protected MethodOnRowExpansionChangedUsed to invoke the RowExpansionChanged event. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Protected MethodOnSchemaChangedUsed to invoke the SchemaChanged event. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Protected MethodResetCacheOverrideCan be overriden to implement clearing the caches of this virtual data source.  
Protected MethodResolveDataProviderOverrideIs overriden to provide the default data provider for this data source.  
Public Events
 NameDescription
Public EventPropertyChangedIndicates that a property has changed on the object. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public EventRowExpansionChangedIndicates that a row has been expanded or collapsed. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
Public EventSchemaChangedIndicates that the schema for the underlying data has changed. The data source is not considered ready for use until schema is populated. (Inherited from Infragistics.Core.Controls.DataSource.BaseDataSource)
See Also