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...
Public Member Functions | |||
| ProjectCenterUi (IApiService service, Guid coreObjectId, LoginScopeUi parent, ProjectCenterInfo coreInfo, ProjectDirectoryInfo projectDirectoryInfo) | |||
| new ProjectUi | GetProject (ProjectInfo projectInfo) | ||
| Returns the corresponding project based on the given information data. 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 () | ||
| Select an existing project via User Interface (UI). More... | |||
 Public Member Functions inherited from Ofcas.Lk.Api.Core.ProjectCenter | |||
| ProjectCenter (IApiService service, Guid coreObjectId, LoginScope parent, ProjectCenterInfo coreInfo, ProjectDirectoryInfo projectDirectoryInfo) | |||
| 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... | |||
| 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) | ||
| |||
| ElevationInstance | GetElevationInstanceFromLkId (Guid lkElevInstanceGuid) | ||
| |||
| ProjectDirectoryInfo | CreateDirectory (string directoryName) | ||
| Creates a new directory in the current project center. More... | |||
| override ProjectInfo | ExecuteBasicOperation (ProjectInfo sourceInfo, BasicOperationItem basicOperation, IDictionary< string, object > parameters) | ||
Additional Inherited Members | |
| Public Attributes inherited from Ofcas.Lk.Api.Core.ProjectCenter | |
| ProjectDirectoryInfo | OwnDirectoryInfo => _ownDirectoryInfo |
| Returns the directory info for the project-center More... | |
| Protected Member Functions inherited from Ofcas.Lk.Api.Core.ProjectCenter | |
| override List< BasicOperationItem > | GetBasicOperationItems (ProjectInfo sourceInfo) |
| Properties inherited from Ofcas.Lk.Api.Core.ProjectCenter | |
| IList< ProjectDirectoryInfo > | ProjectDirectoryInfos [get] |
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.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.
◆ GetProject()
| new ProjectUi Ofcas.Lk.Api.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.
◆ Import()
| ProjectInfo Ofcas.Lk.Api.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.Ui.ProjectCenterUi.SelectLkProject | ( | ) |
Select an existing project via User Interface (UI).
- Returns
- The selected ProjectUi or NULL if the user rejected the the dialog.
- Exceptions
-
Exception Selecting project failed or aborted.
The documentation for this class was generated from the following file:
- Ofcas.Lk.Api.Ui/ProjectCenterUi.cs
