Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.core.worldlabelingcandidate [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.core.worldlabelingcandidate [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.WorldLabelingCandidate ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 This class represents a candidate with world center point information for labeling.
-=== Remarks ===
-This class is used in the labeling system. We keep track of every potential label in this class as it goes through the labeling rules.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.Core.LabelingCandidate]]
+    *ThinkGeo.MapSuite.Core.LabelingCandidate
-***[[ThinkGeo.MapSuite.Core.WorldLabelingCandidate]]
+      ***ThinkGeo.MapSuite.Core.WorldLabelingCandidate**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} WorldLabelingCandidate() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#WorldLabelingCandidate()|WorldLabelingCandidate]]   |    |    | This is a default constructor for the class.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#WorldLabelingCandidate(String)|WorldLabelingCandidate]]   | String   |    | This is a constructor for the class.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#WorldLabelingCandidate(String, PointShape)|WorldLabelingCandidate]]   | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]   |    | This is a constructor for the class.   |
-==== Protected Constructors ====
+  * //This is a default constructor for the class.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //If you use this constructor, then you should set the applicable properties manually.//
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} WorldLabelingCandidate(String) **
-==== Public Methods ====
+  * //This is a constructor for the class.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
+  * //None//
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
+== Parameters ==
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
+  * //originalText//
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
+    * Type:String
+    * Description:This parameter represents the text of the label before it is potentially modified.
-==== Protected Methods ====
+<div newline></div>
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} WorldLabelingCandidate(String,PointShape) **
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+  * //This is a constructor for the class.//
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:PublicProperty.gif|Public Property}}[[#CenterPoint|CenterPoint]]   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]   | [[ThinkGeo.MapSuite.Core.LabelingCandidate|LabelingCandidate]]   | This property gets and sets the center point for the center of the label.   |
+  * //None//
-| {{wiki:PublicProperty.gif|Public Property}}[[#CenterPointInWorldCoordinates|CenterPointInWorldCoordinates]]   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]   |    | This property gets or sets the Center Point position in world Coordinate system.   |
+== Parameters ==
-| {{wiki:PublicProperty.gif|Public Property}}[[#LabelInformation|LabelInformation]]   | Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]>   | [[ThinkGeo.MapSuite.Core.LabelingCandidate|LabelingCandidate]]   | This property gets and sets the label information for this label.   |
+  * //originalText//
-| {{wiki:PublicProperty.gif|Public Property}}[[#OriginalText|OriginalText]]   | String   | [[ThinkGeo.MapSuite.Core.LabelingCandidate|LabelingCandidate]]   | This property gets and sets the original text for the label.   |
+    * Type:String
-| {{wiki:PublicProperty.gif|Public Property}}[[#ScreenArea|ScreenArea]]   | [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]   | [[ThinkGeo.MapSuite.Core.LabelingCandidate|LabelingCandidate]]   | This property gets and sets the screen area that encompasses the label.   |
+    * Description:This parameter represents the text of the label before it is potentially modified.
-==== Protected Properties ====
+  * //centerPointInWorldCoordinates//
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
+    * Description:This parameter is the center of the polygon (in world coordinates) representing the area to be labeled.
-==== Public Events ====
+<div newline></div>
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+==== Protected Constructors ====
+==== Public Methods ====
+** {{wiki:PublicMethod.gif|}} ToString() **
-===== Public Constructors =====
+  * //N/A//
-==== WorldLabelingCandidate() ====
+== Remarks ==
-This is a default constructor for the class.
+  * //N/A//
-=== Remarks ===
-If you use this constructor, then you should set the applicable properties manually.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Constructors|Go Back]]
+== Return Value ==
-==== WorldLabelingCandidate(String) ====
+  * Type:String
-This is a constructor for the class.
+  * Description:N/A
-=== Overloads ===
-This constructor allows you to pass in the text of the label.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| originalText   | String<!-- System.String -->   | This parameter represents the text of the label before it is potentially modified.   |
-[[#Public Constructors|Go Back]]
+== Parameters ==
-==== WorldLabelingCandidate(String, PointShape) ====
+<div newline></div>
-This is a constructor for the class.
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-=== Overloads ===
-This constructor allows you to pass in the text of the label as well as the world center point.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| originalText   | String<!-- System.String -->   | This parameter represents the text of the label before it is potentially modified.   |
-| centerPointInWorldCoordinates   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   | This parameter is the center of the polygon (in world coordinates) representing the area to be labeled.   |
-[[#Public Constructors|Go Back]]
+  * //N/A//
-===== Protected Constructors =====
+== Remarks ==
-===== Public Methods =====
+  * //N/A//
-==== Equals(Object) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Boolean
-| obj   | Object<!-- System.Object -->   |    |
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //obj//
-==== GetHashCode() ====
+    * Type:Object
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-<!-- 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:Int32
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== ToString() ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Type
-===== Protected Methods =====
+  * Description:N/A
-==== Finalize() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-<!-- 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:Void
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-===== Public Properties =====
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-==== CenterPoint ====
-This property gets and sets the center point for the center of the label.
+  * //N/A//
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+  * //N/A//
-| [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   |
+== Return Value ==
+  * Type:Object
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} CenterPointInWorldCoordinates **
-<!-- ThinkGeo.MapSuite.Core.LabelingCandidate -->
-[[#Public Properties|Go Back]]
-==== CenterPointInWorldCoordinates ====
 This property gets or sets the Center Point position in world Coordinate system.
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+N/A
-| [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   |
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
-<!-- ThinkGeo.MapSuite.Core.WorldLabelingCandidate -->
+** {{wiki:PublicProperty.gif|}} OriginalText **
-[[#Public Properties|Go Back]]
-==== LabelInformation ====
-This property gets and sets the label information for this label.
-=== Return Value ===
-^ Return Type ^
-| Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.LabelInformation} -->   |
-<!-- ThinkGeo.MapSuite.Core.LabelingCandidate -->
+N/A
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== OriginalText ====
+N/A
-This property gets and sets the original text for the label.
+== Return Value ==
-=== Return Value ===
+  * Type:String
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.Core.LabelingCandidate -->
+** {{wiki:PublicProperty.gif|}} ScreenArea **
-[[#Public Properties|Go Back]]
-==== ScreenArea ====
-This property gets and sets the screen area that encompasses the label.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.Core.PolygonShape -->   |
-<!-- ThinkGeo.MapSuite.Core.LabelingCandidate -->
+N/A
-[[#Public Properties|Go Back]]
+== Remarks ==
-===== Protected Properties =====
+N/A
-===== Public Events =====
+== Return Value ==
-__NOTOC__
+  * Type:[[ThinkGeo.MapSuite.Core.PolygonShape|PolygonShape]]
-[[Category:MapSuiteCore]]
-[[Category:ThinkGeo.MapSuite.Core]]
+** {{wiki:PublicProperty.gif|}} CenterPoint **
-[[Category:UpdateDocumentation]]
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
+** {{wiki:PublicProperty.gif|}} LabelInformation **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.LabelInformation|LabelInformation]]>
+==== Protected Properties ====
+==== Public Events ====

User Tools

Site Tools

Differences

Page Tools