thinkgeo.mapsuite.desktopedition.overlaydrawingwinformsmapeventargs
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.desktopedition.overlaydrawingwinformsmapeventargs [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.desktopedition.overlaydrawingwinformsmapeventargs [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs ====== | ====== ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This is the event arguments for the OverlayDrawing event on the MapEngine class. It is raised before any of the overlays are drawn. | This is the event arguments for the OverlayDrawing event on the MapEngine class. It is raised before any of the overlays are drawn. | ||
| - | === Remarks === | ||
| - | This is the event arguments for the OverlayDrawing event on the MapEngine class. It is raised before any of the overlays 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.DesktopEdition.OverlayDrawingWinformsMapEventArgs]] | + | ***ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} OverlayDrawingWinformsMapEventArgs() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#OverlayDrawingWinformsMapEventArgs()|OverlayDrawingWinformsMapEventArgs]] | | | This is a constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#OverlayDrawingWinformsMapEventArgs(Overlay, GeoCanvas, Boolean)|OverlayDrawingWinformsMapEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]], [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Boolean | | 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|}} OverlayDrawingWinformsMapEventArgs(Overlay,GeoCanvas,Boolean) ** | ||
| + | * //This is a constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#OverlayDrawingWinformsMapEventArgs.28Overlay.2C_GeoCanvas.2C_Boolean.29// | ||
| + | == Parameters == | ||
| + | * //overlay// | ||
| + | * Type:[[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | ||
| + | * Description:This parameter is the overlay that will be drawn. | ||
| + | |||
| + | * //canvas// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| + | * Description:This parameter is the GeoCanvas we are drawing on. | ||
| + | |||
| + | * //cancel// | ||
| + | * Type:Boolean | ||
| + | * Description:This parameter specifies whether or not we will cancel drawing of the overlay. | ||
| + | |||
| + | <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 | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#ToString.28.29// |
| - | | {{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 or sets whether the action will be canceled or not. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Canvas|Canvas]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | | This property gets and sets the GeoCanvas we are drawing on. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Overlay|Overlay]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | This property gets and sets the overlay you will be drawing. | | + | |
| - | ==== 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 == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Equals.28Object.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== OverlayDrawingWinformsMapEventArgs() ==== | + | * 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 == |
| - | ==== OverlayDrawingWinformsMapEventArgs(Overlay, GeoCanvas, Boolean) ==== | + | * //obj// |
| - | This is a constructor for the class. | + | * Type:Object |
| - | === Overloads === | + | * Description:N/A |
| - | This constructor allows you to set the overlay to be drawn, the world extent and the image you are drawing on. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#OverlayDrawingWinformsMapEventArgs.28Overlay.2C_GeoCanvas.2C_Boolean.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#OverlayDrawingWinformsMapEventArgs.28Overlay.2C_GeoCanvas.2C_Boolean.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | overlay | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]]<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | This parameter is the overlay that will be drawn. | | + | |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the GeoCanvas we are drawing on. | | + | |
| - | | cancel | Boolean<!-- System.Boolean --> | This parameter specifies whether or not we will cancel drawing of the overlay. | | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ===== Public Methods ===== | + | |
| - | ==== Equals(Object) ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#GetHashCode.28.29// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetHashCode() ==== | + | * Description:N/A |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#GetHashCode.28.29</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() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#GetType.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#GetType.28.29</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 ==== |
| - | === Remarks === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Finalize.28.29// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | ==== Finalize() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Finalize.28.29</a> | + | |
| - | === 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() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#MemberwiseClone.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ===== Public Properties ===== | + | ==== Public Properties ==== |
| - | ==== Cancel ==== | + | ** {{wiki:PublicProperty.gif|}} Cancel ** |
| - | This property gets or sets whether the action will be canceled or not. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Cancel" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Cancel</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs --> | + | * //This property gets or sets whether the action will be canceled or not.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== Canvas ==== | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#Cancel// |
| - | This property gets and sets the GeoCanvas we are drawing on. | + | == Return Value == |
| - | === Remarks === | + | * Type:Boolean |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#OverlayDrawingWinformsMapEventArgs.28Overlay.2C_GeoCanvas.2C_Boolean.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#OverlayDrawingWinformsMapEventArgs.28Overlay.2C_GeoCanvas.2C_Boolean.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | + | |
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs --> | + | ** {{wiki:PublicProperty.gif|}} Canvas ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== Overlay ==== | + | |
| - | This property gets and sets the overlay you will be drawing. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#firstHeading" class="firstHeading" lang="en"><span dir="auto" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#firstHeading" class="firstHeading" lang="en"><span dir="auto</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]]<!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | | + | |
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs --> | + | * //This property gets and sets the GeoCanvas we are drawing on.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ===== Protected Properties ===== | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#OverlayDrawingWinformsMapEventArgs.28Overlay.2C_GeoCanvas.2C_Boolean.29// |
| - | ===== Public Events ===== | + | == Return Value == |
| - | __NOTOC__ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | [[Category:DesktopEdition]] | + | |
| - | [[Category:ThinkGeo.MapSuite.DesktopEdition]] | + | ** {{wiki:PublicProperty.gif|}} Overlay ** |
| - | [[Category:UpdateDocumentation]] | + | |
| + | * //This property gets and sets the overlay you will be drawing.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.OverlayDrawingWinformsMapEventArgs#firstHeading" class="firstHeading" lang="en"><span dir="auto// | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.desktopedition.overlaydrawingwinformsmapeventargs.1440040130.txt.gz · Last modified: 2015/09/18 03:04 (external edit)