User Tools

Site Tools


api:thinkgeo.mapsuite.styles.iconvalueitem

ThinkGeo.MapSuite.Styles.IconValueItem

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Styles.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()

  • N/A
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

  • N/A
Remarks
  • None
Return Value

FieldValue

  • N/A
Remarks
  • For an explanation on how the IconValueStyle works, see the IconValueStyle Class remarks.
Return Value
  • Type:String

IconFilePathName

  • N/A
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

  • N/A
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

  • N/A
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

api/thinkgeo.mapsuite.styles.iconvalueitem.txt · Last modified: 2017/01/11 06:53 (external edit)