User Tools

Site Tools


thinkgeo.mapsuite.core.restrictionlayer

ThinkGeo.MapSuite.Core.RestrictionLayer

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.

This layer can show or hide one or many zones that you want to restrict from being displayed. You can use the specified style to decorate the zones and set the lower/upper scale to control at which zoom levels you want to show or hide the zones. The default decoration style is a hatch pattern. You can change this to a circle with slash image, or, if you want a different look, you can use custom styles.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.Layer
      • ThinkGeo.MapSuite.Core.RestrictionLayer

Members Summary

Public Constructors

RestrictionLayer()

  • Initializes a new instance of the RestictionLayer class.
Remarks
  • N/A
Parameters

RestrictionLayer(IEnumerable<AreaBaseShape>)

  • Initializes a new instance of the RestictionLayer class for the specified zones.
Remarks
  • N/A
Parameters

RestrictionLayer(IEnumerable<AreaBaseShape>,RestrictionMode)

  • Initializes a new instance of the RestictionLayer class for the specified zones and restriction mode.
Remarks
  • N/A
Parameters

RestrictionLayer(IEnumerable<AreaBaseShape>,RestrictionMode,Double,Double)

  • Initializes a new instance of the RestictionLayer class for the specified zones, restriction mode, upper scale and lower scale.
Remarks
  • N/A
Parameters
  • upperScale
    • Type:Double
    • Description:N/A
  • lowerScale
    • Type:Double
    • Description:N/A

Protected Constructors

Public Methods

RequestDrawing()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

GetThreadSafetyLevel()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

Open()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Close()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

GetBoundingBoxCore()

  • This method returns the bounding box of the zones.
Remarks
  • This method returns the bounding box of the zones.
Return Value
  • Description:This method returns the bounding box of the zones.
Parameters

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

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetThreadSafetyLevelCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

OpenCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

CloseCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawException(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

DrawExceptionCore(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnException(DrawnExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawAttributionCore(GeoCanvas,String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • attribution
    • Type:String
    • Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

UpperScale

Specifies the upper threshold of the layer.

Remarks

If Restriction mode is ShowZones:If currentScale is greater than UpperScale, it will hide the whole map; otherwise, it will show the specified zones.If Restriction mode is HideZones:If currentScale is less than or equal to UpperScale and greater than or equal to LowerScale, it will hide the specified zones; otherwise, it will do nothing.

Return Value
  • Type:Double

LowerScale

Specifies the lower threshold of the layer.

Remarks

If Restriction mode is ShowZones:If currentScale is less than LowerScale, it will hide the whole map; otherwise, it will show the specified zones.If Restriction mode is HideZones:if currentScale is less than or equal to UpperScale and greater than or equal to LowerScale, it will hide the specified zones; otherwise it will do nothing.

Return Value
  • Type:Double

CustomStyles

Allows you to add custom styles to decorate restriction zones. In this case, you must set RestrictionStyle to UseCustomStyles as well.

Remarks

N/A

Return Value

RestrictionMode

Specifies whether you want to show or hide zones.

Remarks

N/A

Return Value

Zones

Specifies the areas you want to restrict.

Remarks

N/A

Return Value
Remarks

N/A

Return Value

RequestDrawingInterval

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

IsOpen

N/A

Remarks

N/A

Return Value
  • Type:Boolean

HasBoundingBox

N/A

Remarks

N/A

Return Value
  • Type:Boolean

DrawingTime

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

Name

N/A

Remarks

N/A

Return Value
  • Type:String

Attribution

N/A

Remarks

N/A

Return Value
  • Type:String

IsVisible

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Transparency

N/A

Remarks

N/A

Return Value
  • Type:Single

BlueTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

RedTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

GreenTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

KeyColors

N/A

Remarks

N/A

Return Value

IsNegative

N/A

Remarks

N/A

Return Value
  • Type:Boolean

IsGrayscale

N/A

Remarks

N/A

Return Value
  • Type:Boolean

DrawingExceptionMode

N/A

Remarks

N/A

Return Value

Protected Properties

IsOpenCore

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Public Events

RequestedDrawing N/A

Remarks

N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing N/A

Remarks

N/A

Event Arguments:RequestingDrawingLayerEventArgs

DrawingProgressChanged N/A

Remarks

N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawingException N/A

Remarks

N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawnException N/A

Remarks

N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution N/A

Remarks

N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution N/A

Remarks

N/A

Event Arguments:DrawnAttributionLayerEventArgs

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