IMapControl Interface
Common interface for all MapControl classes.
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)
Syntax
public interface IMapControl
Remarks
A Carmenta Engine MapControl is used to integrate a map view into the GUI of an application. Carmenta Engine provides several different MapControl classes, for different API:s and GUI platforms, see MapControl classes in Carmenta Engine for more information.
This interface defines common methods, properties and events provided by all the MapControl classes. Note that some classes may not formally implement the interface because of small variations in for instance the type of the event handlers, but they will all have corresponding members.
Implemented By
MapView (MAUI)
MapControl (.NET Android)
MapControl (Windows Forms)
MapControl (Windows Presentation Foundation)
Platforms
Windows, Linux, Android
IMapControl Members
The IMapControl type has the following members.
Properties
Name | Description |
---|---|
GuiDelayMinimum | The minimum amount of time in milliseconds that needs to pass between an update ending and another one starting. |
GuiDelayPercentage | The percentage of the previous update time used to delay the next update. |
IsConnected | Gets a value that tells whether the IMapControl implementation is connected to a View. |
Tool | Gets or sets the ITool that is used by the IMapControl implementation. |
ToolTimerInterval | The interval used by the IMapControl implementation to update tools. |
TouchTool | Gets or sets the ITouchTool that is used by the IMapControl implementation. |
UpdateInterval | The update interval used by the MapControl implementation. |
UpdateMode | Gets or sets the update mode used by the IMapControl implementation. |
View | Gets or sets the View that is displayed by the MapControl implementation. |
ViewOwnership | Gets or sets a value that determines whether the MapControl instance or application owns the View. |
Methods
Name | Description |
---|---|
UpdateView | Overloaded. Updates the map presentation. |
Events
Name | Description |
---|---|
AreaChanged | Occurs when the connected View fires the View.AreaChanged event. |
Busy | Occurs when the control is busy drawing or loading data. |
CustomDraw | Occurs when the connected View fires the View.CustomDraw event. |
CustomDrawBackground | Occurs when the connected View fires the View.CustomDrawBackground event. |
Error | Occurs when an operation raises an exception. |
HoverChanged | Occurs when the connected View fires the View.HoverChanged event. |
Idle | Occurs after an update when all data has been loaded. |
SelectionChanged | Occurs when the connected View fires the View.SelectionChanged event. |
Updated | Occurs when the connected View fires the View.Updated event. |
Updating | Occurs when the connected View fires the View.Updating event. |