You are here:
Symbol Reference
Symbol Reference
>
Ofcas.Lk.Api.Shared Namespace
Ofcas.Lk.Api.Client.Core Namespace
Ofcas.Lk.Api.Client.Core.Exceptions Namespace
Ofcas.Lk.Api.Client.Core.Synchronizations.Exceptions Namespace
Ofcas.Lk.Api.Client.Core.Utils Namespace
Ofcas.Lk.Api.Client.Ui Namespace
Ofcas.Lk.Api.Shared Namespace
Files
>
Classes
Classes
Interfaces
Structs, Records, Enums
>
WellKnownParameterKeys Class
WellKnownActionKeys Class
WellKnownAddressTypes Class
WellKnownEditKeys Class
WellKnownElementTypes Class
WellKnownElevationCommentTypes Class
WellKnownElevationProcessingStatus Class
WellKnownElevationTypes Class
WellKnownElevationWarningLevel Class
WellKnownEventArgumentKeys Class
WellKnownParameterKeys Class
WellKnownPriceTypes Class
WellKnownProgramCategories Class
WellKnownPrograms Class
WellKnownProjectInformationKeys Class
WellKnownProjectInformationTypes Class
WellKnownReportCategories Class
WellKnownReports Class
WellKnownSettingKeys Class
>
WellKnownParameterKeys Classes
WellKnownParameterKeys Classes
>
WellKnownParameterKeys.LoginScope Class
WellKnownParameterKeys.ElementPricelist Class
WellKnownParameterKeys.ElementPricelistConfigurator Class
WellKnownParameterKeys.Elevation Class
WellKnownParameterKeys.LoginScope Class
WellKnownParameterKeys.Phase Class
WellKnownParameterKeys.Project Class
WellKnownParameterKeys.ProjectCenter Class
WellKnownParameterKeys.SearchAgent Class
>
LoginScope Classes
LoginScope Classes
>
WellKnownParameterKeys.LoginScope.Program Class
WellKnownParameterKeys.LoginScope.Export Class
WellKnownParameterKeys.LoginScope.FileDialog Class
WellKnownParameterKeys.LoginScope.Program Class
>
Program Fields
Program Fields
Close
Ofcas.Lk.Api.Client - Version 3.0.2
Contents
Index
Home
Fields
Send Feedback
Collapse All
Expand All
The fields of the Program class are listed here.
Fields
Name
Description
CadFileUri
optional: value-type:
string
The file uri with which the CAD can be started.
CompositeName
return value; value-type:
string
; Returns the selected composite from
WellKnownPrograms.LoginScope.ProfileDrawingExport
. Returns an empty string if no composite is available.
DxfVersion
case-required; value-type:
Shared.DxfVersion
; Defines the version of a DXF drawing.
ExportFormat
optional; value-type:
string
; Defines the output file format for
LoginProgramCategoryType.ProfileAndCurtainWallExport
. Currently supported: 'XML', 'OCD', 'DXF'. Default: 'XML'
FileName
optional; value-type:
string
Defines the output file for
LoginProgramCategoryType.ProfileAndCurtainWallExport
.
PrintoutFileUri
case-required; value-type:
string
The file uri with which the printout preview shall be started.
ProfileName
return value; value-type:
string
; Returns the selected profile from
WellKnownPrograms.LoginScope.ProfileDrawingExport
.
ProjectGuid
optional; value-type:
Guid
the project guid can be used to to create a status report with the given project.
SupplierName
return value; value-type:
string
; Returns the profile's supplier from
WellKnownPrograms.LoginScope.ProfileDrawingExport
.
SystemName
return value; value-type:
string
; Returns the system from
WellKnownPrograms.LoginScope.ProfileDrawingExport
. Only returns a system if a system was selected by the user (because one profile can appear in multiple systems).
Copyright © 2022. All rights reserved.
What do you think about this topic?
Send feedback!