ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.IconValueItem ======
This class is a single item in an IconValueStyle.
===== Inheritance Hierarchy =====
  *System.Object
    ***ThinkGeo.MapSuite.Core.IconValueItem**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} IconValueItem() **

This is the constructor for the class.
== Remarks ==
If you use the constructor, then you should set all the properties manually.
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} 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//
    * Type:String
    * Description:This parameter is the path and filename of the image you want to use.

  * //textStyle//
    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
    * Description:This parameter is the TextStyle of how you want the text drawn.

<div newline></div>
** {{wiki:PublicMethod.gif|}} IconValueItem(String,GeoImage,TextStyle) **

This is the constructor for the class.
== 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.
== Parameters ==
  * //fieldValue//
    * Type:String
    * Description:This parameter is the value you want to match.

  * //iconImage//
    * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
    * Description:This parameter is the GeoImage of the image you want to use.

  * //textStyle//
    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
    * Description:This parameter is the TextStyle of how you want the text drawn.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} GetIconImage() **

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 ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
  * Description:This method gets the icon we will draw as a GeoImage.

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} Finalize() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} TextStyle **

This property gets and sets the style that will be used to draw the text in the icon.
== Remarks ==
None
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]

** {{wiki:PublicProperty.gif|}} FieldValue **

This property gets and sets the field value that has to match in the IconValueStyle.
== Remarks ==
For an explanation on how the IconValueStyle works, see the IconValueStyle Class remarks.
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} IconFilePathName **

This property gets and sets the path and filename of the icon that will be drawn.
== Remarks ==
If you need to use a GeoImage, you can set the GeoImage in the constructor or use the property.
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} TextValueLengthMin **

This property gets and sets the minimum 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 ==
  * Type:Int32

** {{wiki:PublicProperty.gif|}} TextValueLengthMax **

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 ==
  * Type:Int32

==== Protected Properties ====
==== Public Events ====
User Tools

Site Tools

Page Tools
