ElevationUi is the representation of a LogiKal element (for example, a window, a facade, ...) and provides methods with user interaction. The children are of type ElevationInstance. The children can be received from the InfoList (CoreObject<T>.Infos). More...
Public Member Functions | |
| ElevationUi (IApiService apiService, Guid coreObjectId, ProjectUi parent, ElevationInfo coreInfo) | |
| ElevationInfo | Edit (ElevationEditMode elevationEditMode) |
| Starts editing the elevation via user interface More... | |
| async Task< ElevationInfo > | EditAsync (ElevationEditMode elevationEditMode) |
| Asynchronously starts the editing of the elevation via user interface. More... | |
| override ElevationInstanceInfo | CreateElevationInstance () |
| Creates a new ElevationInstance to this Elevation. More... | |
| override void | DeleteElevationInstance (ElevationInstanceInfo elevationInstanceInfo) |
| Deletes an existing ElevationInstance from this Elevation. More... | |
 Public Member Functions inherited from Ofcas.Lk.Api.Core.Elevation | |
| ElevationInstance | GetElevationInstance (ElevationInstanceInfo elevationInstanceInfo) |
| Returns the corresponding elevation instance based on the given information data. More... | |
| void | GetThumbnail (Stream target, GraphicSettings settings) |
| An overview image from the elevation. The thumbnail will be returned as image file. More... | |
| Stream | GetDrawing (GraphicSettings settings) |
| Returns a drawing from the elevation. Use Format in GraphicSettings to specify the format of the drawing. Currently supported are: More... | |
| void | GetGdz (Stream target, GdzSettings settings) |
| Returns the gdz stream (as a zip-stream). More... | |
| Stream | GetPartsList () |
| Returns the parts list of this Elevation as a sqlite file. More... | |
| IList< ElevationEditMode > | GetAvailableElevationEditModes () |
| Returns a list of all available ElevationEditMode for the current Elevation. More... | |
| int | ElevationInstanceAmount () |
| Returns the amount of elevation instances. More... | |
| ElevationInfo | SetParameter (string key, object value) |
| Takes the parameter to update the elevation. More... | |
Detailed Description
ElevationUi is the representation of a LogiKal element (for example, a window, a facade, ...) and provides methods with user interaction. The children are of type ElevationInstance. The children can be received from the InfoList (CoreObject<T>.Infos).
Member Function Documentation
◆ CreateElevationInstance()
|
virtual |
Creates a new ElevationInstance to this Elevation.
- Returns
- The ElevationInstanceInfo to the created elevation instance
- Exceptions
-
ApiException Occurs if the method fails.
Reimplemented from Ofcas.Lk.Api.Core.Elevation.
◆ DeleteElevationInstance()
|
virtual |
Deletes an existing ElevationInstance from this Elevation.
- Parameters
-
elevationInstanceInfo
Reimplemented from Ofcas.Lk.Api.Core.Elevation.
◆ Edit()
| ElevationInfo Ofcas.Lk.Api.Ui.ElevationUi.Edit | ( | ElevationEditMode | elevationEditMode | ) |
Starts editing the elevation via user interface
- Parameters
-
elevationEditMode Possible modes to edit can be received with Elevation.GetAvailableElevationEditModes
- Returns
◆ EditAsync()
| async Task<ElevationInfo> Ofcas.Lk.Api.Ui.ElevationUi.EditAsync | ( | ElevationEditMode | elevationEditMode | ) |
Asynchronously starts the editing of the elevation via user interface.
- Parameters
-
elevationEditMode Possible modes to edit can be received with Elevation.GetAvailableElevationEditModes
- Returns
The documentation for this class was generated from the following file:
- Ofcas.Lk.Api.Ui/ElevationUi.cs
