ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –> This class is the base class for all types of Layers.
The Layer class is where all other types of layers are inherited from. It provides the base set of functionality. Though all Layers inherit from this class, we strongly suggest if you decide to create your own layer type that you consider inheriting from the higher level RasterLayer for image-based layers and FeatureLayer for feature-based layers. They provide a rich set of default operations for the various types of layers and are simple to inherit from.
As it is abstract, there are a number of methods you need to implement. The first is DrawCore. In this method, you are responsible for drawing the layer's representation. The other two required methods are OpenCore and CloseCore. These open and close the Layer. In the Open, you are responsible for getting the layer ready for drawing. You should open any file references, etc. In the Close, you need to clean up all file handles, close other objects etc. It is important that the Close puts the class in a state where it can be re-opened in the future. It is different than Dispose, as closed Layers will still exist and can be re-opened later in the mapping life cycle. Many methods (in the layer and in higher level objects) will require that the Layer be open before these methods are called, otherwise they will throw an exception.
*System.Object ThinkGeo.MapSuite.WindowsPhoneCore.Layer *ThinkGeo.MapSuite.WindowsPhoneCore.BackgroundLayer *ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer *ThinkGeo.MapSuite.WindowsPhoneCore.GroupLayer *ThinkGeo.MapSuite.WindowsPhoneCore.InMemoryFeatureLayer *ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileFeatureLayer
Name | Parameters | DeclaringType | Summary |
---|
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
Layer | This is the default constructor for the Layer. |
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
Close | This method closes the Layer and releases any resources it was using. | ||
Draw | GeoCanvas, Collection<SimpleCandidate> | This method draws the Layer. | |
Equals | Object | Object | |
GetBoundingBox | This method returns the bounding box of the Layer. | ||
GetHashCode | Object | ||
GetType | Object | ||
Open | This method opens the Layer so that it is initialized and ready to use. | ||
ToString | Object |
Name | Parameters | DeclaringType | Summary |
---|---|---|---|
CloseCore | This method closes the Layer and releases any resources it was using. | ||
DrawCore | GeoCanvas, Collection<SimpleCandidate> | This method draws the Layer. | |
DrawException | GeoCanvas, Exception | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | |
DrawExceptionCore | GeoCanvas, Exception | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | |
Finalize | Object | ||
GetBoundingBoxCore | This method returns the bounding box of the Layer. | ||
MemberwiseClone | Object | ||
OnDrawingProgressChanged | DrawingProgressChangedEventArgs | ||
OpenCore | This method opens the Layer so that it is initialized and ready to use. |
Name | Return | DeclaringType | Summary |
---|---|---|---|
DrawingExceptionMode | DrawingExceptionMode | Gets or sets the DrawExcpetionMode when exception happens. | |
DrawingTime | TimeSpan | This property gets the last drawing time for the layer. | |
HasBoundingBox | Boolean | This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. | |
IsOpen | Boolean | This property returns true if the Layer is open and false if it is not. | |
IsVisible | Boolean | This property gets and set the visible state of the layer. | |
Name | String | This property gets and sets the name for the layer. |
Name | Return | DeclaringType | Summary |
---|---|---|---|
IsOpenCore | Boolean | This property returns true if the Layer is open and false if it is not. |
Name | Event Arguments | DeclaringType | Summary |
---|---|---|---|
DrawingProgressChanged | DrawingProgressChangedEventArgs |
This is the default constructor for the Layer.
Name | Type | Description |
---|
This method closes the Layer and releases any resources it was using.
This method is the concrete wrapper for the abstract method CloseCore. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.
If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This method draws the Layer.
This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | This parameter is the canvas object or a GeoImage to draw on. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | This parameter represents the labels used for collision detection and duplication checking. |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
Return Type | Description |
---|---|
Boolean<!– System.Boolean –> |
Name | Type | Description |
---|---|---|
obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
This method returns the bounding box of the Layer.
This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Type | Description |
---|---|
RectangleShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape –> | This method returns the bounding box of the Layer. |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
Return Type | Description |
---|---|
Int32<!– System.Int32 –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type | Description |
---|---|
Type<!– System.Type –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
This method opens the Layer so that it is initialized and ready to use.
This method is the concrete wrapper for the abstract method OpenCore. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer.
When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
Return Type | Description |
---|---|
String<!– System.String –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
This method closes the Layer and releases any resources it was using.
This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.
If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This method draws the Layer.
This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided.
When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | This parameter is the canvas object or a GeoImage to draw on. |
labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | This parameter represents the labels used for collision detection and duplication checking. |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
This method can be overriden its logic by rewrite the DrawExceptionCore.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | The target canvas to draw the layer. |
e | Exception<!– System.Exception –> | The exception thrown when layer.Draw(). |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | The target canvas to draw the layer. |
e | Exception<!– System.Exception –> | The exception thrown when layer.Draw(). |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
This method returns the bounding box of the Layer.
This method returns the bounding box of the Layer.
Return Type | Description |
---|---|
RectangleShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape –> | This method returns the bounding box of the Layer. |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
Return Type | Description |
---|---|
Object<!– System.Object –> |
Name | Type | Description |
---|
<!– System.Object –> Go Back
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|---|---|
e | DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This method opens the Layer so that it is initialized and ready to use.
This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer.
When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.
Return Type | Description |
---|---|
Void<!– System.Void –> |
Name | Type | Description |
---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
Gets or sets the DrawExcpetionMode when exception happens.
Return Type |
---|
DrawingExceptionMode<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingExceptionMode –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This property gets the last drawing time for the layer.
We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.
Return Type |
---|
TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.
The default value is false.
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This property returns true if the Layer is open and false if it is not.
This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This property gets and set the visible state of the layer.
If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This property gets and sets the name for the layer.
The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.
Return Type |
---|
String<!– System.String –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
This property returns true if the Layer is open and false if it is not.
Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
Return Type |
---|
Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
Event Arguments |
---|
DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back
NOTOC WindowsPhoneMapSuiteCore ThinkGeo.MapSuite.WindowsPhoneCore UpdateDocumentation