User Tools

Site Tools

Trace: • map_suite_desktop_for_winforms_quick_start_guide
thinkgeo.mapsuite.silverlightcore.labelingcandidate

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.silverlightcore.labelingcandidate [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.silverlightcore.labelingcandidate [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate ====== ====== ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- +This class represents a candidate for labeling.
-<!-- Class -->+
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate]] +    ***ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate** 
-***[[ThinkGeo.MapSuite.SilverlightCore.WorldLabelingCandidate]]+      ​*[[ThinkGeo.MapSuite.SilverlightCore.WorldLabelingCandidate]]
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} LabelingCandidate() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#LabelingCandidate()|LabelingCandidate]] ​  ​| ​   |    |    | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​LabelingCandidate(String,​ PolygonShape,​ PointShape)|LabelingCandidate]] ​  | String, [[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]],​ [[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] ​  ​| ​   |    | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​LabelingCandidate(String,​ PolygonShape,​ PointShape, Collection<​LabelInformation>​)|LabelingCandidate]] ​  | String, [[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]],​ [[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]],​ Collection<​[[ThinkGeo.MapSuite.SilverlightCore.LabelInformation|LabelInformation]]> ​  ​| ​   |    |+
  
-==== Protected Constructors ​==== +  * //This is a 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|}} LabelingCandidate(String,​PolygonShape,​PointShape) **
  
 +  * //This is a constructor for the class.//
 +== Remarks ==
 +  * //None//
 +== Parameters ==
 +  * //​originalText//​
 +    * Type:String
 +    * Description:​This parameter represents the text of the label before it is potentially modified.
 +
 +  * //​simplePolygonInScreenCoordinates//​
 +    * Type:​[[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]]
 +    * Description:​This parameter is a polygon (in screen coordinates) representing the area to be labeled.
 +
 +  * //​centerPointInScreenCoordinates//​
 +    * Type:​[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
 +    * Description:​This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} LabelingCandidate(String,​PolygonShape,​PointShape,​Collection<​LabelInformation>​) **
 +
 +  * //This is a constructor for the class.//
 +== Remarks ==
 +  * //None//
 +== Parameters ==
 +  * //​originalText//​
 +    * Type:String
 +    * Description:​This parameter represents the text of the label before it is potentially modified.
 +
 +  * //​simplePolygonInScreenCoordinates//​
 +    * Type:​[[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]]
 +    * Description:​This parameter is a polygon (in screen coordinates) representing the area to be labeled.
 +
 +  * //​centerPointInScreenCoordinates//​
 +    * Type:​[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]
 +    * Description:​This parameter is the center of the polygon (in screen coordinates) representing the area to be labeled.
 +
 +  * //​labelInformation//​
 +    * Type:​Collection<​[[ThinkGeo.MapSuite.SilverlightCore.LabelInformation|LabelInformation]]>​
 +    * Description:​This parameter is the labeling information for this labeling candidate.
 +
 +<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}}[[#​CenterPoint|CenterPoint]] ​  | [[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] ​  ​| ​   |    | +  * Description:N/A
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​LabelInformation|LabelInformation]] ​  | Collection<​[[ThinkGeo.MapSuite.SilverlightCore.LabelInformation|LabelInformation]]> ​  ​| ​   |    | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​OriginalText|OriginalText]] ​  ​| ​String ​  |    |    | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​ScreenArea|ScreenArea]] ​  | [[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]] ​  ​| ​   |    |+
  
-==== 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 == 
-==== LabelingCandidate() ==== +  ​* Type:Boolean 
-=== Parameters === +  * Description:N/A
-^  Name ^  ​Type ​^  ​Description ​^+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== LabelingCandidate(String,​ PolygonShape,​ PointShape) ==== +  ​* //obj// 
-=== Parameters ​=== +    ​* Type:Object 
-^  Name ^  Type ^  Description ^ +    ​* Description:​N/​A
-| originalText ​  | String<​!-- System.String --> ​  ​| ​   | +
-| simplePolygonInScreenCoordinates ​  | [[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]]<​!-- ThinkGeo.MapSuite.SilverlightCore.PolygonShape --> ​  ​| ​   | +
-| centerPointInScreenCoordinates ​  | [[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]<​!-- ThinkGeo.MapSuite.SilverlightCore.PointShape --> ​  ​| ​   |+
  
-[[#Public Constructors|Go Back]] +<div newline></div> 
-==== LabelingCandidate(String,​ PolygonShape,​ PointShape, Collection<LabelInformation>) ==== +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-=== Parameters === +
-^  Name ^  Type ^  Description ^ +
-| originalText ​  | String<!-- System.String -->   |    | +
-| simplePolygonInScreenCoordinates ​  | [[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]]<​!-- ThinkGeo.MapSuite.SilverlightCore.PolygonShape --> ​  ​| ​   | +
-| centerPointInScreenCoordinates ​  | [[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]<​!-- ThinkGeo.MapSuite.SilverlightCore.PointShape --> ​  ​| ​   | +
-| labelInformation ​  | Collection<​[[ThinkGeo.MapSuite.SilverlightCore.LabelInformation|LabelInformation]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.SilverlightCore.LabelInformation} --> ​  ​| ​   |+
  
-[[#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:Int32 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetHashCode() ​==== +** {{wiki:​PublicMethod.gif|}} GetType() **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  * Type:Type 
-==== GetType() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Protected Methods ==== 
 +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== ToString() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Void 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-===== Protected Methods ===== +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
-==== Finalize() ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Object 
-==== MemberwiseClone() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Public Properties ==== 
 +** {{wiki:​PublicProperty.gif|}} OriginalText **
  
-<!-- System.Object --> +This property gets and sets the original text for the label. 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-===== Public Properties ===== +None 
-==== CenterPoint ==== +== Return Value == 
-=== Return Value === +  ​* ​Type:String
-^ Return ​Type ^ +
-| [[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]]<​!-- ThinkGeo.MapSuite.SilverlightCore.PointShape --> ​  |+
  
-<!-- ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate --> +** {{wiki:​PublicProperty.gif|}} ScreenArea **
-[[#Public Properties|Go Back]] +
-==== LabelInformation ==== +
-=== Return Value === +
-^ Return Type ^ +
-| Collection<​[[ThinkGeo.MapSuite.SilverlightCore.LabelInformation|LabelInformation]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.SilverlightCore.LabelInformation} --> ​  |+
  
-<!-- ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate --> +This property gets and sets the screen area that encompasses the label. 
-[[#Public Properties|Go Back]] +== Remarks ​== 
-==== OriginalText ==== +None 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:[[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]]
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate --> +** {{wiki:​PublicProperty.gif|}} CenterPoint **
-[[#Public Properties|Go Back]] +
-==== ScreenArea ==== +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.SilverlightCore.PolygonShape|PolygonShape]]<​!-- ThinkGeo.MapSuite.SilverlightCore.PolygonShape --> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.SilverlightCore.LabelingCandidate --> +This property gets and sets the center point for the center of the label. 
-[[#Public Properties|Go Back]] +== Remarks == 
-===== Protected Properties ​===== +None 
-===== Public Events ===== +== Return Value == 
-__NOTOC__ +  * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] 
-[[Category:​SilverlightMapSuiteCore]] + 
-[[Category:​ThinkGeo.MapSuite.SilverlightCore]] +** {{wiki:​PublicProperty.gif|}} LabelInformation ** 
-[[Category:​UpdateDocumentation]]+ 
 +This property gets and sets the label information for this label. 
 +== Remarks == 
 +None 
 +== Return Value == 
 +  * Type:​Collection<​[[ThinkGeo.MapSuite.SilverlightCore.LabelInformation|LabelInformation]]> 
 + 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.silverlightcore.labelingcandidate.1440040134.txt.gz · Last modified: 2015/09/21 03:21 (external edit)

Page Tools