thinkgeo.mapsuite.routing.findingrouteroutingalgorithmeventargs
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.routing.findingrouteroutingalgorithmeventargs [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.routing.findingrouteroutingalgorithmeventargs [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs ====== | ====== ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents the parameters passed out through the FindingRoute event. | ||
| - | === Remarks === | ||
| This class represents the parameters passed out through the FindingRoute event. | This class represents the parameters passed out through the FindingRoute event. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **System.EventArgs | + | *System.EventArgs |
| - | ***[[ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs]] | + | ***ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} FindingRouteRoutingAlgorithmEventArgs() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#FindingRouteRoutingAlgorithmEventArgs()|FindingRouteRoutingAlgorithmEventArgs]] | | | This is the default constructor. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#FindingRouteRoutingAlgorithmEventArgs(RouteSegment)|FindingRouteRoutingAlgorithmEventArgs]] | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | | This is the constructor that passed the routeSegment. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is the default constructor.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //This is the default constructor.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} FindingRouteRoutingAlgorithmEventArgs(RouteSegment) ** | ||
| + | * //This is the constructor that passed the routeSegment.// | ||
| + | == Remarks == | ||
| + | * //This is the constructor that passed the routeSegment.// | ||
| + | == Parameters == | ||
| + | * //routeSegment// | ||
| + | * Type:[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | ||
| + | * Description:The routeSegment that you want pass out by event. | ||
| + | |||
| + | <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.Routing.FindingRouteRoutingAlgorithmEventArgs#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}}[[#IsPathTermination|IsPathTermination]] | Boolean | | Gets or sets the value that represents whether the current routeSegment is the terminus. The default value is false. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RouteSegment|RouteSegment]] | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] | | Gets or sets the value that represents the current routeSegment during route. | | + | |
| - | ==== 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.Routing.FindingRouteRoutingAlgorithmEventArgs#Equals.28Object.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== FindingRouteRoutingAlgorithmEventArgs() ==== | + | * Type:Boolean |
| - | This is the default constructor. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This is the default constructor. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== FindingRouteRoutingAlgorithmEventArgs(RouteSegment) ==== | + | * //obj// |
| - | This is the constructor that passed the routeSegment. | + | * Type:Object |
| - | === Remarks === | + | * Description:N/A |
| - | This is the constructor that passed the routeSegment. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | routeSegment | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]<!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | The routeSegment that you want pass out by event. | | + | |
| - | [[#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.Routing.FindingRouteRoutingAlgorithmEventArgs#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#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.Routing.FindingRouteRoutingAlgorithmEventArgs#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs#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 ==== |
| - | ==== IsPathTermination ==== | + | ** {{wiki:PublicProperty.gif|}} RouteSegment ** |
| - | Gets or sets the value that represents whether the current routeSegment is the terminus. The default value is false. | + | |
| - | === Remarks === | + | |
| - | If you set the value to true, it will make the current routeSegment the terminus, which will break the route and return the path that has been routed thus far. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RouteSegment ==== | ||
| Gets or sets the value that represents the current routeSegment during route. | Gets or sets the value that represents the current routeSegment during route. | ||
| - | === Remarks === | + | == Remarks == |
| The default value is null if you call the default constructor. | The default value is null if you call the default constructor. | ||
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]] |
| - | | [[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]<!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Routing.FindingRouteRoutingAlgorithmEventArgs --> | + | ** {{wiki:PublicProperty.gif|}} IsPathTermination ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | Gets or sets the value that represents whether the current routeSegment is the terminus. The default value is false. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | If you set the value to true, it will make the current routeSegment the terminus, which will break the route and return the path that has been routed thus far. |
| - | [[Category:MapSuiteRouting]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.Routing]] | + | * Type:Boolean |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.routing.findingrouteroutingalgorithmeventargs.1440040134.txt.gz · Last modified: 2015/09/18 03:06 (external edit)