Version 24.2 (latest)

IDataSource Interface Methods

For a list of all members of this type, see IDataSource members.

Public Methods
 NameDescription
 MethodClearPinnedRowsCalled to clear all pinned rows.  
 MethodCloneClones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance.  
 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  
 MethodGetIsRowExpandedAtIndexGets the expansion state for a row.  
 MethodGetItemPropertyExtracts the value of a named property for an item contained in the data source.  
 MethodGetItemPropertyAtIndexExtracts a named property value from the item at a specified index.  
 MethodGetMainValuePathGets the type of row at the specified index.  
 MethodGetRootSummaryResultsGets the summary results for the root level.  
 MethodGetRootSummaryRowCountGets the number of summary rows at the root level.  
 MethodGetRowLevelGets the hierarchy level of the row.  
 MethodGetRowTypeGets the type of row at the specified index.  
 MethodGetSectionSummaryResultsGets the summary results for a specific section.  
 MethodGetStickyRowPriorityGets the priority of a pinned row, which defines how it interacts with other pinned rows.  
 MethodGetStickyRowsGets the indexes of the currently pinned rows relevant to the visible range in index order.  
 MethodGetStickyRowsInRangeGets the indexes of the pinned rows relevant to the provided range in index order.  
 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.  
 MethodIsExclusivelyStickyGets whether the row is allowed to push other sticky rows with the same priority.  
 MethodIsPlaceholderItemReturns true if the item at the requested index is a placeholder item and has not been actualized.  
 MethodIsRowPinnedReturns whether the row is pinned.  
 MethodIsRowSpanningReturns whether the requested row type is considered a spanning element for the data source. Spanning elements have a single complex value rather than the current schema of the data source.  
 MethodPinRowCalled to pin a row by its primary key.  
 MethodQueueAutoRefreshCalled to manually queue a refresh of the data source.  
 MethodRefreshCalled to synchronously refresh the data source.  
 MethodResolveSchemaPropertyTypeResolve a property or property path to its value type.  
 MethodSetIsRowExpandedAtIndexSets the expansion state for a row.  
 MethodUnpinRowCalled to unpin a row by its primary key.  
See Also