QDVEstimate.GetWorkbookFromProfile (IExportType, String, Dictionary<StringObject>) Method

NOTE: This member is now obsolete. Use Qdv.UserApi.IEstimate.GetReportWorkbook instead.

Returns a Spreadsheet Gear workbook based on a report profile (PFL)
[Obsolete("Use Qdv.UserApi.IEstimate.GetReportWorkbook instead.")] 
public IWorkbook GetWorkbookFromProfile( 
IExportType ExportType
string FullPathToProfile
Dictionary<string, object> ProfileInfo = Nothing 
)
This language is not supported or no code example is available.

Parameters

ExportType
IExportType

Define which type of export you want to get:

WithFormulas 
WithoutFormulas 
RawData

FullPathToProfile
string

The full path to the report profile (.PFL file)

ProfileInfo
Dictionary<string, object>

Optional. The default value is Nothing.

A dictionary of objects (Keys are strings) whose keys are named below. Each key define a specific behavior of the report.

Notice that key names are case sensitive.

    Public PrinterName As String = "" 
    Public PaperSize As Integer = SpreadsheetGear.PaperSize.A4 
    Public Landscape As Boolean = False 
    Public BlackAndWhite As Boolean = False 
    Public HeaderMargin As Double = 22 
    Public FooterMargin As Double = 22 
    Public TopMargin As Double = 54 
    Public BottomMargin As Double = 54 
    Public LeftMargin As Double = 50 
    Public RightMargin As Double = 50 
    Public CenterHorizontally As Boolean = True 
    Public CenterVertically As Boolean = False 
    Public CenterHeader As String = "" 
    Public LeftHeader As String = "" 
    Public RightHeader As String = "" 
    Public CenterFooter As String = "" 
    Public LeftFooter As String = "" 
    Public RightFooter As String = ""

    'Settings initialized from frmestimate 
    Public Spacing As Integer = 0

    'Settings from Hide/Show Dropdown 
    Public ReportDetailedRows As Boolean = False 
    Public ReportDatabaseOfEstimate As Boolean = False 
    Public ReportOverheadCostsMinute As Boolean = False 
    Public ReportPricesOnDetailedRows As Boolean = False 
    Public ReportDetailsOfOptions As Boolean = False 
    Public ReportDetailsOfOptionsInCore As Boolean = False 
    Public ReportGroupsContents As Boolean = False 
    Public ReportExpandAllSets As Boolean = False 
    Public ReportContractingFactors As Boolean = False 
    Public ReportTotalExcludingVAT As Boolean = False 
    Public ReportTotalIncludingVAT As Boolean = False 
    Public ReportCurrenciesOnTotals As Boolean = False 
    Public ReportPricesPerUnit As Boolean = False 
    Public ReportReferencesInColumnItem As Boolean = False 
    Public ReportNonSignificantZerosInReferences As Boolean = False 
    Public ReportGridLines As Boolean = False 
    Public ReportColorMakers As Boolean = False 
    Public ReportColorGroups As Boolean = False 
    Public ReportColorBase As Boolean = False 
    Public ReportShowAllRows As Boolean = True    'used for the minutes report 
    Public ReportShowFirstRow As Boolean = True    'used for the minutes report 
    Public ReportShowTotals As Boolean = True    'used for the minutes report 
    Public ReportNoHeadersInExport As Boolean = False  'used to have no headers in exported file

    'Settings from Miscellaneous dropdown 
    Public ReportSubTotalsTitleColor As Boolean = False 
    Public ReportDescriptionsOnSubTotals As Boolean = False 
    Public ReportItemsOnSubTotals As Boolean = False 
    Public ReportIgnoreBOQStructure As Boolean = False 
    Public ReportAccurateSellingPrices As Boolean = False

    'Other Settings 
    Public ReportType As ReportTypes = ReportTypes.WBS 
    Public ReportLanguage As String = "" 
    Public ReportPassWord As String = ""  'the decrypted password 
    Public ReportLocked As Boolean = False      'the lock status of the report 
    Public ReportFreezeRow As Integer = 0 
    Public ReportFreezeColumn As Integer = 0

    'Specific Nomenclatures settings 
    Public NomenclaturesFilter1 As clNomenAPI.Filter1IDs = clNomenAPI.Filter1IDs.AllRows 
    Public NomenclaturesGroupBy As String = "" 
    Public NomenclaturesSortBy As String = "" 
    Public NomenclaturesIncludeHat As Boolean = False 
    Public NomenclaturesColor As ColorIdx = ColorIdx.White 
    Public NomenclaturesFontSize As Integer = 11 
    Public NomenclaturesFontName As String = "Calibri" 
    Public NomenclaturesTask As String = "001".PadRight(24, "0") 
    Public NomenclaturesText As String = "" 
    Public NomenclaturesTaskColor As Integer = Colors.LightGray.ToArgb() 
    Public NomenclaturesMode As clNomenAPI.ModeIds = clNomenAPI.ModeIds.GroupedRows  
    Public NomenclaturesViewType As QDAPI.Estimate.ViewType = QDAPI.Estimate.ViewType.Normal

    'allow outside editmode for reportgenerator 
    Public ReportAllowLanguages As Boolean = False 
    Public ReportAllowShowHide As Boolean = False 
    Public ReportAllowMiscellaneous As Boolean = False

    Public ReportCulture As System.Globalization.CultureInfo = Nothing

Return Value

IWorkbook

A Spreadsheet Gear workbook containing all estimate data posted through the report profile.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition