====== ThinkGeo.MapSuite.WindowsPhoneCore.LabelingCandidate ======

{{section>upgrade_map_suite_to_10.0}}




<!-- Class -->
This class represents a candidate for labeling.
=== Remarks ===
This class is used in the internals of the labeling system. We keep track of every potential label in this class as it goes through the labeling rules.
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.WindowsPhoneCore.LabelingCandidate]]
***[[ThinkGeo.MapSuite.WindowsPhoneCore.WorldLabelingCandidate]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#LabelingCandidate()|LabelingCandidate]]   |    |    | This is a constructor for the class.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#LabelingCandidate(String, PolygonShape, PointShape)|LabelingCandidate]]   | String, [[ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape|PolygonShape]], [[ThinkGeo.MapSuite.WindowsPhoneCore.PointShape|PointShape]]   |    | This is a constructor for the class.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#LabelingCandidate(String, PolygonShape, PointShape, Collection<LabelInformation>)|LabelingCandidate]]   | String, [[ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape|PolygonShape]], [[ThinkGeo.MapSuite.WindowsPhoneCore.PointShape|PointShape]], Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.LabelInformation|LabelInformation]]>   |    | This is a constructor for the class.   |

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{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 ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |

==== Public Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#CenterPoint|CenterPoint]]   | [[ThinkGeo.MapSuite.WindowsPhoneCore.PointShape|PointShape]]   |    | This property gets and sets the center point for the center of the label.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#LabelInformation|LabelInformation]]   | Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.LabelInformation|LabelInformation]]>   |    | This property gets and sets the label information for this label.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#OriginalText|OriginalText]]   | String   |    | This property gets and sets the original text for the label.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ScreenArea|ScreenArea]]   | [[ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape|PolygonShape]]   |    | This property gets and sets the screen area that encompasses the label.   |

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^

==== Public Events ====
^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^

===== Public Constructors =====
==== LabelingCandidate() ====
This is a constructor for the class.
=== Overloads ===
This is the default constructor.
=== Remarks ===
If you use this constructor, then you should set the applicable properties manually.
=== Parameters ===
^  Name ^  Type ^  Description ^

[[#Public Constructors|Go Back]]
==== LabelingCandidate(String, PolygonShape, PointShape) ====
This is a constructor for the class.
=== Overloads ===
This constructor allows you to pass in the area of the label as well as the center point.
=== Parameters ===
^  Name ^  Type ^  Description ^
| originalText   | String<!-- System.String -->   | This parameter represents the text of the label before it is potentially modified.   |
| simplePolygonInScreenCoordinates   | [[ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape -->   | This parameter is a polygon (in screen coordinates) representing the area to be labeled.   |
| centerPointInScreenCoordinates   | [[ThinkGeo.MapSuite.WindowsPhoneCore.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.WindowsPhoneCore.PointShape -->   | This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled.   |

[[#Public Constructors|Go Back]]
==== LabelingCandidate(String, PolygonShape, PointShape, Collection<LabelInformation>) ====
This is a constructor for the class.
=== Overloads ===
This constructor allows you to pass in the area of the label and the center point.
=== Parameters ===
^  Name ^  Type ^  Description ^
| originalText   | String<!-- System.String -->   | This parameter represents the text of the label before it is potentially modified.   |
| simplePolygonInScreenCoordinates   | [[ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape -->   | This parameter is a polygon (in screen coordinates) representing the area to be labeled.   |
| centerPointInScreenCoordinates   | [[ThinkGeo.MapSuite.WindowsPhoneCore.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.WindowsPhoneCore.PointShape -->   | This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled.   |
| labelInformation   | Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.LabelInformation|LabelInformation]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.LabelInformation} -->   | This parameter is the labeling information for this labeling candidate.   |

[[#Public Constructors|Go Back]]
===== Protected Constructors =====
===== Public Methods =====
==== Equals(Object) ====
=== Return Value ===
^ Return Type ^ Description ^
| Boolean<!-- System.Boolean -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| obj   | Object<!-- System.Object -->   |    |

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetHashCode() ====
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetType() ====
=== Return Value ===
^ Return Type ^ Description ^
| Type<!-- System.Type -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== ToString() ====
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
===== Protected Methods =====
==== Finalize() ====
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== MemberwiseClone() ====
=== Return Value ===
^ Return Type ^ Description ^
| Object<!-- System.Object -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
===== Public Properties =====
==== CenterPoint ====
This property gets and sets the center point for the center of the label.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.WindowsPhoneCore.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.WindowsPhoneCore.PointShape -->   |

<!-- ThinkGeo.MapSuite.WindowsPhoneCore.LabelingCandidate -->
[[#Public Properties|Go Back]]
==== LabelInformation ====
This property gets and sets the label information for this label.
=== Return Value ===
^ Return Type ^
| Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.LabelInformation|LabelInformation]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.LabelInformation} -->   |

<!-- ThinkGeo.MapSuite.WindowsPhoneCore.LabelingCandidate -->
[[#Public Properties|Go Back]]
==== OriginalText ====
This property gets and sets the original text for the label.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.WindowsPhoneCore.LabelingCandidate -->
[[#Public Properties|Go Back]]
==== ScreenArea ====
This property gets and sets the screen area that encompasses the label.
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.WindowsPhoneCore.PolygonShape -->   |

<!-- ThinkGeo.MapSuite.WindowsPhoneCore.LabelingCandidate -->
[[#Public Properties|Go Back]]
===== Protected Properties =====
===== Public Events =====
__NOTOC__
[[Category:WindowsPhoneMapSuiteCore]]
[[Category:ThinkGeo.MapSuite.WindowsPhoneCore]]
[[Category:UpdateDocumentation]]