IWbs Interface

Represents a WBS of an estimate. It belongs to a single estimate version.
Public Interface IWbs
This language is not supported or no code example is available.
public interface IWbs
This language is not supported or no code example is available.
Name Description
Public property ColumnMappings Obsolete. Gets columns definitions of the WBS.
Public property Root Gets the root node in this WBS tree.
Public property Version Gets the estimate version to which this WBS belongs.
Public property WbsWorkbookCalculationMode Gets or sets the calculation mode of the WBS workbook, i.e. whether the workbook is automatically calculated as needed.
Top
Methods
 
Name Description
Public method CalculateWbsWorkbook() Calculates all non-invariant formulas in the WBS workbook.
Public method CopyBranch(ITask) Copies a task or a branch to the internal clipboard.
Public method CopyWholeColumnValues(string, string, bool, PositionInWbsBranch) Copy whole content of a column into another column.
Public method CreateLink(ITask, ITask, bool) Creates a link between two tasks.
Public method CreateNewSubTask(ITask) Creates a new sub-task below specified task, at the depth level of the specified task + 1.
Public method CreateNewTask(ITask) Creates a new task below specified task, at the same depth level.
Public method DeleteLink(ITask, ITask) Deletes the link from a specified task (which is whether a parent or a child of the link) in WBS.
Public method DeleteTask(ITask, bool, bool) Deletes a task and its content.
Public method DistributeWbsToBoqColumns() Runs the WBS to BOQ distribution to feed the BOQ columns (when WBS to BOQ distribution columns are implemented).
Public method GetCellValueFromWorkbook(string, string) Reads a value from any cell in any workbook directly. No need for lock.
Public method GetCellValueFromWorkbook(string, int, int) Reads a value from any cell in any workbook directly. No need for lock.
Public method GetColumnHeading(string) Obsolete. Returns the heading of a column in the WBS. Gets the displayed name and the parent name.
Public method GetColumnPosition(string, bool) Obsolete. Gets the position of a column in the expanded WBS using its name or its unique identifier.
Public method GetFullData(bool, LocationOfTotals) Gets the full data of the WBS.
Public method GetLinkParentTask(ITask) Gets the parent task for a specified child task, if there's a link between them.
Public method GetReadOnlyCopyOfWorkbook(WorkbookParameters, WbsSheets, bool) Gets the WBS workbook for read only purposes.
Public method GetTask(string) Gets the existing task by its ITask.HexID.
Public method GetTaskByGuid(string) Gets the existing task by its ITask.Guid (not by HexID).
Public method GetTaskFromWorksheetRow(int, bool) Gets the task to which the specified row in the WBS worksheet belongs.
Public method GetTasksForScope(string, bool) Gets all tasks within the specified scope.
Public method InsertColumnIntoWorkbook(string, int) Obsolete. Inserts a new user/free/special column in WBS.
Public method PasteBranch(ITask, bool) Pastes a task or a branch from the internal clipboard.
Public method PasteBranchWithoutRefresh(string, bool) Pastes a task or a branch from the internal clipboard quickly and keeps the task tree structure of this IWbs instance in an incorrect state.
Public method Refresh() Refreshes (re-reads) the WBS mappings in ColumnMappings property, updates the tree structure of the tasks in this IWbs instance and internal cache of WBS and Minutes data.
Public method RefreshValidationLists() Refreshes all possible entry lists in the WBS.
Public method RemoveAllLinks(bool) Removes all links between tasks in the WBS.
Public method SetColumnBackgroundColor(string, Color, bool) Obsolete. Sets the background color of a column in the WBS.
Public method SetColumnCopyToQuantityFlag(string, bool) Obsolete. Defines if values of a WBS column must be copied to WBS_Quantity column when running progress statements.
Public method SetColumnDescription(int, string) Obsolete. Sets description  of a user/free column in WBS.
Public method SetColumnFormula(string, string, bool) Obsolete. Sets the formula in a free column of the WBS.
Public method SetColumnTitle(string, string, WbsTitleRowPosition) Obsolete. Sets the title of a user/free column in WBS.
Public method SetColumnVisibility(int, bool) Obsolete. Sets visibility of a user/free column in WBS.
Public method SetColumnVisibleMode(string, bool, bool) Obsolete. Defines if the WBS column is visible in estimate mode or/and in progress mode.
Public method SetFreeFieldValues(string, IDictionary<StringObject>, bool, bool, bool) Writes values to all cells of a free WBS field. Writes to the WBS workbook and the database at once.
Public method SetPermissionsOfColumn(int, bool, bool, bool) Obsolete. Sets permissions to user/free column in WBS.
Public method SetValueToWholeColumn(string, object, bool, PositionInWbsBranch) Sets a fixed value to all cells of a column.
Public method SumColumnsGlobally(string, string, bool, PositionInWbsBranch) Sums specified columns and writes the results into another column.
Top
Version
 
Available since QDV 7.13.0001.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition