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 overridden by the user.  
Public PropertyActualSchemaGets the resolved schema for the data source. Represents which properties are available for the items.  
Public PropertyCanCommitGets whether a commit is possible.  
Public PropertyCanRedoGets whether redo is possible.  
Public PropertyCanUndoGets whether undo is possible.  
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 PropertyIncludeSummaryRowsInSectionGets or sets whether the data source should include summary rows inside the group when summaries are present.  
Public PropertyIsBatchingEnabledGets or sets whether batch edits are enabled.  
Public PropertyIsFilteringSupportedGets if filtering is supported on the data source.  
Public PropertyIsGroupingSupported  
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 PropertyIsReadOnlyGets or sets whether the data source is read-only or not.  
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 PropertyIsSectionSummaryRowsAtBottomGets or sets whether the summary rows within a section are placed at the bottom of the section, otherwise they will be placed at the top.  
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 PropertyShouldEmitSectionFooters  
Public PropertyShouldEmitSectionHeaders  
Public PropertyShouldEmitShiftedRows  
Public PropertyShouldEmitSummaryRows  
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 MethodAcceptPendingCommitAccepts a commit with the provided ID.  
Public MethodAcceptPendingTransactionSave a specific pending transaction.  
Public MethodAddItemAdds the provided item to the data source.  
Public MethodCancelEditsCancels any batched edits that may exist.  
Public MethodClearPinnedRows  
Public MethodCloneClones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance.  
Public MethodClonePropertiesClones the properties over to the provided datasource.  
Public MethodCommitEditsCommit the current edits to the datasource.  
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 MethodGetAggregatedChangesReturns a set of changes that have been made to the data however have not been committed yet.  
Public MethodGetIsRowExpandedAtIndexGets the expansion state for a row.  
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 MethodGetItemFromKeyReturns the item matching the specific key in the data 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 MethodGetRootSummaryResultsGets the summary results for the root level.  
Public MethodGetRootSummaryRowCountGets the number of summary rows at the root level.  
Public MethodGetRowCountGets the current actual full count of the items in the data source.  
Public MethodGetRowLevelGets the hierarchy level of the row.  
Public MethodGetRowType  
Public MethodGetSectionSummaryResultsGets the summary results for a specific section.  
Public MethodGetStickyRowPriority  
Public MethodGetStickyRows  
Public MethodGetStickyRowsInRange  
Public MethodGetTransactionErrorByIDReturns an error, if any, associated with a specific transaction.  
Public MethodGetTransactionErrorByKeyReturns an error, if any, associated with the provided key and property pair that exists in the current pending transactions.  
Public MethodGetTransactionIDReturns the ID of the pending transaction associated with the key and property pair.  
Public MethodHasAddReturns whether the item is an uncommitted add.  
Public MethodHasDeleteReturns whether the item has an uncommitted delete.  
Public MethodHasEditReturns whether the data source contains an uncommitted edit for a specific property.  
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 MethodIsPendingCommitReturns whether a commit is pending or not.  
Public MethodIsPendingTransactionReturns whether a transaction pending or not.  
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 MethodRedoRedo the last undo.  
Public MethodRefreshCalled to synchronously refresh the data source.  
Public MethodRejectPendingCommitCancel a commit with the provided ID.  
Public MethodRejectPendingTransactionRejects a pending transaction.  
Public MethodRemoveItemRemoves an item from the datasource.  
Public MethodRemoveItemByKeyRemoves an item with the specified key.  
Public MethodResetResets all the properties to their default values  
Public MethodResetDeferAutoRefreshResets the DeferAutoRefresh property to its default value.  
Public MethodResetExecutionContextResets the ExecutionContext property to its default value.  
Public MethodResetFirstVisibleIndexRequestedResets the FirstVisibleIndexRequested property to its default value.  
Public MethodResetIncludeSummaryRowsInSectionResets the IncludeSummaryRowsInSection property to its default value.  
Public MethodResetIsBatchingEnabledResets the IsBatchingEnabled property to its default value.  
Public MethodResetIsReadOnlyResets the IsReadOnly property to its default value.  
Public MethodResetIsSectionCollapsableResets the IsSectionCollapsable property to its default value.  
Public MethodResetIsSectionContentVisibleResets the IsSectionContentVisible property to its default value.  
Public MethodResetIsSectionExpandedDefaultResets the IsSectionExpandedDefault property to its default value.  
Public MethodResetIsSectionHeaderNormalRowResets the IsSectionHeaderNormalRow property to its default value.  
Public MethodResetIsSectionSummaryRowsAtBottomResets the IsSectionSummaryRowsAtBottom property to its default value.  
Public MethodResetLastVisibleIndexRequestedResets the LastVisibleIndexRequested property to its default value.  
Public MethodResetPrimaryKeyResets the PrimaryKey property to its default value.  
Public MethodResetPropertiesRequestedResets the PropertiesRequested property to its default value.  
Public MethodResetSectionHeaderDisplayModeResets the SectionHeaderDisplayMode property to its default value.  
Public MethodResetShouldEmitSectionFootersResets the ShouldEmitSectionFooters property to its default value.  
Public MethodResetShouldEmitSectionHeadersResets the ShouldEmitSectionHeaders property to its default value.  
Public MethodResetShouldEmitShiftedRowsResets the ShouldEmitShiftedRows property to its default value.  
Public MethodResetShouldEmitSummaryRowsResets the ShouldEmitSummaryRows property to its default value.  
Public MethodResetSummaryScopeResets the SummaryScope property to its default value.  
Public MethodResetUpdateNotifierResets the UpdateNotifier property to its default value.  
Public MethodResolveSchemaPropertyTypeResolve a property or property path to its value type.  
Public MethodSetIsRowExpandedAtIndexSets the expansion state for a row.  
Public MethodSetTransactionErrorAssociate an error with a specific pending transaction.  
Public MethodUndoUndo the last edit.  
Public MethodUnpinRow  
Public MethodUpdatePropertyAtKeyUpdates the value of a property in an item that matches the specified.  
Protected Methods
 NameDescription
Protected MethodOnDataCommittedUsed to invoke the DataCommitted event.  
Protected MethodOnPropertyChangedUsed to invoke the PropertyChanged event.  
Protected MethodOnRowExpansionChangedUsed to invoke the RowExpansionChanged event.  
Protected MethodOnSchemaChangedUsed to invoke the SchemaChanged event.  
Protected MethodShouldSerializeDeferAutoRefreshIndicates if the DeferAutoRefresh property needs to be serialized.  
Protected MethodShouldSerializeExecutionContextIndicates if the ExecutionContext property needs to be serialized.  
Protected MethodShouldSerializeFirstVisibleIndexRequestedIndicates if the FirstVisibleIndexRequested property needs to be serialized.  
Protected MethodShouldSerializeIncludeSummaryRowsInSectionIndicates if the IncludeSummaryRowsInSection property needs to be serialized.  
Protected MethodShouldSerializeIsBatchingEnabledIndicates if the IsBatchingEnabled property needs to be serialized.  
Protected MethodShouldSerializeIsReadOnlyIndicates if the IsReadOnly property needs to be serialized.  
Protected MethodShouldSerializeIsSectionCollapsableIndicates if the IsSectionCollapsable property needs to be serialized.  
Protected MethodShouldSerializeIsSectionContentVisibleIndicates if the IsSectionContentVisible property needs to be serialized.  
Protected MethodShouldSerializeIsSectionExpandedDefaultIndicates if the IsSectionExpandedDefault property needs to be serialized.  
Protected MethodShouldSerializeIsSectionHeaderNormalRowIndicates if the IsSectionHeaderNormalRow property needs to be serialized.  
Protected MethodShouldSerializeIsSectionSummaryRowsAtBottomIndicates if the IsSectionSummaryRowsAtBottom property needs to be serialized.  
Protected MethodShouldSerializeLastVisibleIndexRequestedIndicates if the LastVisibleIndexRequested property needs to be serialized.  
Protected MethodShouldSerializePrimaryKeyIndicates if the PrimaryKey property needs to be serialized.  
Protected MethodShouldSerializePropertiesRequestedIndicates if the PropertiesRequested property needs to be serialized.  
Protected MethodShouldSerializeSectionHeaderDisplayModeIndicates if the SectionHeaderDisplayMode property needs to be serialized.  
Protected MethodShouldSerializeShouldEmitSectionFootersIndicates if the ShouldEmitSectionFooters property needs to be serialized.  
Protected MethodShouldSerializeShouldEmitSectionHeadersIndicates if the ShouldEmitSectionHeaders property needs to be serialized.  
Protected MethodShouldSerializeShouldEmitShiftedRowsIndicates if the ShouldEmitShiftedRows property needs to be serialized.  
Protected MethodShouldSerializeShouldEmitSummaryRowsIndicates if the ShouldEmitSummaryRows property needs to be serialized.  
Protected MethodShouldSerializeSummaryScopeIndicates if the SummaryScope property needs to be serialized.  
Protected MethodShouldSerializeUpdateNotifierIndicates if the UpdateNotifier property needs to be serialized.  
Public Events
 NameDescription
Public EventDataCommittedEvent raised when a commit has completed.  
Public EventPropertyChangedEvent raised when a property value is changed.  
Public EventRowExpansionChanged  
Public EventSchemaChanged  
See Also