This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.portablecore.simplecandidate [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.simplecandidate [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== ThinkGeo.MapSuite.PortableCore.SimpleCandidate ====== | + | ====== ThinkGeo.MapSuite.Core.SimpleCandidate ====== |
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
This class stores simple label information used in the PositionStyle. | This class stores simple label information used in the PositionStyle. | ||
- | === Remarks === | ||
- | This class is used in the PositionStyle for storing simple label infromation. It has a limited scope. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate]] | + | ***ThinkGeo.MapSuite.Core.SimpleCandidate** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} SimpleCandidate() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#SimpleCandidate()|SimpleCandidate]] | | | This is a constructor for the class. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#SimpleCandidate(String, PolygonShape)|SimpleCandidate]] | String, [[ThinkGeo.MapSuite.PortableCore.PolygonShape|PolygonShape]] | | This is a constructor for the class. | | + | |
- | ==== Protected Constructors ==== | + | * //This is a constructor for the class.// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //If you use this constructor, then you need to manually set the properties necessary for this class.// | ||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} SimpleCandidate(String,PolygonShape) ** | ||
+ | * //This is a constructor for the class.// | ||
+ | == Remarks == | ||
+ | * //None// | ||
+ | == Parameters == | ||
+ | * //originalText// | ||
+ | * Type:String | ||
+ | * Description:This parameter is the text for the label. | ||
+ | |||
+ | * //simplePolygonInScreenCoordinate// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] | ||
+ | * Description:This parameter is a polygon in screen coordinates that represents the area of the label. | ||
+ | |||
+ | <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}}[[#OriginalText|OriginalText]] | String | | This property gets and sets the text for the label. | | + | * Description:N/A |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#SimplePolygonInScreenCoordinate|SimplePolygonInScreenCoordinate]] | [[ThinkGeo.MapSuite.PortableCore.PolygonShape|PolygonShape]] | | This property gets and sets the polygon in screen coordinates that represents the area of the label. | | + | |
- | ==== 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 == |
- | ==== SimpleCandidate() ==== | + | * 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 manually set the properties necessary for this class. | + | |
- | === Remarks === | + | |
- | If you use this constructor, then you need to manually set the properties necessary for this class. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ==== SimpleCandidate(String, PolygonShape) ==== | + | * //obj// |
- | This is a constructor for the class. | + | * Type:Object |
- | === Overloads === | + | * Description:N/A |
- | This constructor allows you to pass in the original text and the simple polygon in screen coordinates. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | originalText | String<!-- System.String --> | This parameter is the text for the label. | | + | |
- | | simplePolygonInScreenCoordinate | [[ThinkGeo.MapSuite.PortableCore.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.PortableCore.PolygonShape --> | This parameter is a polygon in screen coordinates that represents the area of the label. | | + | |
- | [[#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 | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | <div newline></div> |
- | ===== Public Properties ===== | + | ==== Public Properties ==== |
- | ==== OriginalText ==== | + | ** {{wiki:PublicProperty.gif|}} OriginalText ** |
- | This property gets and sets the text for the label. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.SimpleCandidate --> | + | * //This property gets and sets the text for the label.// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== SimplePolygonInScreenCoordinate ==== | + | * //None// |
- | This property gets and sets the polygon in screen coordinates that represents the area of the label. | + | == Return Value == |
- | === Return Value === | + | * Type:String |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.PortableCore.PolygonShape --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.SimpleCandidate --> | + | ** {{wiki:PublicProperty.gif|}} SimplePolygonInScreenCoordinate ** |
- | [[#Public Properties|Go Back]] | + | |
- | ===== Protected Properties ===== | + | * //This property gets and sets the polygon in screen coordinates that represents the area of the label.// |
- | ===== Public Events ===== | + | == Remarks == |
- | __NOTOC__ | + | * //None// |
- | [[Category:MapSuitePortableCore]] | + | == Return Value == |
- | [[Category:ThinkGeo.MapSuite.PortableCore]] | + | * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]] |
- | [[Category:UpdateDocumentation]] | + | |
+ | ==== Protected Properties ==== | ||
+ | ==== Public Events ==== | ||