thinkgeo.mapsuite.core.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.core.iconvalueitem [2015/09/17 10:31] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== 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 === | ||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#IconValueItem()|IconValueItem]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the constructor for the class. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#IconValueItem(String,String,TextStyle)|IconValueItem]]** | ||
| - | * **Parameters**:String,String,[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the constructor for the class. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#IconValueItem(String,GeoImage,TextStyle)|IconValueItem]]** | ||
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the constructor for the class. | ||
| - | </div> | ||
| - | |||
| - | === Protected Constructors === | ||
| - | === Public Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | ||
| - | * **Parameters**:Object | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetIconImage()|GetIconImage]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method gets the icon we will draw as a GeoImage. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Protected Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Public Properties === | ||
| - | **{{wiki:PublicProperty.gif|}}[[#FieldValue|FieldValue]]** | ||
| - | * **Return**:String | ||
| - | * **Summary**:This property gets and sets the field value that has to match in the IconValueStyle. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#IconFilePathName|IconFilePathName]]** | ||
| - | * **Return**:String | ||
| - | * **Summary**:This property gets and sets the path and filename of the icon that will be drawn. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#TextStyle|TextStyle]]** | ||
| - | * **Return**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | ||
| - | * **Summary**:This property gets and sets the style that will be used to draw the text in the icon. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#TextValueLengthMax|TextValueLengthMax]]** | ||
| - | * **Return**:Int32 | ||
| - | * **Summary**:This property gets and sets the maximum string length for this item to match. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#TextValueLengthMin|TextValueLengthMin]]** | ||
| - | * **Return**:Int32 | ||
| - | * **Summary**:This property gets and sets the minimum string length for this item to match. | ||
| - | |||
| - | === Protected Properties === | ||
| - | === Public Events === | ||
| - | ===== 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 ==== | ||
| - | [[#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** | ||
| - | * **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. | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | === 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. | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | === Equals(Object) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Boolean | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **obj** | ||
| - | * **Type**:Object | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetHashCode() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Int32 | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === 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** | ||
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| - | * **Description**:This method gets the icon we will draw as a GeoImage. | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetType() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Type | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === ToString() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | === Finalize() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === MemberwiseClone() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **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 ==== | ||
| - | For an explanation on how the IconValueStyle works, see the IconValueStyle Class remarks. | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:String | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === 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 ==== | ||
| - | **Return Type**:String | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === 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]] | ||
| - | === 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 ==== | ||
| - | **Return Type**:Int32 | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === 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 ==== | ||
| - | **Return Type**:Int32 | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
thinkgeo.mapsuite.core.iconvalueitem.1442485904.txt.gz ยท Last modified: 2015/09/17 10:31 by admin
