thinkgeo.mapsuite.portablecore.worldlabelingcandidate
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.worldlabelingcandidate [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.WorldLabelingCandidate ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- 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 | ||
| - | **[[ThinkGeo.MapSuite.PortableCore.LabelingCandidate]] | ||
| - | ***[[ThinkGeo.MapSuite.PortableCore.WorldLabelingCandidate]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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.PortableCore.PointShape|PointShape]] | | 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.PortableCore.PointShape|PointShape]] | [[ThinkGeo.MapSuite.PortableCore.LabelingCandidate|LabelingCandidate]] | This property gets and sets the center point for the center of the label. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CenterPointInWorldCoordinates|CenterPointInWorldCoordinates]] | [[ThinkGeo.MapSuite.PortableCore.PointShape|PointShape]] | | This property gets or sets the Center Point position in world Coordinate system. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#LabelInformation|LabelInformation]] | Collection<[[ThinkGeo.MapSuite.PortableCore.LabelInformation|LabelInformation]]> | [[ThinkGeo.MapSuite.PortableCore.LabelingCandidate|LabelingCandidate]] | This property gets and sets the label information for this label. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#OriginalText|OriginalText]] | String | [[ThinkGeo.MapSuite.PortableCore.LabelingCandidate|LabelingCandidate]] | This property gets and sets the original text for the label. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ScreenArea|ScreenArea]] | [[ThinkGeo.MapSuite.PortableCore.PolygonShape|PolygonShape]] | [[ThinkGeo.MapSuite.PortableCore.LabelingCandidate|LabelingCandidate]] | 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 ===== | ||
| - | ==== WorldLabelingCandidate() ==== | ||
| - | This is a default constructor for the class. | ||
| - | === Remarks === | ||
| - | If you use this constructor, then you should set the applicable properties manually. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== WorldLabelingCandidate(String) ==== | ||
| - | This is a constructor for the class. | ||
| - | === 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]] | ||
| - | ==== WorldLabelingCandidate(String, PointShape) ==== | ||
| - | This is a constructor for the class. | ||
| - | === 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.PortableCore.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.PortableCore.PointShape --> | This parameter is the center of the polygon (in world coordinates) representing the area to be labeled. | | ||
| - | |||
| - | [[#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.PortableCore.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.PortableCore.PointShape --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.LabelingCandidate --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== CenterPointInWorldCoordinates ==== | ||
| - | This property gets or sets the Center Point position in world Coordinate system. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.PortableCore.PointShape --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WorldLabelingCandidate --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== LabelInformation ==== | ||
| - | This property gets and sets the label information for this label. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.LabelInformation|LabelInformation]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.LabelInformation} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.LabelingCandidate --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ScreenArea ==== | ||
| - | This property gets and sets the screen area that encompasses the label. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.PolygonShape|PolygonShape]]<!-- ThinkGeo.MapSuite.PortableCore.PolygonShape --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.LabelingCandidate --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuitePortableCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.portablecore.worldlabelingcandidate.1440040133.txt.gz ยท Last modified: 2015/09/21 08:21 (external edit)
