IWbs.GetFullData Method

Function GetFullData( _ 
   ByVal forceRefresh As Boolean, _ 
   Optional ByVal totalsLocation As LocationOfTotals = LocationOfTotals.TotalsBelowChapters _ 
) As DataTable

This language is not supported or no code example is available.

DataTable GetFullData( 
   bool forceRefresh, 
   LocationOfTotals totalsLocation = LocationOfTotals.TotalsBelowChapters 
)

This language is not supported or no code example is available.

Parameters

forceRefresh

bool

Indicates whether the data are to be refreshed from the WBS workbook and DB or taken from the cache, if there is a cached version. If set to true, the data are always refreshed from the WBS workbook and the DB. If set to false, the data are taken from the cache if available; otherwise the data are refreshed from the WBS workbook and the DB.

totalsLocation

LocationOfTotals

The location of Totals rows.

Return Value

A table of objects containing a value for each field in the WBS. null reference (Nothing in Visual Basic) if a problem occurs. The first 8 mandatory columns are always present in the following order (as specified in the ColumnMappings property): WBS_HexIndex, WBS_IsATask, WBS_Level, WBS_ByTotal, WBS_IsOptional, WBS_IsForced, WBS_OrdinalPosition and WBS_RowWithTotal.

The data are retrieved from the WBS workbook and also from the database, if the data is not present in the workbook, such as WBS_Guid field.

The table of objects contains values for all fields in ColumnMappings property that have the IColumnMapping.IncludedForReading property set to true. Additionally, the values of the 'WBS_Guid' field are always present.

Each row in this table is a row of the WBS, including total, subtotals and totals on top as in the condensed WBS.

After successful execution, the data is written to an internal cache for faster access in the future.

.NET Framework