Differences

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

--- thinkgeo.mapsuite.core.iconvalueitem [2015/09/17 10:31]
admin
+++ thinkgeo.mapsuite.core.iconvalueitem [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.IconValueItem ======
+{{section>upgrade_map_suite_to_10.0}}
 This class is a single item in an IconValueStyle.
 ===== Inheritance Hierarchy =====
@@ Line 5: / Line 8: @@
     ***ThinkGeo.MapSuite.Core.IconValueItem**
 ===== Members Summary =====
-=== Public Constructors ===
+==== Public Constructors ====
-<div class_table>
+** {{wiki:PublicMethod.gif|}} IconValueItem() **
-**{{wiki:PublicMethod.gif|}}[[#IconValueItem()|IconValueItem]]**
-  * **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|}}[[#IconValueItem(String,String,TextStyle)|IconValueItem]]**
+== Remarks ==
-  * **Parameters**:String,String,[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * //If you use the constructor, then you should set all the properties manually.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is the constructor for the class.
+<div newline></div>
-</div>
+** {{wiki:PublicMethod.gif|}} IconValueItem(String,String,TextStyle) **
-<div class_table>
+  * //This is the constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#IconValueItem(String,GeoImage,TextStyle)|IconValueItem]]**
+== Remarks ==
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * //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.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is the constructor for the class.
+  * //fieldValue//
-</div>
+    * Type:String
+    * Description:This parameter is the value you want to match.
-=== Protected Constructors ===
+  * //iconPathFilename//
-=== Public Methods ===
+    * Type:String
-<div class_table>
+    * Description:This parameter is the path and filename of the image you want to use.
-**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
-  * **Parameters**:Object
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //textStyle//
-**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
+    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-  * **Parameters**:N/A
+    * Description:This parameter is the TextStyle of how you want the text drawn.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#GetIconImage()|GetIconImage]]**
+** {{wiki:PublicMethod.gif|}} IconValueItem(String,GeoImage,TextStyle) **
-  * **Parameters**:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This method gets the icon we will draw as a GeoImage.
-</div>
-<div class_table>
+  * //This is the constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //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.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //fieldValue//
-</div>
+    * Type:String
+    * Description:This parameter is the value you want to match.
-<div class_table>
+  * //iconImage//
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
+    * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
-  * **Parameters**:N/A
+    * Description:This parameter is the GeoImage of the image you want to use.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-=== Protected Methods ===
+  * //textStyle//
-<div class_table>
+    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
+    * Description:This parameter is the TextStyle of how you want the text drawn.
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
+==== Protected Constructors ====
-  * **Parameters**:N/A
+==== Public Methods ====
-  * **DeclaringType**:Object
+** {{wiki:PublicMethod.gif|}} GetIconImage() **
-  * **Summary**:N/A
-</div>
-=== Public Properties ===
+  * //This method gets the icon we will draw as a GeoImage.//
-**{{wiki:PublicProperty.gif|}}[[#FieldValue|FieldValue]]**
+== Remarks ==
-  * **Return**:String
+  * //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.//
-  * **Summary**:This property gets and sets the field value that has to match in the IconValueStyle.
-**{{wiki:PublicProperty.gif|}}[[#IconFilePathName|IconFilePathName]]**
+== Return Value ==
-  * **Return**:String
+  * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
-  * **Summary**:This property gets and sets the path and filename of the icon that will be drawn.
+  * Description:This method gets the icon we will draw as a GeoImage.
-**{{wiki:PublicProperty.gif|}}[[#TextStyle|TextStyle]]**
+== Parameters ==
-  * **Return**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+<div newline></div>
-  * **Summary**:This property gets and sets the style that will be used to draw the text in the icon.
+** {{wiki:PublicMethod.gif|}} ToString() **
-**{{wiki:PublicProperty.gif|}}[[#TextValueLengthMax|TextValueLengthMax]]**
+  * //N/A//
-  * **Return**:Int32
+== Remarks ==
-  * **Summary**:This property gets and sets the maximum string length for this item to match.
+  * //N/A//
-**{{wiki:PublicProperty.gif|}}[[#TextValueLengthMin|TextValueLengthMin]]**
+== Return Value ==
-  * **Return**:Int32
+  * Type:String
-  * **Summary**:This property gets and sets the minimum string length for this item to match.
+  * Description:N/A
-=== Protected Properties ===
+== Parameters ==
-=== Public Events ===
+<div newline></div>
-===== Public Constructors =====
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-=== IconValueItem() ===
-This is the constructor for the class.
-==== Remarks ====
-If you use the constructor, then you should set all the properties manually.
-==== Parameters ====
-[[#Public Constructors|Go Back]]
-=== IconValueItem(String,String,TextStyle) ===
-This is the constructor for the class.
-==== 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.
-==== Parameters ====
-**fieldValue**
-  * **Type**:String
-  * **Description:This parameter is the value you want to match.
-**iconPathFilename**
+  * //N/A//
-  * **Type**:String
+== Remarks ==
-  * **Description:This parameter is the path and filename of the image you want to use.
+  * //N/A//
-**textStyle**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * Type:Boolean
-  * **Description:This parameter is the TextStyle of how you want the text drawn.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== IconValueItem(String,GeoImage,TextStyle) ===
+  * //obj//
-This is the constructor for the class.
+    * Type:Object
-==== Remarks ====
+    * Description:N/A
-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 ====
-**fieldValue**
-  * **Type**:String
-  * **Description:This parameter is the value you want to match.
-**iconImage**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-  * **Description:This parameter is the GeoImage of the image you want to use.
-**textStyle**
+  * //N/A//
-  * **Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+== Remarks ==
-  * **Description:This parameter is the TextStyle of how you want the text drawn.
+  * //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 ==
-=== GetIconImage() ===
+  * //N/A//
-This method gets the icon we will draw as a GeoImage.
-==== 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.
-**Return Value**
+== Return Value ==
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
+  * Type:Void
-  * **Description**:This method gets the icon we will draw as a GeoImage.
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== GetType() ===
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+  * //N/A//
-  * **Return Type**:Type
+== Remarks ==
-  * **Description**:N/A
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Object
-=== ToString() ===
+  * Description:N/A
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:String
+<div newline></div>
-  * **Description**:N/A
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} TextStyle **
-==== Parameters ====
+This property gets and sets the style that will be used to draw the text in the icon.
-[[#Public Methods|Go Back]]
+== Remarks ==
-===== Protected Methods =====
+None
-=== Finalize() ===
+== Return Value ==
-N/A
+  * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-==== Remarks ====
-N/A
-**Return Value**
-  * **Return Type**:Void
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-=== MemberwiseClone() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+** {{wiki:PublicProperty.gif|}} FieldValue **
-  * **Return Type**:Object
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-===== Public Properties =====
-=== FieldValue ===
 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:String
+  * Type:String
+** {{wiki:PublicProperty.gif|}} IconFilePathName **
-[[#Public Properties|Go Back]]
-=== IconFilePathName ===
 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:String
+  * Type:String
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} TextValueLengthMin **
-=== TextStyle ===
-This property gets and sets the style that will be used to draw the text in the icon.
-==== Remarks ====
-None
-==== Return Value ====
-**Return Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-[[#Public Properties|Go Back]]
+This property gets and sets the minimum string length for this item to match.
-=== TextValueLengthMax ===
+== Remarks ==
-This property gets and sets the maximum string length for this item to match.
-==== 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:Int32
+  * Type:Int32
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} TextValueLengthMax **
-=== TextValueLengthMin ===
-This property gets and sets the minimum 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.
-==== Return Value ====
+== Return Value ==
-**Return Type**:Int32
+  * Type:Int32
-[[#Public Properties|Go Back]]
+==== Protected Properties ====
-===== Protected Properties =====
+==== Public Events ====
-===== Public Events =====

User Tools

Site Tools

Differences

Page Tools