This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.labelinformation [2015/09/17 10:33] admin |
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}} | ||
+ | |||
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. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 5: | Line 8: | ||
***ThinkGeo.MapSuite.Core.LabelInformation** | ***ThinkGeo.MapSuite.Core.LabelInformation** | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
- | === Public Constructors === | + | ==== Public Constructors ==== |
- | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} LabelInformation() ** |
- | **{{wiki:PublicMethod.gif|}}[[#LabelInformation()|LabelInformation]]** | + | |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This is the constructor for the class. | + | |
- | </div> | + | |
- | <div class_table> | + | * //This is the constructor for the class.// |
- | **{{wiki:PublicMethod.gif|}}[[#LabelInformation(PointShape,String,Double)|LabelInformation]]** | + | == Remarks == |
- | * **Parameters**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]],String,Double | + | * //If you use this constructor, you should set the various properties manually.// |
- | * **DeclaringType**:N/A | + | == Parameters == |
- | * **Summary**:This is the constructor for the class. | + | <div newline></div> |
- | </div> | + | ** {{wiki:PublicMethod.gif|}} LabelInformation(PointShape,String,Double) ** |
- | === Protected Constructors === | + | * //This is the constructor for the class.// |
- | === Public Methods === | + | == Remarks == |
- | <div class_table> | + | * //None// |
- | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | == Parameters == |
- | * **Parameters**:Object | + | * //positionInScreenCoordinates// |
- | * **DeclaringType**:Object | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
- | * **Summary**:N/A | + | * Description:This parameter is the position of the label that may draw. |
- | </div> | + | |
- | <div class_table> | + | * //text// |
- | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:String |
- | * **Parameters**:N/A | + | * Description:This parameter is the text for the label. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //rotationAngle// |
- | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:Double |
- | * **Parameters**:N/A | + | * Description:This parameter is the angle of rotation for the label. |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | ==== Protected Constructors ==== |
- | * **Parameters**:N/A | + | ==== Public Methods ==== |
- | * **DeclaringType**:Object | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Protected Methods === | + | * //N/A// |
- | <div class_table> | + | == Remarks == |
- | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * //N/A// |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Return Value == |
- | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * Type:String |
- | * **Parameters**:N/A | + | * Description:N/A |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Public Properties === | + | == Parameters == |
- | **{{wiki:PublicProperty.gif|}}[[#PositionInScreenCoordinates|PositionInScreenCoordinates]]** | + | <div newline></div> |
- | * **Return**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | * **Summary**:This property gets and sets the position of a piece of a label, in screen coordinates. | + | |
- | **{{wiki:PublicProperty.gif|}}[[#RotationAngle|RotationAngle]]** | + | * //N/A// |
- | * **Return**:Double | + | == Remarks == |
- | * **Summary**:This property gets and sets the angle of rotation for the label. | + | * //N/A// |
- | **{{wiki:PublicProperty.gif|}}[[#Text|Text]]** | + | == Return Value == |
- | * **Return**:String | + | * Type:Boolean |
- | * **Summary**:This property gets and sets the text of the label. | + | * Description:N/A |
- | === Protected Properties === | + | == Parameters == |
- | === Public Events === | + | * //obj// |
- | ===== Public Constructors ===== | + | * Type:Object |
- | === LabelInformation() === | + | * Description:N/A |
- | This is the constructor for the class. | + | |
- | ==== Remarks ==== | + | |
- | If you use this constructor, you should set the various properties manually. | + | |
- | ==== Parameters ==== | + | |
- | [[#Public Constructors|Go Back]] | + | |
- | === 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** | + | <div newline></div> |
- | * **Type**:String | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | * **Description:This parameter is the text for the label. | + | |
- | **rotationAngle** | + | * //N/A// |
- | * **Type**:Double | + | == Remarks == |
- | * **Description:This parameter is the angle of rotation for the label. | + | * //N/A// |
- | [[#Public Constructors|Go Back]] | + | == Return Value == |
- | ===== Protected Constructors ===== | + | * Type:Int32 |
- | ===== Public Methods ===== | + | * Description:N/A |
- | === Equals(Object) === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Boolean | + | <div newline></div> |
- | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | ==== Parameters ==== | + | * //N/A// |
- | **obj** | + | == Remarks == |
- | * **Type**:Object | + | * //N/A// |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Return Value == |
- | === GetHashCode() === | + | * Type:Type |
- | N/A | + | * Description:N/A |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Int32 | + | <div newline></div> |
- | * **Description**:N/A | + | ==== Protected Methods ==== |
+ | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | ==== Parameters ==== | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | === GetType() === | + | * //N/A// |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Type | + | * Type:Void |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | === ToString() === | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:String | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Object |
- | ===== Protected Methods ===== | + | * Description:N/A |
- | === Finalize() === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Void | + | <div newline></div> |
- | * **Description**:N/A | + | ==== Public Properties ==== |
+ | ** {{wiki:PublicProperty.gif|}} PositionInScreenCoordinates ** | ||
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | === MemberwiseClone() === | ||
- | N/A | ||
- | ==== Remarks ==== | ||
- | N/A | ||
- | |||
- | **Return Value** | ||
- | * **Return Type**:Object | ||
- | * **Description**:N/A | ||
- | |||
- | ==== Parameters ==== | ||
- | [[#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. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} Text ** |
- | === 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 | + | |
- | [[#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**:String | + | * Type:String |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} 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 == | ||
+ | * Type:Double | ||
- | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
- | ===== Protected Properties ===== | + | ==== Public Events ==== |
- | ===== Public Events ===== | + | |