ProjectCenterUi is the representation of a LogiKal project-center. The ProjectCenterUi provides methods with user interactions. The children are of type Project. The children can be received from the InfoList (CoreObject<T>.Infos). Each ProjectCenter project center belongs to a fixed directory. To use another project directory, create a new project center using method ProjectCenter.GetProjectCenter. More...

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

Public Member Functions

new ProjectUi GetProject (ProjectInfo projectInfo)

Returns the corresponding project based on the given information data. More...

new ProjectCenterUi GetProjectCenter (ProjectDirectoryInfo projectDirectoryInfo)

Creates a new ProjectCenterUi for the given directory. Each ProjectCenterUi belongs to a fixed directory. More...

ProjectInfo CreateLkProject ()

Creates a new project via User Interface (UI). More...

ProjectInfo Import (ProjectCenterImportType importType, Stream content)

Import a Project via User Interface (UI). More...

ProjectInfo SelectLkProject ()

This method is obsolete. More...

IDialogResult< Stream > ExportChild (ProjectInfo projectInfo)

Exports a Project based on its ProjectInfo via User Interface (UI). More...

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.ProjectCenter

Project GetProject (ProjectInfo projectInfo)

Returns the corresponding project based on the given information data. More...

ProjectCenter GetProjectCenter (ProjectDirectoryInfo projectDirectoryInfo)

Creates a new ProjectCenter for the given directory. Each ProjectCenter belongs to a fixed directory. More...

override OperationInfo CanCreateChild ()

Checks whether a project can be created or not. More...

override ProjectInfo CreateChild ()

Creates a new project with a default name. Call Project.Edit with WellKnownEditKeys.Project.Name to change the name after the creation. More...

override OperationInfo CanDeleteChild (ProjectInfo projectInfo)

Checks whether a project can be deleted or not. More...

override void DeleteChild (ProjectInfo projectInfo)

Deletes a project based on an info object. More...

override OperationInfo CanMoveFrom (ICoreInfo coreInfo, bool deepCheck=true)

override ProjectInfo MoveFrom (ICoreInfo coreInfo)

Moves an object into this directory based on an info object. More...

override OperationInfo CanCopyFrom (ICoreInfo coreInfo, bool deepCheck=true)

override ProjectInfo CopyFrom (ICoreInfo coreInfo)

Copies an object into this directory based on an info object. More...

ProjectInfo CreateLkProject (string projectName)

Creates a new Project in the LogiKal project structure. The project will be created in the current active directory. More...

void DeleteLkProject (ProjectInfo projectInfo)

Deletes the corresponding logikal project based on the given information data. More...

ProjectInfo MoveLkProjectFrom (ProjectInfo projectInfo, string newProjectName)

Moves a project to this project center based on the given project info and the new project name. More...

ProjectInfo CopyProjectFrom (ProjectInfo projectInfo, string newProjectName)

Copies a project and its elevations. More...

Elevation GetElevationFromLkId (Guid lkElevGuid)

Exceptions

NotSupportedException

ElevationInstance GetElevationInstanceFromLkId (Guid lkElevInstanceGuid)

Exceptions

NotSupportedException

ProjectDirectoryInfo CreateDirectory (string directoryName)

Creates a new directory in the current project center. More...

override ProjectInfo RefreshChild (ProjectInfo childInfo)

override Project GetChild (ProjectInfo childInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< LoginScope, ProjectCenterInfo, Project, ProjectInfo >

TOwnInfo Refresh ()

virtual OperationInfo CanEdit (string key, object value)

virtual TOwnInfo Edit (string key, object value)

Protected Member Functions
override Project	CreateNewInstance (Guid coreObjectId, ProjectInfo childInfo)

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

Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< LoginScope, ProjectCenterInfo, Project, ProjectInfo >
	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.ProjectCenter
ProjectDirectoryInfo	OwnDirectoryInfo => _ownDirectoryInfo
	Returns the directory info for the project-center More...

Properties inherited from Ofcas.Lk.Api.Client.Core.ProjectCenter
IList< ProjectDirectoryInfo >	ProjectDirectoryInfos `[get]`

Properties inherited from Ofcas.Lk.Api.Client.Core.CoreObjectFullyQualified< LoginScope, ProjectCenterInfo, Project, ProjectInfo >
TParent	Parent `[get]`

TOwnInfo	CoreInfo `[get, protected set]`

TOwnInfo	Info `[get, protected set]`

Detailed Description

ProjectCenterUi is the representation of a LogiKal project-center. The ProjectCenterUi provides methods with user interactions. The children are of type Project. The children can be received from the InfoList (CoreObject<T>.Infos). Each ProjectCenter project center belongs to a fixed directory. To use another project directory, create a new project center using method ProjectCenter.GetProjectCenter.

Member Function Documentation

◆ CreateLkProject()

ProjectInfo Ofcas.Lk.Api.Client.Ui.ProjectCenterUi.CreateLkProject ( )

Creates a new project via User Interface (UI).

Returns: The ProjectInfo to the created project or NULL if the user rejected the dialog.

Exceptions

Exception Generating project failed or aborted.

◆ ExportChild()

IDialogResult<Stream> Ofcas.Lk.Api.Client.Ui.ProjectCenterUi.ExportChild ( ProjectInfo projectInfo )

Exports a Project based on its ProjectInfo via User Interface (UI).

Parameters

projectInfo The info of the project to be exported.

Returns: Returns the stream of the exported project archive.

◆ GetProject()

new ProjectUi Ofcas.Lk.Api.Client.Ui.ProjectCenterUi.GetProject ( ProjectInfo projectInfo )

Returns the corresponding project based on the given information data.

Parameters

projectInfo The project information obtained through the CoreObject<T>.Infos function.

Returns: the ProjectUi

Exceptions

Exception If getting elevation failed.

◆ GetProjectCenter()

new ProjectCenterUi Ofcas.Lk.Api.Client.Ui.ProjectCenterUi.GetProjectCenter ( ProjectDirectoryInfo projectDirectoryInfo )

Creates a new ProjectCenterUi for the given directory. Each ProjectCenterUi belongs to a fixed directory.

Parameters

projectDirectoryInfo The project directory to use

Returns: The new ProjectCenterUi

Exceptions

Exception if creating project-center failed (for example invalid directory)

◆ Import()

ProjectInfo Ofcas.Lk.Api.Client.Ui.ProjectCenterUi.Import	(	ProjectCenterImportType	importType,
		Stream	content
	)

Import a Project via User Interface (UI).

Parameters

importType	The type how to import a project (ProjectCenterImportType). The type influenced the content.
content	the content depends to the given importType

Returns

◆ SelectLkProject()

ProjectInfo Ofcas.Lk.Api.Client.Ui.ProjectCenterUi.SelectLkProject ( )

This method is obsolete.

Returns

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

Ui/src/ProjectCenterUi.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateLkProject()

◆ ExportChild()

◆ GetProject()

◆ GetProjectCenter()

◆ Import()

◆ SelectLkProject()