You are here: Symbol Reference
Symbol Reference
> Ofcas.Lk.Api.Shared Namespace > Classes > WellKnownParameterKey Class > WellKnownParameterKey Classes > WellKnownParameterKey.LoginScope Class > LoginScope Classes > WellKnownParameterKey.LoginScope.Program Class
Close
Ofcas.Lk.Api.Client - Version 3.0
ContentsContentsIndexIndexHomeHome
PreviousUpNext
WellKnownParameterKey.LoginScope.Program Class
Send Feedback
Collapse AllCollapse AllExpand AllExpand All

Well known parameter keys for programs.

Ofcas_Lk_Api_Shared_WellKnownParameterKey_LoginScope_Program

File: WellKnownParameterKey.cs 

Namespace: Ofcas.Lk.Api.Shared

Syntax
C#
public static class Program;
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 WellKnownProgram.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 WellKnownProgram.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 WellKnownProgram.LoginScope.ProfileDrawingExport.
SystemName
return value; value-type: string; Returns the system from WellKnownProgram.LoginScope.ProfileDrawingExport. Only returns a system if a system was selected by the user (because one profile can appear in multiple systems).
Copyright © 2020. All rights reserved.
ContentsIndexHome
What do you think about this topic? Send feedback!