ProjectUi is the representation of a LogiKal project and provides methods with user interactions. The children are of type PhaseUi. The children can be received from the InfoList (CoreObject<T>.Infos). More...

Inheritance diagram for Ofcas.Lk.Api.Client.Ui.ProjectUi:

Public Member Functions
void	Report (ReportItem reportItem, IList< ICoreInfoReportable > items, Dictionary< string, string > parameters)
	Creates a report according to the given report type via user interface. The report is generated for the passed elevations. If an empty list is passed, a report with all elevations of the project is automatically generated. More...

IList< ProjectRunnableProgram >	GetRunnablePrograms ()
	Retrieves a list of available ProjectRunnablePrograms. More...

OperationStatus	RunProgram (ProjectRunnableProgram program, Dictionary< string, object > optionalParameters=null)
	Runs the project program specified by the ProjectRunnableProgram. More...

new PhaseUi	GetPhase (PhaseInfo phaseInfo)
	Returns the corresponding phase based on the given information data. More...

void	ExportCncFiles (List< ElevationInfo > elevationInfos)
	Opens a user interface to export the given elevations as CNC files. More...

IDialogResult< Stream >	SelectGlass ()
	Selects a glass via user interface. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Project
override OperationInfo	CanEdit (string key, object value)
	Checks whether a project can be edited or not. More...

override ProjectInfo	Edit (string key, object value)
	Edits a project based on a key and a value. More...

Phase	GetPhase (PhaseInfo phaseInfo)
	Returns the corresponding phase based on the given information data. More...

PhaseInfo	CreatePhase (string name, string description)
	Creates a new Phase to the LogiKal projectvia user interface. More...

void	DeletePhase (PhaseInfo phaseInfo)
	Deletes a phase from this project. More...

IList< ReportCategory >	GetAvailableUserReports ()
	Return all available reports. More...

override PhaseInfo	RefreshChild (PhaseInfo childInfo)

override Phase	GetChild (PhaseInfo childInfo)

ProjectInfo	SetParameter (string key, object value)
	Takes the parameter to update the project. More...

OperationInfo	CanAdd (ICoreInfo coreInfo)
	Used to check if an ElevationInfo can be added to a project of type ProjectType.FabricationLot. More...

PhaseInfo	Add (ICoreInfo coreInfo)
	Used to add an ElevationInfo to a project of type ProjectType.FabricationLot. More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< ProjectCenter, ProjectInfo, Phase, PhaseInfo >
TOwnInfo	Refresh ()

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
bool	CanDispose ()
	Checks whether the ICoreInfo can be disposed. More...

Protected Member Functions
override Phase	CreateNewInstance (Guid coreObjectId, PhaseInfo phaseInfo)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.Project
override CoreInfoResponse	GetInfoResponse ()

override void	Dispose (bool disposing)

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< ProjectCenter, ProjectInfo, Phase, PhaseInfo >
	CoreObjectFullyQualified (IApiService apiService, Guid coreObjectId, TParent parent, TOwnInfo ownInfo)
	Creates a new instance of CoreObjectFullyQualified<TParent,TOwnInfo,TChild,TChildInfo> with the given parameters. More...

Additional Inherited Members
Public Attributes inherited from Ofcas.Lk.Api.Client.Core.Project
DocumentContainer	Documents => _documentContainerManager.GetDocumentContainer()

Properties inherited from Ofcas.Lk.Api.Client.Core.Project
ISynchronizationContainer	SynchronizationContainer `[get]`

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< ProjectCenter, ProjectInfo, Phase, PhaseInfo >
TParent	Parent `[get]`

TOwnInfo	CoreInfo `[get, protected set]`

TOwnInfo	Info `[get, protected set]`

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithSynchronizations
ISynchronizationContainer	SynchronizationContainer `[get]`
	The ISynchronizationContainer of this ICoreObject. More...

Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObject
Guid	CoreObjectId `[get]`
	The unique identifier of this core object. More...

Detailed Description

ProjectUi is the representation of a LogiKal project and provides methods with user interactions. The children are of type PhaseUi. The children can be received from the InfoList (CoreObject<T>.Infos).

Member Function Documentation

◆ ExportCncFiles()

void Ofcas.Lk.Api.Client.Ui.ProjectUi.ExportCncFiles ( List< ElevationInfo > elevationInfos )

Opens a user interface to export the given elevations as CNC files.

Parameters

elevationInfos The list of elevations to be exported.

Exceptions

ApiException Occurs if the method fails.

◆ GetPhase()

new PhaseUi Ofcas.Lk.Api.Client.Ui.ProjectUi.GetPhase ( PhaseInfo phaseInfo )

Returns the corresponding phase based on the given information data.

Parameters

phaseInfo The phase information obtained through the CoreObject<T>.Infos function.

Returns: the PhaseUi

Exceptions

Exception If getting elevation failed.

◆ GetRunnablePrograms()

IList<ProjectRunnableProgram> Ofcas.Lk.Api.Client.Ui.ProjectUi.GetRunnablePrograms ( )

Retrieves a list of available ProjectRunnablePrograms.

Returns: Returns a list of available ProjectRunnablePrograms.

◆ Report()

void Ofcas.Lk.Api.Client.Ui.ProjectUi.Report	(	ReportItem	reportItem,
		IList< ICoreInfoReportable >	items,
		Dictionary< string, string >	parameters
	)

Creates a report according to the given report type via user interface. The report is generated for the passed elevations. If an empty list is passed, a report with all elevations of the project is automatically generated.

Parameters

reportItem	Defines the type of report. Report types can be received with Project.GetAvailableUserReports
items	List of elevations to be used for the report
parameters	A dictionary with parameters can be used to specify reports options. (Not supported)

◆ RunProgram()

OperationStatus Ofcas.Lk.Api.Client.Ui.ProjectUi.RunProgram	(	ProjectRunnableProgram	program,
		Dictionary< string, object >	optionalParameters = `null`
	)

Runs the project program specified by the ProjectRunnableProgram.

Parameters

program	The info object of the program to be run.
optionalParameters	The optional parameters for the program to be run.

OBJECTGUID: sets the object guid for special mode, value-type: Guid

PROGRAMMODE: sets the program mode for special mode, value-type: ProgramMode

Returns: Returns an OperationStatus for the running program.

Exceptions

ApiException Occurs if the method fails.

◆ SelectGlass()

IDialogResult<Stream> Ofcas.Lk.Api.Client.Ui.ProjectUi.SelectGlass ( )

Selects a glass via user interface.

Returns: Returns a dialog result with a stream for the selected glass.

The documentation for this class was generated from the following file:

Ui/src/ProjectUi.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ExportCncFiles()

◆ GetPhase()

◆ GetRunnablePrograms()

◆ Report()

◆ RunProgram()

◆ SelectGlass()