thinkgeo.mapsuite.portablecore.iconvalueitem
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.iconvalueitem [2015/09/21 08:10] admin |
thinkgeo.mapsuite.portablecore.iconvalueitem [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.IconValueItem ====== | ====== ThinkGeo.MapSuite.Core.IconValueItem ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class is a single item in an IconValueStyle. | This class is a single item in an IconValueStyle. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 8: | Line 11: | ||
| ** {{wiki:PublicMethod.gif|}} IconValueItem() ** | ** {{wiki:PublicMethod.gif|}} IconValueItem() ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | If you use the constructor, then you should set all the properties manually. | + | * //If you use the constructor, then you should set all the properties manually.// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} IconValueItem(String,String,TextStyle) ** | ** {{wiki:PublicMethod.gif|}} IconValueItem(String,String,TextStyle) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | You would typically use this constructor if you are using an icon that's located on disk. If you need to use an image from a stream instead, there is another overload that takes a GeoImage. | + | * //You would typically use this constructor if you are using an icon that's located on disk. If you need to use an image from a stream instead, there is another overload that takes a GeoImage.// |
| == Parameters == | == Parameters == | ||
| * //fieldValue// | * //fieldValue// | ||
| Line 34: | Line 37: | ||
| ** {{wiki:PublicMethod.gif|}} IconValueItem(String,GeoImage,TextStyle) ** | ** {{wiki:PublicMethod.gif|}} IconValueItem(String,GeoImage,TextStyle) ** | ||
| - | This is the constructor for the class. | + | * //This is the constructor for the class.// |
| == Remarks == | == Remarks == | ||
| - | You will typically use this overload if you need to use a stream for the image. If you need to use a file located on disk instead, there is another overload that takes the path and filename to an image. | + | * //You will typically use this overload if you need to use a stream for the image. If you need to use a file located on disk instead, there is another overload that takes the path and filename to an image.// |
| == Parameters == | == Parameters == | ||
| * //fieldValue// | * //fieldValue// | ||
| Line 55: | Line 58: | ||
| ** {{wiki:PublicMethod.gif|}} GetIconImage() ** | ** {{wiki:PublicMethod.gif|}} GetIconImage() ** | ||
| - | This method gets the icon we will draw as a GeoImage. | + | * //This method gets the icon we will draw as a GeoImage.// |
| == Remarks == | == Remarks == | ||
| - | This method is used when drawing to get the image as a GeoImage. We will internally either pass along the GeoImage the user set, or create a GeoImage from the IconFilePathName that was set. | + | * //This method is used when drawing to get the image as a GeoImage. We will internally either pass along the GeoImage the user set, or create a GeoImage from the IconFilePathName that was set.// |
| == Return Value == | == Return Value == | ||
| Line 67: | Line 70: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 79: | Line 82: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 95: | Line 98: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 107: | Line 110: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 120: | Line 123: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 132: | Line 135: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 145: | Line 148: | ||
| ** {{wiki:PublicProperty.gif|}} TextStyle ** | ** {{wiki:PublicProperty.gif|}} TextStyle ** | ||
| - | This property gets and sets the style that will be used to draw the text in the icon. | + | * //This property gets and sets the style that will be used to draw the text in the icon.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | ||
| Line 153: | Line 156: | ||
| ** {{wiki:PublicProperty.gif|}} FieldValue ** | ** {{wiki:PublicProperty.gif|}} FieldValue ** | ||
| - | This property gets and sets the field value that has to match in the IconValueStyle. | + | * //This property gets and sets the field value that has to match in the IconValueStyle.// |
| == Remarks == | == Remarks == | ||
| - | For an explanation on how the IconValueStyle works, see the IconValueStyle Class remarks. | + | * //For an explanation on how the IconValueStyle works, see the IconValueStyle Class remarks.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 161: | Line 164: | ||
| ** {{wiki:PublicProperty.gif|}} IconFilePathName ** | ** {{wiki:PublicProperty.gif|}} IconFilePathName ** | ||
| - | This property gets and sets the path and filename of the icon that will be drawn. | + | * //This property gets and sets the path and filename of the icon that will be drawn.// |
| == Remarks == | == Remarks == | ||
| - | If you need to use a GeoImage, you can set the GeoImage in the constructor or use the property. | + | * //If you need to use a GeoImage, you can set the GeoImage in the constructor or use the property.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 169: | Line 172: | ||
| ** {{wiki:PublicProperty.gif|}} TextValueLengthMin ** | ** {{wiki:PublicProperty.gif|}} TextValueLengthMin ** | ||
| - | This property gets and sets the minimum string length for this item to match. | + | * //This property gets and sets the minimum string length for this item to match.// |
| == Remarks == | == Remarks == | ||
| - | This is an important property because it is used to ensure that that a properly sized icon is used to draw things like road signs. For example, you can set the minimum and maximum values so that the sign icon for a single-digit road number uses one icon, while a two-digit road uses another, wider sign icon in a separate IconValueItem. | + | * //This is an important property because it is used to ensure that that a properly sized icon is used to draw things like road signs. For example, you can set the minimum and maximum values so that the sign icon for a single-digit road number uses one icon, while a two-digit road uses another, wider sign icon in a separate IconValueItem.// |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 177: | Line 180: | ||
| ** {{wiki:PublicProperty.gif|}} TextValueLengthMax ** | ** {{wiki:PublicProperty.gif|}} TextValueLengthMax ** | ||
| - | This property gets and sets the maximum string length for this item to match. | + | * //This property gets and sets the maximum string length for this item to match.// |
| == Remarks == | == Remarks == | ||
| - | This is an important property because it is used to ensure that that a properly sized icon is used to draw things like road signs. For example, you can set the minimum and maximum values so that the sign icon for a single-digit road number uses one icon, while a two-digit road uses another, wider sign icon in a separate IconValueItem. | + | * //This is an important property because it is used to ensure that that a properly sized icon is used to draw things like road signs. For example, you can set the minimum and maximum values so that the sign icon for a single-digit road number uses one icon, while a two-digit road uses another, wider sign icon in a separate IconValueItem.// |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
thinkgeo.mapsuite.portablecore.iconvalueitem.1442823049.txt.gz · Last modified: 2015/09/21 08:10 by admin