Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

BaseDataSource Class Members

The following tables list the members exposed by BaseDataSource.

Public Properties
 NameDescription
Public PropertyActualCountGets the current actual full count of the items in the data source.  
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.  
Public PropertyActualSchemaGets the resolved schema for the data source. Represents which properties are available for the items.  
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.  
Public PropertyExecutionContextGets or sets the execution context that the data source should synchronize asynchronous actions with, or use to defer delayed actions.  
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.  
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.  
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.  
Public PropertyIncludeSummaryRowsInSection  
Public PropertyIsFilteringSupportedGets if filtering is supported on the data source.  
Public PropertyIsGroupingSupportedGets whether this datasource supports grouping.  
Public PropertyIsItemIndexLookupSupportedGets whether lookup of an index for a provided item is supported.  
Public PropertyIsKeyIndexLookupSupportedGets whether lookup of an index for a provided primary key value is supported.  
Public PropertyIsSectionCollapsableGets or sets if sections are collapsable.  
Public PropertyIsSectionContentVisibleGets or sets whether content besides the section headers are displayed.  
Public PropertyIsSectionExpandedDefaultGets or sets whether sections default to expanded or collapsed when they are created.  
Public PropertyIsSectionHeaderNormalRowGets or sets whether the section headers are treated as normal rows.  
Public PropertyIsSectionSummaryRowsAtBottom  
Public PropertyIsSortingSupportedGets if sorting is supported on the data source.  
Public PropertyIsVirtualGets if the current data source is a virtual data source.  
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.  
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.  
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.  
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.  
Public PropertySectionHeaderDisplayModeGets or sets how section headers are displayed.  
Public PropertyShouldEmitSectionFootersGets or sets whether this datasource should include section footers in its view of the data.  
Public PropertyShouldEmitSectionHeadersGets or sets whether this datasource should include section headers in its view of the data.  
Public PropertyShouldEmitShiftedRowsGets or sets whether this datasource should include shifted rows in its view of the data.  
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.  
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.  
Public PropertySummaryScopeGets or sets the scope which summaries are calculated for.  
Public PropertyUpdateNotifierGets or sets an IDataSourceUpdateNotifier that the data source should invoke methods on to indicate various changes have occurred.  
Protected Properties
Public Methods
 NameDescription
Public MethodClearPinnedRows  
Public MethodCloneClones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance.  
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  
Public MethodGetIsRowExpandedAtIndex  
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.  
Public MethodGetItemPropertyExtracts the value of a named property for an item contained in the data source.  
Public MethodGetItemPropertyAtIndexExtracts a named property value from the item at a specified index.  
Public MethodGetMainValuePath  
Public MethodGetRootSummaryResults  
Public MethodGetRootSummaryRowCount  
Public MethodGetRowLevel  
Public MethodGetRowType  
Public MethodGetSectionSummaryResults  
Public MethodGetStickyRowPriority  
Public MethodGetStickyRows  
Public MethodGetStickyRowsInRange  
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.  
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.  
Public MethodIsExclusivelySticky  
Public MethodIsPlaceholderItemReturns true if the item at the requested index is a placeholder item and has not been actualized.  
Public MethodIsRowPinned  
Public MethodIsRowSpanning  
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.  
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.  
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.  
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.  
Public MethodPinRow  
Public MethodQueueAutoRefreshCalled to manually queue a refresh of the data source.  
Public MethodRefreshCalled to synchronously refresh the data source.  
Public MethodResolveSchemaPropertyType  
Public MethodSetIsRowExpandedAtIndex  
Public MethodUnpinRow  
Protected Methods
 NameDescription
Protected MethodOnPropertyChangedUsed to invoke the PropertyChanged event.  
Protected MethodOnRowExpansionChangedUsed to invoke the RowExpansionChanged event.  
Protected MethodOnSchemaChangedUsed to invoke the SchemaChanged event.  
Public Events
 NameDescription
Public EventPropertyChangedIndicates that a property has changed on the object.  
Public EventRowExpansionChangedIndicates that a row has been expanded or collapsed.  
Public EventSchemaChangedIndicates that the schema for the underlying data has changed. The data source is not considered ready for use until schema is populated.  
See Also