INomenclatures.GetWorkbook Method

Function GetWorkbook( _ 
   ByVal properties As NomenclaturesProperties, _ 
   Optional ByVal Scope As String = "001000000000000000000000", _ 
   Optional ByVal WithFormulas As Boolean = False, _ 
   Optional ByVal FontName As String = "Calibri", _ 
   Optional ByVal FontSize As Integer = 11, _ 
   Optional ByVal ShowGridLines As Boolean = True, _ 
   Optional ByVal HeadColor As Integer = 13619151 _ 
) As IWorkbook

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

IWorkbook GetWorkbook( 
   NomenclaturesProperties properties, 
   string Scope = "001000000000000000000000", 
   bool WithFormulas = False, 
   string FontName = "Calibri", 
   int FontSize = 11, 
   bool ShowGridLines = True, 
   int HeadColor = 13619151 
)

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

Parameters

properties

NomenclaturesProperties

Nomenclature properties to be applied.

Scope

string

Optional. The tasks that should be included in the workbook. The default value is "001000000000000000000000" which means the entire estimate. See IWbs.GetTasksForScope documentation for the scope explanation.

WithFormulas

bool

Optional. Indicates whether formulas will be kept. If set to true, then formulas will be kept; otherwise, the formulas will be replaced with calculated values. The default value is false.

FontName

string

Optional. The name of the font that will be used in the workbook. The default value is "Calibri".

FontSize

int

Optional. The size of the font that will be used in the workbook. The default value is 11.

ShowGridLines

bool

Optional. Indicates whether to show grid lines in the workbook.The default value is true.

HeadColor

int

Optional. The color of the headers and totals rows. The default value is 13619151 (#CFCFCF).

Return Value

null reference (Nothing in Visual Basic) if the nomenclatures workbook couldn't be retrieved.

Currently, you can only get the nomenclatures workbook of the current estimate version, with IEstimateVersion.Version set to 0.

The returned workbook could contain less fields than specified in NomenclaturesProperties.IncludedColumns of properties parameter. These are those that are not allowed in nomenclatures, which is specified in their IMinutesField.Allowed property. The field mnemonics are stored in a hidden row 0 of the worksheet.

.NET Framework