Table of Contents

Class BackgroundLayer

Namespace
ThinkGeo.Core
Assembly
ThinkGeo.Core.dll

This class draws the background of the map.

public class BackgroundLayer : Layer
Inheritance
BackgroundLayer
Inherited Members

Remarks

This class draws the background of the map.

Constructors

BackgroundLayer()

This is the default constructor for the class.

public BackgroundLayer()

Remarks

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

BackgroundLayer(GeoBrush)

This is a constructor for the class.

public BackgroundLayer(GeoBrush backgroundBrush)

Parameters

backgroundBrush GeoBrush

This parameter is the brush that will be used draw the background layer.

Remarks

None

Properties

BackgroundBrush

This property gets and sets the brush for this background layer.

public GeoBrush BackgroundBrush { get; set; }

Property Value

GeoBrush

Remarks

None

Exceptions

ArgumentNullException

If you pass a null as the Brush, we will throw an ArgumentNullException.

Methods

DrawCore(GeoCanvas, Collection<SimpleCandidate>)

This method will draw the background layer based on the parameters provided.

protected override void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)

Parameters

canvas GeoCanvas

This parameter is the GeoCanvas used to Draw the layer.

labelsInAllLayers Collection<SimpleCandidate>

This parameter is not used for BackgroundLayers.

Remarks

None

Exceptions

InvalidOperationException

In the event you attempt to call this method on a FeatureLayer that is not opened, it will throw an InvalidOperationException.

ArgumentNullException

If you pass a null as the labeledInLayers, we will throw an ArgumentNullException.

ArgumentNullException

If you pass a null as the worldExtent, we will throw an ArgumentNullException.

ArgumentNullException

If you pass a null as the image, we will throw an ArgumentNullException.