This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.core.layersdrawingeventargs [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.core.layersdrawingeventargs [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.LayersDrawingEventArgs ====== | ====== ThinkGeo.MapSuite.Core.LayersDrawingEventArgs ====== | ||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
This is the event arguments class for the LayersDrawing event on the MapEngine class. It is raised before any of the layers are drawn. | This is the event arguments class for the LayersDrawing event on the MapEngine class. It is raised before any of the layers are drawn. | ||
- | === Remarks === | ||
- | This is the event arguments class for the LayersDrawing event on the MapEngine class. It is raised before any of the layers are drawn. This event allows you to cancel, manipulate the Layer, or draw something with the canvas before the Layer draws. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **System.EventArgs | + | *System.EventArgs |
- | ***[[ThinkGeo.MapSuite.Core.LayersDrawingEventArgs]] | + | ***ThinkGeo.MapSuite.Core.LayersDrawingEventArgs** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} LayersDrawingEventArgs() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#LayersDrawingEventArgs()|LayersDrawingEventArgs]] | | | This is a constructor for the class. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#LayersDrawingEventArgs(IEnumerable<Layer>, RectangleShape, Object)|LayersDrawingEventArgs]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]>, [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Object | | This is a constructor for the class. | | + | |
- | ==== Protected Constructors ==== | + | * //This is a constructor for the class.// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //This is the default constructor. If you use this constructor, then you need to set the required properties manually.// | ||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} LayersDrawingEventArgs(IEnumerable<Layer>,RectangleShape,Object) ** | ||
+ | * //This is a constructor for the class.// | ||
+ | == Remarks == | ||
+ | * //None// | ||
+ | == Parameters == | ||
+ | * //layers// | ||
+ | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | ||
+ | * Description:This parameter is the layers that will be drawn. | ||
+ | |||
+ | * //worldExtent// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:This parameter is the world extent you are drawing. | ||
+ | |||
+ | * //nativeImage// | ||
+ | * Type:Object | ||
+ | * Description:This parameter is the GeoImage or native map image. | ||
+ | |||
+ | <div newline></div> | ||
+ | ==== Protected Constructors ==== | ||
==== Public Methods ==== | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
- | ==== Protected Methods ==== | + | * //N/A// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
- | ==== Public Properties ==== | + | == Return Value == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Cancel|Cancel]] | Boolean | | This property gets and sets the value that indicates you want to cancel all of the layers from drawing. | | + | * Description:N/A |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Layers|Layers]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | | This property gets and sets the layers you will be drawing. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#NativeImage|NativeImage]] | Object | | This property gets and sets the GeoImage or native image that we are drawing on. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#WorldExtent|WorldExtent]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | | This property gets and sets the world extent that will be drawn. | | + | |
- | ==== Protected Properties ==== | + | == Parameters == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
+ | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | ==== Public Events ==== | + | * //N/A// |
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //N/A// | ||
- | ===== Public Constructors ===== | + | == Return Value == |
- | ==== LayersDrawingEventArgs() ==== | + | * Type:Boolean |
- | This is a constructor for the class. | + | * Description:N/A |
- | === Overloads === | + | |
- | This is the default constructor. If you use this constructor, then you need to set the required properties manually. | + | |
- | === Remarks === | + | |
- | This is the default constructor. If you use this constructor, then you need to set the required properties manually. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ==== LayersDrawingEventArgs(IEnumerable<Layer>, RectangleShape, Object) ==== | + | * //obj// |
- | This is a constructor for the class. | + | * Type:Object |
- | === Overloads === | + | * Description:N/A |
- | This constructor allows you to set the layers to be drawn, the world extent, and the image you are drawing on. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | layers | IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Layer} --> | This parameter is the layers that will be drawn. | | + | |
- | | worldExtent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | This parameter is the world extent you are drawing. | | + | |
- | | nativeImage | Object<!-- System.Object --> | This parameter is the GeoImage or native map image. | | + | |
- | [[#Public Constructors|Go Back]] | + | <div newline></div> |
- | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | ===== Public Methods ===== | + | |
- | ==== Equals(Object) ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | obj | Object<!-- System.Object --> | | | + | * //N/A// |
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Int32 |
- | ==== GetHashCode() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Int32<!-- System.Int32 --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | <!-- System.Object --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== GetType() ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Type<!-- System.Type --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | ==== ToString() ==== | + | ==== Protected Methods ==== |
- | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ===== Protected Methods ===== | + | * Description:N/A |
- | ==== Finalize() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | <!-- System.Object --> | + | * //N/A// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== MemberwiseClone() ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ==== Public Properties ==== | ||
+ | ** {{wiki:PublicProperty.gif|}} Cancel ** | ||
- | <!-- System.Object --> | ||
- | [[#Protected Methods|Go Back]] | ||
- | ===== Public Properties ===== | ||
- | ==== Cancel ==== | ||
This property gets and sets the value that indicates you want to cancel all of the layers from drawing. | This property gets and sets the value that indicates you want to cancel all of the layers from drawing. | ||
- | === Return Value === | + | == Remarks == |
- | ^ Return Type ^ | + | None |
- | | Boolean<!-- System.Boolean --> | | + | == Return Value == |
+ | * Type:Boolean | ||
- | <!-- ThinkGeo.MapSuite.Core.LayersDrawingEventArgs --> | + | ** {{wiki:PublicProperty.gif|}} WorldExtent ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== Layers ==== | + | This property gets and sets the world extent that will be drawn. |
- | This property gets and sets the layers you will be drawing. | + | == Remarks == |
- | === Return Value === | + | None |
- | ^ Return Type ^ | + | == Return Value == |
- | | IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Layer} --> | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} NativeImage ** | ||
- | <!-- ThinkGeo.MapSuite.Core.LayersDrawingEventArgs --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== NativeImage ==== | ||
This property gets and sets the GeoImage or native image that we are drawing on. | This property gets and sets the GeoImage or native image that we are drawing on. | ||
- | === Return Value === | + | == Remarks == |
- | ^ Return Type ^ | + | None |
- | | Object<!-- System.Object --> | | + | == Return Value == |
+ | * Type:Object | ||
- | <!-- ThinkGeo.MapSuite.Core.LayersDrawingEventArgs --> | + | ** {{wiki:PublicProperty.gif|}} Layers ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== WorldExtent ==== | + | |
- | This property gets and sets the world extent that will be drawn. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | + | |
- | <!-- ThinkGeo.MapSuite.Core.LayersDrawingEventArgs --> | + | This property gets and sets the layers you will be drawing. |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ===== Protected Properties ===== | + | None |
- | ===== Public Events ===== | + | == Return Value == |
- | __NOTOC__ | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> |
- | [[Category:MapSuiteCore]] | + | |
- | [[Category:ThinkGeo.MapSuite.Core]] | + | ==== Protected Properties ==== |
- | [[Category:UpdateDocumentation]] | + | ==== Public Events ==== |