thinkgeo.mapsuite.portablecore.iconvalueitem
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.iconvalueitem [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.iconvalueitem [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.IconValueItem ====== | + | ====== ThinkGeo.MapSuite.Core.IconValueItem ====== |
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class is a single item in an IconValueStyle. | This class is a single item in an IconValueStyle. | ||
| - | === Remarks === | ||
| - | This item is used in the IconValueStyle to determine which way to draw the feature based on the FieldValue property. | ||
| - | |||
| - | How IconValueStyle works: | ||
| - | |||
| - | When you create an IconValueStyle, you need to add multiple IconValueItems to its collection. You input the column name in the IconValueStyle and it will compare the data's value to each IconValueItem's FieldValue. If they match, then it will draw the Feature using the properties of the IconValueItem. In this way, you can render different data with different icons or text. | ||
| - | |||
| - | The MinimumLength and MaximumLength properties are important because they are used to ensure 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. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.PortableCore.IconValueItem]] | + | ***ThinkGeo.MapSuite.Core.IconValueItem** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} IconValueItem() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IconValueItem()|IconValueItem]] | | | This is the constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IconValueItem(String, String, TextStyle)|IconValueItem]] | String, String, [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]] | | This is the constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#IconValueItem(String, GeoImage, TextStyle)|IconValueItem]] | String, [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]], [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]] | | This is the constructor for the class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is the constructor for the class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == 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 ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetIconImage() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetIconImage()|GetIconImage]] | | | This method gets the icon we will draw as a GeoImage. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //This method gets the icon we will draw as a GeoImage.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //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.// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FieldValue|FieldValue]] | String | | This property gets and sets the field value that has to match in the IconValueStyle. | | + | * Description:This method gets the icon we will draw as a GeoImage. |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IconFilePathName|IconFilePathName]] | String | | This property gets and sets the path and filename of the icon that will be drawn. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TextStyle|TextStyle]] | [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]] | | This property gets and sets the style that will be used to draw the text in the icon. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TextValueLengthMax|TextValueLengthMax]] | Int32 | | This property gets and sets the maximum string length for this item to match. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TextValueLengthMin|TextValueLengthMin]] | Int32 | | This property gets and sets the minimum string length for this item to match. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== IconValueItem() ==== | + | * Type:String |
| - | This is the constructor for the class. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | This is the default constructor for the class. | + | |
| - | === Remarks === | + | |
| - | If you use the constructor, then you should set all the properties manually. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== IconValueItem(String, String, TextStyle) ==== | + | <div newline></div> |
| - | This is the constructor for the class. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | === Overloads === | + | |
| - | This constructor allows you to set the field value, the path and filename of the icon and the text style you want to use to render it. | + | |
| - | === 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 === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | fieldValue | String<!-- System.String --> | This parameter is the value you want to match. | | + | |
| - | | iconPathFilename | String<!-- System.String --> | This parameter is the path and filename of the image you want to use. | | + | |
| - | | textStyle | [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.PortableCore.TextStyle --> | This parameter is the TextStyle of how you want the text drawn. | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ==== IconValueItem(String, GeoImage, TextStyle) ==== | + | == Remarks == |
| - | This is the constructor for the class. | + | * //N/A// |
| - | === Overloads === | + | |
| - | This constructor allows you to set the field value, the GeoImage, and the text style you want to use to render it. | + | |
| - | === 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 === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | fieldValue | String<!-- System.String --> | This parameter is the value you want to match. | | + | |
| - | | iconImage | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> | This parameter is the GeoImage of the image you want to use. | | + | |
| - | | textStyle | [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.PortableCore.TextStyle --> | This parameter is the TextStyle of how you want the text drawn. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:Boolean |
| - | ===== Public Methods ===== | + | * Description:N/A |
| - | ==== Equals(Object) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //obj// |
| - | | obj | Object<!-- System.Object --> | | | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ==== GetHashCode() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetIconImage() ==== | + | * Description: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 Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> | This method gets the icon we will draw as a GeoImage. | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.IconValueItem --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetType() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== ToString() ==== | + | ==== Protected Methods ==== |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | ==== Finalize() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== MemberwiseClone() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ===== Public Properties ===== | + | ==== Public Properties ==== |
| - | ==== FieldValue ==== | + | ** {{wiki:PublicProperty.gif|}} TextStyle ** |
| - | 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<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.IconValueItem --> | + | * //This property gets and sets the style that will be used to draw the text in the icon.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== IconFilePathName ==== | + | * //None// |
| - | This property gets and sets the path and filename of the icon that will be drawn. | + | == Return Value == |
| - | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] |
| - | If you need to use a GeoImage, you can set the GeoImage in the constructor or use the property. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.IconValueItem --> | + | ** {{wiki:PublicProperty.gif|}} FieldValue ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== TextStyle ==== | + | |
| - | This property gets and sets the style that will be used to draw the text in the icon. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.PortableCore.TextStyle --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.IconValueItem --> | + | * //This property gets and sets the field value that has to match in the IconValueStyle.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== TextValueLengthMax ==== | + | * //For an explanation on how the IconValueStyle works, see the IconValueStyle Class remarks.// |
| - | This property gets and sets the maximum string length for this item to match. | + | == Return Value == |
| - | === Remarks === | + | * Type:String |
| - | 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<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.IconValueItem --> | + | ** {{wiki:PublicProperty.gif|}} IconFilePathName ** |
| - | [[#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<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.IconValueItem --> | + | * //This property gets and sets the path and filename of the icon that will be drawn.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ===== Protected Properties ===== | + | * //If you need to use a GeoImage, you can set the GeoImage in the constructor or use the property.// |
| - | ===== Public Events ===== | + | == Return Value == |
| - | __NOTOC__ | + | * Type:String |
| - | [[Category:MapSuitePortableCore]] | + | |
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | + | ** {{wiki:PublicProperty.gif|}} TextValueLengthMin ** |
| - | [[Category:UpdateDocumentation]] | + | |
| + | * //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 ==== | ||
thinkgeo.mapsuite.portablecore.iconvalueitem.1440040132.txt.gz · Last modified: 2015/09/21 08:10 (external edit)