User Tools

Site Tools


thinkgeo.mapsuite.core.iconvalueitem

ThinkGeo.MapSuite.Core.IconValueItem

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This class is a single item in an IconValueStyle.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.IconValueItem

Members Summary

Public Constructors

IconValueItem()

  • This is the constructor for the class.
Remarks
  • If you use the constructor, then you should set all the properties manually.
Parameters

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:TextStyle
    • Description:This parameter is the TextStyle of how you want the text drawn.

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:GeoImage
    • Description:This parameter is the GeoImage of the image you want to use.
  • textStyle
    • Type:TextStyle
    • Description:This parameter is the TextStyle of how you want the text drawn.

Protected Constructors

Public Methods

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:GeoImage
  • Description:This method gets the icon we will draw as a GeoImage.
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

TextStyle

This property gets and sets the style that will be used to draw the text in the icon.

Remarks

None

Return Value

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

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

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

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

thinkgeo.mapsuite.core.iconvalueitem.txt · Last modified: 2017/03/16 21:59 (external edit)