User Tools

Site Tools


thinkgeo.mapsuite.windowsphonecore.grouplayer

ThinkGeo.MapSuite.WindowsPhoneCore.GroupLayer

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 represents a Layer backed by a group of layers.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodGroupLayer This is the default constructor for the class.
Public MethodGroupLayer IEnumerable<Layer> This is a constructor for the class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodClose Layer This method closes the Layer and releases any resources it was using.
Public MethodDraw GeoCanvas, Collection<SimpleCandidate> Layer This method draws the Layer.
Public MethodEquals Object Object
Public MethodGetBoundingBox Layer This method returns the bounding box of the Layer.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodOpen Layer This method opens the Layer so that it is initialized and ready to use.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloseCore Layer(overriden) This method closes the FeatureSource and releases any resources it was using.
Protected MethodDrawCore GeoCanvas, Collection<SimpleCandidate> Layer(overriden) This method draws the Layer.
Protected MethodDrawException GeoCanvas, Exception Layer This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodDrawExceptionCore GeoCanvas, Exception Layer This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodFinalize Object
Protected MethodGetBoundingBoxCore Layer(overriden) This method returns the bounding box of the Layer.
Protected MethodMemberwiseClone Object
Protected MethodOnDrawingProgressChanged DrawingProgressChangedEventArgs Layer
Protected MethodOpenCore Layer(overriden) This method opens the Layer so that it is initialized and ready to use.

Public Properties

Name Return DeclaringType Summary
Public PropertyDrawingExceptionMode DrawingExceptionMode Layer Gets or sets the DrawExcpetionMode when exception happens.
Public PropertyDrawingTime TimeSpan Layer This property gets the last drawing time for the layer.
Public PropertyHasBoundingBox Boolean Layer(overriden) This property checks to see if 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. In GroupLayer, we override this API and mark it as true.
Public PropertyIsOpen Boolean Layer This property returns true if the Layer is open and false if it is not.
Public PropertyIsVisible Boolean Layer This property gets and set the visible state of the layer.
Public PropertyLayers GeoCollection<Layer> This property gets the layers you want to use.
Public PropertyName String Layer This property gets and sets the name for the layer.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyIsOpenCore Boolean Layer This property returns true if the Layer is open and false if it is not.

Public Events

Name Event Arguments DeclaringType Summary
Public EventDrawingProgressChanged DrawingProgressChangedEventArgs Layer

Public Constructors

GroupLayer()

This is the default constructor for the class.

Overloads

This is the default constructor. If you use this constructor, then you need to set the required properties manually.

Remarks

This is the default constructor. If you use this constructor, then you need to set the required properties manually.

Parameters

Name Type Description

Go Back

GroupLayer(IEnumerable<Layer>)

This is a constructor for the class.

Overloads

This constructor allows you to provide the path and filename information for the group.

Remarks

This constructor gets the layer ready to use.

Parameters

Name Type Description
layers IEnumerable<Layer><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.WindowsPhoneCore.Layer} –> This parameter represents the layers in this class that you want to use.

Go Back

Protected Constructors

Public Methods

Close()

This method closes the Layer and releases any resources it was using.

Remarks

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 Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

Draw(GeoCanvas, Collection<SimpleCandidate>)

This method draws the Layer.

Remarks

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 Value

Return Type Description
Void<!– System.Void –>

Parameters

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

Equals(Object)

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetBoundingBox()

This method returns the bounding box of the Layer.

Remarks

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 Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape –> This method returns the bounding box of the Layer.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

GetHashCode()

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Open()

This method opens the Layer so that it is initialized and ready to use.

Remarks

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 Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

ToString()

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

CloseCore()

This method closes the FeatureSource and releases any resources it was using.

Remarks

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 the Core version of 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 Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer(overriden) –> Go Back

DrawCore(GeoCanvas, Collection<SimpleCandidate>)

This method draws the Layer.

Remarks

This abstract method is called from the concrete public method Draw. 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 to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

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 are the labels used for collision detection and duplication checking.

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer(overriden) –> Go Back

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.

Remarks

This method can be overriden its logic by rewrite the DrawExceptionCore.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

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

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.

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

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

Finalize()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetBoundingBoxCore()

This method returns the bounding box of the Layer.

Remarks

This method returns the bounding box of the Layer.

Return Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape –> This method returns the bounding box of the Layer.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer(overriden) –> Go Back

MemberwiseClone()

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

OpenCore()

This method opens the Layer so that it is initialized and ready to use.

Remarks

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, it will open the layer 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 Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer(overriden) –> Go Back

Public Properties

DrawingExceptionMode

Gets or sets the DrawExcpetionMode when exception happens.

Return Value

Return Type
DrawingExceptionMode<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingExceptionMode –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

DrawingTime

This property gets the last drawing time for the layer.

Remarks

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 Value

Return Type
TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

HasBoundingBox

This property checks to see if 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. In GroupLayer, we override this API and mark it as true.

Remarks

The default implementation in the base class returns false.

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer(overriden) –> Go Back

IsOpen

This property returns true if the Layer is open and false if it is not.

Remarks

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 Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

IsVisible

This property gets and set the visible state of the layer.

Remarks

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 Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

Layers

This property gets the layers you want to use.

Remarks

This property gets the layers you want to use.

Return Value

Return Type
GeoCollection<Layer><!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCollection{ThinkGeo.MapSuite.WindowsPhoneCore.Layer} –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.GroupLayer –> Go Back

Name

This property gets and sets the name for the layer.

Remarks

The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

Protected Properties

IsOpenCore

This property returns true if the Layer is open and false if it is not.

Remarks

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 Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

Public Events

DrawingProgressChanged

Event Arguments

Event Arguments
DrawingProgressChangedEventArgs<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs –>

<!– ThinkGeo.MapSuite.WindowsPhoneCore.Layer –> Go Back

NOTOC WindowsPhoneMapSuiteCore ThinkGeo.MapSuite.WindowsPhoneCore UpdateDocumentation

thinkgeo.mapsuite.windowsphonecore.grouplayer.txt · Last modified: 2017/03/16 21:59 (external edit)