ThinkGeo.MapSuite.Core.ScaleBarPrinterLayer
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.
Inheritance Hierarchy
Members Summary
Public Constructors
ScaleBarPrinterLayer(MapPrinterLayer)
Creates a new instance of the ScaleBarAdornmentLayer class.
The ScaleBar will not be drawn when the CurrentExtent is outside of the world Extent(-90,180-,90,-180).
Parameters
Protected Constructors
Public Methods
GetPosition()
N/A
Return Value
Parameters
GetPosition(PrintingUnit)
N/A
Return Value
Parameters
SetPosition(RectangleShape)
N/A
Return Value
Type:Void
Description:N/A
Parameters
SetPosition(RectangleShape,PrintingUnit)
N/A
Return Value
Type:Void
Description:N/A
Parameters
SetPosition(Double,Double,PointShape,PrintingUnit)
N/A
Return Value
Type:Void
Description:N/A
Parameters
width
Type:Double
Description:N/A
height
Type:Double
Description:N/A
SetPosition(Double,Double,Double,Double,PrintingUnit)
N/A
Return Value
Type:Void
Description:N/A
Parameters
width
Type:Double
Description:N/A
height
Type:Double
Description:N/A
centerPointX
Type:Double
Description:N/A
centerPointY
Type:Double
Description:N/A
SetPosition(Double,Double,LayerAnchorLocation,PointShape,PrintingUnit)
N/A
Return Value
Type:Void
Description:N/A
Parameters
width
Type:Double
Description:N/A
height
Type:Double
Description:N/A
SetPosition(Double,Double,LayerAnchorLocation,Double,Double,PrintingUnit)
N/A
Return Value
Type:Void
Description:N/A
Parameters
width
Type:Double
Description:N/A
height
Type:Double
Description:N/A
cornerPointX
Type:Double
Description:N/A
cornerPointY
Type:Double
Description:N/A
RequestDrawing()
N/A
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(RectangleShape)
N/A
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(IEnumerable<RectangleShape>)
N/A
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(TimeSpan)
N/A
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
N/A
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(RectangleShape,TimeSpan)
N/A
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
N/A
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
N/A
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
N/A
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
GetThreadSafetyLevel()
N/A
Return Value
Parameters
CloneDeep()
N/A
Return Value
Parameters
Open()
N/A
Return Value
Type:Void
Description:N/A
Parameters
Close()
N/A
Return Value
Type:Void
Description:N/A
Parameters
GetBoundingBox()
N/A
Return Value
Parameters
Draw(GeoCanvas,Collection<SimpleCandidate>)
N/A
Return Value
Type:Void
Description:N/A
Parameters
ToString()
N/A
Return Value
Type:String
Description:N/A
Parameters
Equals(Object)
N/A
Return Value
Type:Boolean
Description:N/A
Parameters
obj
Type:Object
Description:N/A
GetHashCode()
N/A
Return Value
Type:Int32
Description:N/A
Parameters
GetType()
N/A
Return Value
Type:Type
Description:N/A
Parameters
Protected Methods
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
This method draws the Layer.
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
Type:Void
Description:None
Parameters
GetBoundingBoxCore()
N/A
Return Value
Parameters
GetPositionCore(PrintingUnit)
N/A
Return Value
Parameters
SetPositionCore(Double,Double,Double,Double,PrintingUnit)
N/A
Return Value
Parameters
width
Type:Double
Description:N/A
height
Type:Double
Description:N/A
centerPointX
Type:Double
Description:N/A
centerPointY
Type:Double
Description:N/A
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
N/A
Return Value
Type:Void
Description:N/A
Parameters
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
N/A
Return Value
Type:Void
Description:N/A
Parameters
GetThreadSafetyLevelCore()
N/A
Return Value
Parameters
CloneDeepCore()
N/A
Return Value
Parameters
OpenCore()
N/A
Return Value
Type:Void
Description:N/A
Parameters
CloseCore()
N/A
Return Value
Type:Void
Description:N/A
Parameters
DrawException(GeoCanvas,Exception)
N/A
Return Value
Type:Void
Description:N/A
Parameters
e
Type:Exception
Description:N/A
DrawExceptionCore(GeoCanvas,Exception)
N/A
Return Value
Type:Void
Description:N/A
Parameters
e
Type:Exception
Description:N/A
OnDrawingException(DrawingExceptionLayerEventArgs)
N/A
Return Value
Type:Void
Description:N/A
Parameters
OnDrawnException(DrawnExceptionLayerEventArgs)
N/A
Return Value
Type:Void
Description:N/A
Parameters
DrawAttributionCore(GeoCanvas,String)
N/A
Return Value
Type:Void
Description:N/A
Parameters
attribution
Type:String
Description:N/A
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
N/A
Return Value
Type:Void
Description:N/A
Parameters
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
N/A
Return Value
Type:Void
Description:N/A
Parameters
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
N/A
Return Value
Type:Void
Description:N/A
Parameters
Finalize()
N/A
Return Value
Type:Void
Description:N/A
Parameters
MemberwiseClone()
N/A
Return Value
Type:Object
Description:N/A
Parameters
Public Properties
MapPrinterLayer
N/A
Return Value
MapUnit
N/A
Return Value
DisplayUnitString
This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.
We will display different letters for different units of measure; for example: “m” for meters, “ft” for feet, etc.
Return Value
UnitFamily
Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.
By setting this property, you can control whether to use a metric or imperial measurement system for the ScaleBar.
Return Value
Height
Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.
Return Value
MaxWidth
Gets or Sets the MaxWidth of the ScaleBar.
You can use this property to set the maximum width that you want the ScaleBar to occupy on the map. The ScaleBarAdornmentLayer will automatically adjust its size based upon the current extent of the map. By setting this property, you can control the maximum width the ScaleBar will occupy on the map.
Return Value
BarBrush
The property is the GeoBrush that will be used to draw the ScaleBar.
This BarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.
Return Value
GridPen
N/A
Return Value
TextStyle
N/A
Return Value
AlternateBarBrush
The property is the GeoBrush that will be used to draw the alternate ScaleBar.
This AlternateBarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.
Return Value
MaskBrush
Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.
Return Value
HasMask
Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.
Depending upon the look of your map and your requirements, you may or may not want a mask on the ScaleBar. You can control whether or not the ScaleBar has a mask by setting this property. If you set the HasMask property to true, be sure to specify a mask color (or texture) by using the MaskBrush property.
Return Value
MaskOuterPen
Gets or sets the pen for the outline of the ScaleBar mask.
By using this property you can control the border of the mask, if the HasMask property is set to true. If you do not want a contour or border to show, you should set the pen to transparent.
Return Value
IsDrawing
N/A
Return Value
HasBoundingBox
N/A
Return Value
BackgroundMask
N/A
Return Value
ResizeMode
N/A
Return Value
DragMode
N/A
Return Value
SelectabilityMode
N/A
Return Value
RequestDrawingInterval
N/A
Return Value
IsOpen
N/A
Return Value
DrawingTime
N/A
Return Value
Name
N/A
Return Value
Attribution
N/A
Return Value
IsVisible
N/A
Return Value
Transparency
N/A
Return Value
BlueTranslation
N/A
Return Value
RedTranslation
N/A
Return Value
GreenTranslation
N/A
Return Value
KeyColors
N/A
Return Value
IsNegative
N/A
Return Value
IsGrayscale
N/A
Return Value
DrawingExceptionMode
N/A
Return Value
Protected Properties
IsOpenCore
N/A
Return Value
Public Events
RequestedDrawing
N/A