thinkgeo.mapsuite.core.labelinformation
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.labelinformation [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.core.labelinformation [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.LabelInformation ====== | ====== ThinkGeo.MapSuite.Core.LabelInformation ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class represents the location of a piece of a label that may be drawn. | This class represents the location of a piece of a label that may be drawn. | ||
| - | === Remarks === | ||
| - | This class is used within the labeling logic, specifically in the labeling candidate. The object may represent an entire label or, in the case of a label spline, a single character in the label. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.Core.LabelInformation]] | + | ***ThinkGeo.MapSuite.Core.LabelInformation** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} LabelInformation() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LabelInformation()|LabelInformation]] | | | This is the constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#LabelInformation(PointShape, String, Double)|LabelInformation]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], String, Double | | This is the constructor for the class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is the constructor for the class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //If you use this constructor, you should set the various properties manually.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} LabelInformation(PointShape,String,Double) ** | ||
| + | * //This is the constructor for the class.// | ||
| + | == Remarks == | ||
| + | * //None// | ||
| + | == Parameters == | ||
| + | * //positionInScreenCoordinates// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| + | * Description:This parameter is the position of the label that may draw. | ||
| + | |||
| + | * //text// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the text for the label. | ||
| + | |||
| + | * //rotationAngle// | ||
| + | * Type:Double | ||
| + | * Description:This parameter is the angle of rotation for 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}}[[#PositionInScreenCoordinates|PositionInScreenCoordinates]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | This property gets and sets the position of a piece of a label, in screen coordinates. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RotationAngle|RotationAngle]] | Double | | This property gets and sets the angle of rotation for the label. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Text|Text]] | String | | This property gets and sets the text 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 == |
| - | ==== LabelInformation() ==== | + | * Type:Boolean |
| - | This is the constructor for the class. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | This is the default constructor. | + | |
| - | === Remarks === | + | |
| - | If you use this constructor, you should set the various properties manually. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== LabelInformation(PointShape, String, Double) ==== | + | * //obj// |
| - | This is the constructor for the class. | + | * Type:Object |
| - | === Overloads === | + | * Description:N/A |
| - | This constructor allows you to set all of the class properties. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | positionInScreenCoordinates | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the position of the label that may draw. | | + | |
| - | | text | String<!-- System.String --> | This parameter is the text for the label. | | + | |
| - | | rotationAngle | Double<!-- System.Double --> | This parameter is the angle of rotation for 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 | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} PositionInScreenCoordinates ** | ||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== PositionInScreenCoordinates ==== | ||
| This property gets and sets the position of a piece of a label, in screen coordinates. | This property gets and sets the position of a piece of a label, in screen coordinates. | ||
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | None |
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| - | <!-- ThinkGeo.MapSuite.Core.LabelInformation --> | + | ** {{wiki:PublicProperty.gif|}} Text ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== RotationAngle ==== | + | |
| - | This property gets and sets the angle of rotation for the label. | + | |
| - | === Remarks === | + | |
| - | This could be the rotation of the entire label text, a single character, or a set of characters. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Double<!-- System.Double --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.LabelInformation --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Text ==== | ||
| This property gets and sets the text of the label. | This property gets and sets the text of the label. | ||
| - | === Remarks === | + | == Remarks == |
| This may be the entire label text or a single character. | This may be the entire label text or a single character. | ||
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.LabelInformation --> | + | ** {{wiki:PublicProperty.gif|}} RotationAngle ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | This property gets and sets the angle of rotation for the label. |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | This could be the rotation of the entire label text, a single character, or a set of characters. |
| - | [[Category:MapSuiteCore]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.Core]] | + | * Type:Double |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.core.labelinformation.1440040129.txt.gz · Last modified: 2015/09/17 10:33 (external edit)