You are here: Symbol Reference
Symbol Reference
> Ofcas.Lk.Api.Shared.DC Namespace
Ofcas.Lk.Api.Client.Core Namespace
Ofcas.Lk.Api.Client.Core.Exceptions Namespace
Ofcas.Lk.Api.Client.Core.Interfaces Namespace
Ofcas.Lk.Api.Client.Ui Namespace
Ofcas.Lk.Api.Client.Ui.Interfaces Namespace
Ofcas.Lk.Api.Shared.DC Namespace
Ofcas.Lk.Api.Shared.DC.Enums Namespace
Files
> Classes
Classes
Structs, Records, Enums
> WellKnownParameterKeys Class
CalculatedElementPricelist Class
CalculatedElementPricelistConfiguratorPrice Class
CalculatedElementPricelistPrice Class
ElementPricelistInfoData Class
LastErrorInfo Class
ProjectAddress Class
ProjectRunnableProgram Class
ProjectStatus Class
Restriction Class
SurfaceData Class
VisualTreeActionData Class
WellKnownActionKeys Class
WellKnownEditKeys Class
WellKnownElementTypes Class
WellKnownErrorCodes Class
WellKnownParameterKeys Class
WellKnownPrograms Class
WellKnownProjectInformationKeys Class
WellKnownReports Class
WellKnownSettingKeys Class
> WellKnownParameterKeys Classes
WellKnownParameterKeys Classes
> WellKnownParameterKeys.Project Class
WellKnownParameterKeys.ElementPricelist Class
WellKnownParameterKeys.ElementPricelistConfigurator Class
WellKnownParameterKeys.Elevation Class
WellKnownParameterKeys.LoginScope Class
WellKnownParameterKeys.Project Class
WellKnownParameterKeys.ProjectCenter Class
WellKnownParameterKeys.SearchAgent Class
> Project Classes
Project Classes
> WellKnownParameterKeys.Project.Report Class
WellKnownParameterKeys.Project.Program Class
WellKnownParameterKeys.Project.Report Class
> Report Fields
Report Fields
Close

Ofcas.Lk.Api.Client - Version 3.0 | Contents Index Home |

Fields
Send Feedback
Collapse All Expand All

The fields of the Report class are listed here.

Fields

| Name | Description
| EXPORT_FILE_NAME | optional; value-type string Defines the file name of the Exported file. Allowed file formats/extensions are .mdb and .sqlite3 Used for compatibility with old version of the api.
| ExportFormat | optional; value-type: String; Defines the export format of the Database. Currently supported: 'MDB', 'SQLite', 'PDF', 'XLSX'. Possible formats depends on reports, not every report can be retrieved in each format. Which format can be used with which report see WellKnownReports Required if extension of export file path doesn't define the type.
| HorizontalSection | optional; value-type: bool Whether the report should include a horizontal section. Valid for reports: WellKnownReports.ProjectPlan
| ShowEstimationData | optional; value-type: bool; Defines if the export should show estimation data.
| ShowPriceTakeover | optional; value-type: bool; Defines if the export should show price takeover.
| SplitGlassDisplay | optional; value-type: bool Enable split glass display. Valid for reports: WellKnownReports.ProjectPlan
| TextPosition | optional; value-type: string Defines the text position on the report. Currently supported: 'Standard', 'right', 'below' Valid for reports: WellKnownReports.ProjectPlan
| VerticalSection | optional; value-type: bool Whether the report should include a vertical section. Valid for reports: WellKnownReports.ProjectPlan
| View | optional; value-type: string Defines the viewpoint of the report. Currently supported: 'Interior', 'Exterior' Valid for reports: WellKnownReports.ProjectPlan

Copyright © 2020. All rights reserved.
What do you think about this topic? Send feedback!