• System.Object
  • ThinkGeo.MapSuite.Core.Layer
    • ThinkGeo.MapSuite.Core.PrinterLayer
      • ThinkGeo.MapSuite.Core.ScaleBarPrinterLayer

AlternateBarBrush

• Return:GeoBrush
• Summary:The property is the GeoBrush that will be used to draw the alternate ScaleBar.

Attribution

• Return:String
• Summary:N/A

BackgroundMask

• Return:AreaStyle
• Summary:N/A

BarBrush

• Return:GeoBrush
• Summary:The property is the GeoBrush that will be used to draw the ScaleBar.

BlueTranslation

• Return:Single
• Summary:N/A

DisplayUnitString

• Return:Dictionary<String,String>
• Summary:This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.

DragMode

• Return:PrinterDragMode
• Summary:N/A

DrawingExceptionMode

• Return:DrawingExceptionMode
• Summary:N/A

DrawingTime

• Return:TimeSpan
• Summary:N/A

GreenTranslation

• Return:Single
• Summary:N/A

GridPen

• Return:GeoPen
• Summary:N/A

HasBoundingBox

• Return:Boolean
• Summary:N/A

HasMask

• Return:Boolean
• Summary:Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.

Height

• Return:Int32
• Summary:Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.

IsDrawing

• Return:Boolean
• Summary:N/A

IsGrayscale

• Return:Boolean
• Summary:N/A

IsNegative

• Return:Boolean
• Summary:N/A

IsOpen

• Return:Boolean
• Summary:N/A

IsVisible

• Return:Boolean
• Summary:N/A

KeyColors

• Return:Collection<GeoColor>
• Summary:N/A

MapPrinterLayer

• Return:MapPrinterLayer
• Summary:N/A

MapUnit

• Return:GeographyUnit
• Summary:N/A

MaskBrush

• Return:GeoBrush
• Summary:Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.

MaskOuterPen

• Return:GeoPen
• Summary:Gets or sets the pen for the outline of the ScaleBar mask.

MaxWidth

• Return:Int32
• Summary:Gets or Sets the MaxWidth of the ScaleBar.

Name

• Return:String
• Summary:N/A

RedTranslation

• Return:Single
• Summary:N/A

RequestDrawingInterval

• Return:TimeSpan
• Summary:N/A

ResizeMode

• Return:PrinterResizeMode
• Summary:N/A

SelectabilityMode

• Return:SelectabilityMode
• Summary:N/A

TextStyle

• Return:TextStyle
• Summary:N/A

Transparency

• Return:Single
• Summary:N/A

UnitFamily

• Return:UnitSystem
• Summary:Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.

IsOpenCore

• Return:Boolean
• Summary:N/A

DrawingAttribution

• Event Arguments:DrawingAttributionLayerEventArgs
• Summary:N/A

DrawingException

• Event Arguments:DrawingExceptionLayerEventArgs
• Summary:N/A

DrawingProgressChanged

• Event Arguments:DrawingProgressChangedEventArgs
• Summary:N/A

DrawnAttribution

• Event Arguments:DrawnAttributionLayerEventArgs
• Summary:N/A

DrawnException

• Event Arguments:DrawnExceptionLayerEventArgs
• Summary:N/A

RequestedDrawing

• Event Arguments:RequestedDrawingLayerEventArgs
• Summary:N/A

RequestingDrawing

• Event Arguments:RequestingDrawingLayerEventArgs
• Summary:N/A

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).

mapPrinterLayer

• Type:MapPrinterLayer
• Description:N/A Go Back ===== Protected Constructors ===== ===== Public Methods ===== === CloneDeep() === N/A ==== Remarks ==== N/A Return Value * Return Type:Layer * Description:N/A ==== Parameters ==== Go Back === Close() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === Draw(GeoCanvas,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A labelsInAllLayers * Type:Collection<SimpleCandidate> * Description:N/A Go Back === Equals(Object) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== obj * Type:Object * Description:N/A Go Back === GetBoundingBox() === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * Description:N/A ==== Parameters ==== Go Back === GetHashCode() === N/A ==== Remarks ==== N/A Return Value * Return Type:Int32 * Description:N/A ==== Parameters ==== Go Back === GetPosition() === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * Description:N/A ==== Parameters ==== Go Back === GetPosition(PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * Description:N/A ==== Parameters ==== unit * Type:PrintingUnit * Description:N/A Go Back === GetThreadSafetyLevel() === N/A ==== Remarks ==== N/A Return Value * Return Type:ThreadSafetyLevel * Description:N/A ==== Parameters ==== Go Back === GetType() === N/A ==== Remarks ==== N/A Return Value * Return Type:Type * Description:N/A ==== Parameters ==== Go Back === Open() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === RequestDrawing(IEnumerable<RectangleShape>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentsToRefresh * Type:IEnumerable<RectangleShape> * Description:N/A Go Back === RequestDrawing(RectangleShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentToRefresh * Type:RectangleShape * Description:N/A Go Back === RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentsToRefresh * Type:IEnumerable<RectangleShape> * Description:N/A bufferTime * Type:TimeSpan * Description:N/A bufferTimeType * Type:RequestDrawingBufferTimeType * Description:N/A Go Back === RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentsToRefresh * Type:IEnumerable<RectangleShape> * Description:N/A bufferTime * Type:TimeSpan * Description:N/A Go Back === RequestDrawing(RectangleShape,TimeSpan) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentToRefresh * Type:RectangleShape * Description:N/A bufferTime * Type:TimeSpan * Description:N/A Go Back === RequestDrawing() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== bufferTime * Type:TimeSpan * Description:N/A bufferTimeType * Type:RequestDrawingBufferTimeType * Description:N/A Go Back === RequestDrawing(TimeSpan) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== bufferTime * Type:TimeSpan * Description:N/A Go Back === RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== extentToRefresh * Type:RectangleShape * Description:N/A bufferTime * Type:TimeSpan * Description:N/A bufferTimeType * Type:RequestDrawingBufferTimeType * Description:N/A Go Back === SetPosition(Double,Double,LayerAnchorLocation,Double,Double,PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== width * Type:Double * Description:N/A height * Type:Double * Description:N/A corner * Type:LayerAnchorLocation * Description:N/A cornerPointX * Type:Double * Description:N/A cornerPointY * Type:Double * Description:N/A unit * Type:PrintingUnit * Description:N/A Go Back === SetPosition(Double,Double,Double,Double,PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return 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 unit * Type:PrintingUnit * Description:N/A Go Back === SetPosition(Double,Double,PointShape,PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== width * Type:Double * Description:N/A height * Type:Double * Description:N/A centerPoint * Type:PointShape * Description:N/A unit * Type:PrintingUnit * Description:N/A Go Back === SetPosition(RectangleShape,PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== boundingBox * Type:RectangleShape * Description:N/A unit * Type:PrintingUnit * Description:N/A Go Back === SetPosition(RectangleShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== boundingBox * Type:RectangleShape * Description:N/A Go Back === SetPosition(Double,Double,LayerAnchorLocation,PointShape,PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== width * Type:Double * Description:N/A height * Type:Double * Description:N/A corner * Type:LayerAnchorLocation * Description:N/A cornerPoint * Type:PointShape * Description:N/A unit * Type:PrintingUnit * Description:N/A Go Back === ToString() === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== Go Back ===== Protected Methods ===== === CloneDeepCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Layer * Description:N/A ==== Parameters ==== Go Back === CloseCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === DrawAttributionCore(GeoCanvas,String) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A attribution * Type:String * Description:N/A 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:Void * Description:None ==== Parameters ==== canvas * Type:GeoCanvas * Description:This parameter is the canvas object or a GeoImage to draw on. labelsInAllLayers * Type:Collection<SimpleCandidate> * Description:This parameter represents the labels used for collision detection and duplication checking. Go Back === DrawException(GeoCanvas,Exception) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A e * Type:Exception * Description:N/A Go Back === DrawExceptionCore(GeoCanvas,Exception) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A e * Type:Exception * Description:N/A Go Back === Finalize() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === GetBoundingBoxCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * Description:N/A ==== Parameters ==== Go Back === GetPositionCore(PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * Description:N/A ==== Parameters ==== unit * Type:PrintingUnit * Description:N/A Go Back === GetThreadSafetyLevelCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:ThreadSafetyLevel * Description:N/A ==== Parameters ==== Go Back === MemberwiseClone() === N/A ==== Remarks ==== N/A Return Value * Return Type:Object * Description:N/A ==== Parameters ==== Go Back === OnDrawingAttribution(DrawingAttributionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== args * Type:DrawingAttributionLayerEventArgs * Description:N/A Go Back === OnDrawingException(DrawingExceptionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:DrawingExceptionLayerEventArgs * Description:N/A Go Back === OnDrawingProgressChanged(DrawingProgressChangedEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:DrawingProgressChangedEventArgs * Description:N/A Go Back === OnDrawnAttribution(DrawnAttributionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== args * Type:DrawnAttributionLayerEventArgs * Description:N/A Go Back === OnDrawnException(DrawnExceptionLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:DrawnExceptionLayerEventArgs * Description:N/A Go Back === OnRequestedDrawing(RequestedDrawingLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== eventArgs * Type:RequestedDrawingLayerEventArgs * Description:N/A Go Back === OnRequestingDrawing(RequestingDrawingLayerEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== eventArgs * Type:RequestingDrawingLayerEventArgs * Description:N/A Go Back === OpenCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === SetPositionCore(Double,Double,Double,Double,PrintingUnit) === N/A ==== Remarks ==== N/A Return Value * Return Type:RectangleShape * 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 unit * Type:PrintingUnit * Description:N/A Go Back ===== Public Properties ===== === AlternateBarBrush === The property is the GeoBrush that will be used to draw the alternate ScaleBar. ==== Remarks ==== This AlternateBarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer. ==== Return Value ==== Return Type:GeoBrush Go Back === Attribution === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:String Go Back === BackgroundMask === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:AreaStyle Go Back === BarBrush === The property is the GeoBrush that will be used to draw the ScaleBar. ==== Remarks ==== This BarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer. ==== Return Value ==== Return Type:GeoBrush Go Back === BlueTranslation === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === DisplayUnitString === This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit. ==== Remarks ==== We will display different letters for different units of measure; for example: “m” for meters, “ft” for feet, etc. ==== Return Value ==== Return Type:Dictionary<String,String> Go Back === DragMode === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:PrinterDragMode Go Back === DrawingExceptionMode === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:DrawingExceptionMode Go Back === DrawingTime === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:TimeSpan Go Back === GreenTranslation === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === GridPen === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:GeoPen Go Back === HasBoundingBox === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === HasMask === Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown. ==== Remarks ==== 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 ==== Return Type:Boolean Go Back === Height === Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units. ==== Remarks ==== N/A ==== Return Value ==== Return Type:Int32 Go Back === IsDrawing === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsGrayscale === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsNegative === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsOpen === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === IsVisible === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === KeyColors === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Collection<GeoColor> Go Back === MapPrinterLayer === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:MapPrinterLayer Go Back === MapUnit === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:GeographyUnit Go Back === MaskBrush === Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true. ==== Remarks ==== N/A ==== Return Value ==== Return Type:GeoBrush Go Back === MaskOuterPen === Gets or sets the pen for the outline of the ScaleBar mask. ==== Remarks ==== 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 ==== Return Type:GeoPen Go Back === MaxWidth === Gets or Sets the MaxWidth of the ScaleBar. ==== Remarks ==== 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 ==== Return Type:Int32 Go Back === Name === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:String Go Back === RedTranslation === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === RequestDrawingInterval === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:TimeSpan Go Back === ResizeMode === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:PrinterResizeMode Go Back === SelectabilityMode === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:SelectabilityMode Go Back === TextStyle === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:TextStyle Go Back === Transparency === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === UnitFamily === Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar. ==== Remarks ==== By setting this property, you can control whether to use a metric or imperial measurement system for the ScaleBar. ==== Return Value ==== Return Type:UnitSystem Go Back ===== Protected Properties ===== === IsOpenCore === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back ===== Public Events ===== === DrawingAttribution === N/A ==== Remarks ==== N/A Event Arguments:DrawingAttributionLayerEventArgs Go Back === DrawingException === N/A ==== Remarks ==== N/A Event Arguments:DrawingExceptionLayerEventArgs Go Back === DrawingProgressChanged === N/A ==== Remarks ==== N/A Event Arguments:DrawingProgressChangedEventArgs Go Back === DrawnAttribution === N/A ==== Remarks ==== N/A Event Arguments:DrawnAttributionLayerEventArgs Go Back === DrawnException === N/A ==== Remarks ==== N/A Event Arguments:DrawnExceptionLayerEventArgs Go Back === RequestedDrawing === N/A ==== Remarks ==== N/A Event Arguments:RequestedDrawingLayerEventArgs Go Back === RequestingDrawing === N/A ==== Remarks ==== N/A Event Arguments**:RequestingDrawingLayerEventArgs

Go Back