====== ThinkGeo.MapSuite.Layers.RestrictionLayer ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.Layers.Layer ***ThinkGeo.MapSuite.Layers.RestrictionLayer** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} RestrictionLayer() ** * //Initializes a new instance of the RestictionLayer class.// == Remarks == * //N/A// == Parameters ==
** {{wiki:PublicMethod.gif|}} RestrictionLayer(IEnumerable) ** * //Initializes a new instance of the RestictionLayer class for the specified zones.// == Remarks == * //N/A// == Parameters == * //zones// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.AreaBaseShape|AreaBaseShape]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RestrictionLayer(IEnumerable,RestrictionMode) ** * //Initializes a new instance of the RestictionLayer class for the specified zones and restriction mode.// == Remarks == * //N/A// == Parameters == * //zones// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.AreaBaseShape|AreaBaseShape]]> * Description:N/A * //zonesToShowOrHide// * Type:[[ThinkGeo.MapSuite.Layers.RestrictionMode|RestrictionMode]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RestrictionLayer(IEnumerable,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 == * //zones// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.AreaBaseShape|AreaBaseShape]]> * Description:N/A * //zonesToShowOrHide// * Type:[[ThinkGeo.MapSuite.Layers.RestrictionMode|RestrictionMode]] * Description:N/A * //upperScale// * Type:Double * Description:N/A * //lowerScale// * Type:Double * Description:N/A
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.ThreadSafetyLevel|ThreadSafetyLevel]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} CloneDeep() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Open() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Close() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Layers.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** * //N/A// == Remarks == * //This method returns the bounding box of the zones.// == Return Value == * Type:[[ThinkGeo.MapSuite.Shapes.RectangleShape|RectangleShape]] * Description:This method returns the bounding box of the zones. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection) ** * //N/A// == 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:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:This parameter is the canvas object or a GeoImage to draw on. * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:This parameter represents the labels used for collision detection and duplication checking.
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.MapSuite.Layers.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.ThreadSafetyLevel|ThreadSafetyLevel]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Layers.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Layers.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //attribution// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.Layers.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.Layers.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Drawing.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.MapSuite.Layers.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} UpperScale ** * //N/A// == 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 ** {{wiki:PublicProperty.gif|}} LowerScale ** * //N/A// == 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 ** {{wiki:PublicProperty.gif|}} CustomStyles ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.GeoCollection[[ThinkGeo.MapSuite.Styles.Style, ThinkGeo.MapSuite, Version=10.0.0.0, Culture=neutral, PublicKeyToken=0828af5241fb4207]]|GeoCollection]] ** {{wiki:PublicProperty.gif|}} RestrictionMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.RestrictionMode|RestrictionMode]] ** {{wiki:PublicProperty.gif|}} Zones ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.GeoCollection[[ThinkGeo.MapSuite.Shapes.AreaBaseShape, ThinkGeo.MapSuite, Version=10.0.0.0, Culture=neutral, PublicKeyToken=0828af5241fb4207]]|GeoCollection]] ** {{wiki:PublicProperty.gif|}} RestrictionStyle ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Layers.RestrictionStyle|RestrictionStyle]] ** {{wiki:PublicProperty.gif|}} IsOpen ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} DrawingTime ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} Name ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Attribution ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} IsVisible ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} Transparency ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} BlueTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} RedTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} GreenTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} KeyColors ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection<[[ThinkGeo.MapSuite.Drawing.GeoColor|GeoColor]]> ** {{wiki:PublicProperty.gif|}} IsNegative ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsGrayscale ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} ColorMappings ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary<[[ThinkGeo.MapSuite.Drawing.GeoColor|GeoColor]],[[ThinkGeo.MapSuite.Drawing.GeoColor|GeoColor]]> ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Drawing.DrawingExceptionMode|DrawingExceptionMode]] ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} StatusChanged ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Drawing.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.MapSuite.Layers.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]