This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.mvcedition.markervalueitem [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.mvcedition.markervalueitem [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.MvcEdition.MarkerValueItem ====== | ====== ThinkGeo.MapSuite.MvcEdition.MarkerValueItem ====== | ||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
This class represents one value in a ValueMarkerStyle. | This class represents one value in a ValueMarkerStyle. | ||
- | === Remarks === | ||
- | ValueMarkerStyle: | ||
- | |||
- | The ValueMarkerStyle allows you to match data in the FeatureSource with a value string. If the value matches, then we will use the style defined in that item to create the markers. | ||
- | |||
- | For example, you may have some data about cities, with each city categorized as either a high, medium or low pollution city. Based on the string values of "High", "Medium" and "Low", we can match on these. If a particular feature's data for the column matched "High", then we would use the high MarkerValueItem's style to create that city's marker. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.MvcEdition.MarkerValueItem]] | + | ***ThinkGeo.MapSuite.MvcEdition.MarkerValueItem** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} MarkerValueItem() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#MarkerValueItem()|MarkerValueItem]] | | | Initialize a new instance of the MarkerValueItem class. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#MarkerValueItem(String)|MarkerValueItem]] | String | | Initialize a new instance of the MarkerValueItem class using the value string specified. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#MarkerValueItem(String, MarkerStyle)|MarkerValueItem]] | String, [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]] | | Initialize a new instance of the MarkerValueItem class with the value string and custom marker style specified. | | + | |
- | ==== Protected Constructors ==== | + | * //Initialize a new instance of the MarkerValueItem class.// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} MarkerValueItem(String) ** | ||
+ | * //Initialize a new instance of the MarkerValueItem class using the value string specified.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | * //value// | ||
+ | * Type:String | ||
+ | * Description:The string to compare with the column value of features, which determines whether or not to use this value item to create the markers. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} MarkerValueItem(String,MarkerStyle) ** | ||
+ | |||
+ | * //Initialize a new instance of the MarkerValueItem class with the value string and custom marker style specified.// | ||
+ | == Remarks == | ||
+ | * //It is recommended that you do not use this constructor if it is not necessary. Instead, you can set the properties directly on the DefaultMarkerStyle.// | ||
+ | == Parameters == | ||
+ | * //value// | ||
+ | * Type:String | ||
+ | * Description:The string to compare with the column value of features, which determines whether or not to use this value item to create the markers. | ||
+ | |||
+ | * //customMarkerStyle// | ||
+ | * Type:[[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]] | ||
+ | * Description:The marker style that is applied to the markers with higher priority. | ||
+ | |||
+ | <div newline></div> | ||
+ | ==== Protected Constructors ==== | ||
==== Public Methods ==== | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
- | ==== Protected Methods ==== | + | * //N/A// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
- | ==== Public Properties ==== | + | == Return Value == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomMarkerStyle|CustomMarkerStyle]] | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]] | | Gets or sets the style that could be any type of MarkerStyle. | | + | * Description:N/A |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultMarkerStyle|DefaultMarkerStyle]] | [[ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle|PointMarkerStyle]] | | Gets or sets the marker style that will be applied to the markers if the CustomMarkerStyle is not defined. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Value|Value]] | String | | Gets or sets the value that we will use to match with the feature data. If the value matches, we will use the style for this item. | | + | |
- | ==== Protected Properties ==== | + | == Parameters == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
+ | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | ==== Public Events ==== | + | * //N/A// |
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //N/A// | ||
- | ===== Public Constructors ===== | + | == Return Value == |
- | ==== MarkerValueItem() ==== | + | * Type:Boolean |
- | Initialize a new instance of the MarkerValueItem class. | + | * Description:N/A |
- | === Overloads === | + | |
- | Initialize a new instance of the MarkerValueItem class. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ==== MarkerValueItem(String) ==== | + | * //obj// |
- | Initialize a new instance of the MarkerValueItem class using the value string specified. | + | * Type:Object |
- | === Overloads === | + | * Description:N/A |
- | Initialize a new instance of the MarkerValueItem class. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | value | String<!-- System.String --> | The string to compare with the column value of features, which determines whether or not to use this value item to create the markers. | | + | |
- | [[#Public Constructors|Go Back]] | + | <div newline></div> |
- | ==== MarkerValueItem(String, MarkerStyle) ==== | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | Initialize a new instance of the MarkerValueItem class with the value string and custom marker style specified. | + | |
- | === Overloads === | + | |
- | Initialize a new instance of the MarkerValueItem class. | + | |
- | === Remarks === | + | |
- | It is recommended that you do not use this constructor if it is not necessary. Instead, you can set the properties directly on the DefaultMarkerStyle. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | value | String<!-- System.String --> | The string to compare with the column value of features, which determines whether or not to use this value item to create the markers. | | + | |
- | | customMarkerStyle | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]]<!-- ThinkGeo.MapSuite.MvcEdition.MarkerStyle --> | The marker style that is applied to the markers with higher priority. | | + | |
- | [[#Public Constructors|Go Back]] | + | * //N/A// |
- | ===== Protected Constructors ===== | + | == Remarks == |
- | ===== Public Methods ===== | + | * //N/A// |
- | ==== Equals(Object) ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
- | | obj | Object<!-- System.Object --> | | | + | * Description:N/A |
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | ==== GetHashCode() ==== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | === 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:Type |
- | ==== GetType() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Type<!-- System.Type --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ==== Protected Methods ==== | ||
+ | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | <!-- System.Object --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== ToString() ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | ===== Protected Methods ===== | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | ==== Finalize() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Object |
- | ==== MemberwiseClone() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ==== Public Properties ==== | ||
+ | ** {{wiki:PublicProperty.gif|}} Value ** | ||
- | <!-- System.Object --> | + | Gets or sets the value that we will use to match with the feature data. If the value matches, we will use the style for this item. |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ===== Public Properties ===== | + | N/A |
- | ==== CustomMarkerStyle ==== | + | == Return Value == |
- | Gets or sets the style that could be any type of MarkerStyle. | + | * Type:String |
- | === Remarks === | + | |
- | The <strong>CustomMarkerStyle</strong> could be any type of <strong>MarkerStyle</strong>. This style has a higher priority than the <strong>DefaultMarkerStyle</strong>. This means that if you defined both <strong>DefaultMarkerStyle</strong> and <strong>CustomMarkerStyle</strong>, the <strong>CustomMarkerStyle</strong> will be used. | + | ** {{wiki:PublicProperty.gif|}} DefaultMarkerStyle ** |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]]<!-- ThinkGeo.MapSuite.MvcEdition.MarkerStyle --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerValueItem --> | ||
- | [[#Public Properties|Go Back]] | ||
- | ==== DefaultMarkerStyle ==== | ||
Gets or sets the marker style that will be applied to the markers if the CustomMarkerStyle is not defined. | Gets or sets the marker style that will be applied to the markers if the CustomMarkerStyle is not defined. | ||
- | === Return Value === | + | == Remarks == |
- | ^ Return Type ^ | + | N/A |
- | | [[ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle|PointMarkerStyle]]<!-- ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle --> | | + | == Return Value == |
+ | * Type:[[ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle|PointMarkerStyle]] | ||
- | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerValueItem --> | + | ** {{wiki:PublicProperty.gif|}} CustomMarkerStyle ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== Value ==== | + | |
- | Gets or sets the value that we will use to match with the feature data. If the value matches, we will use the style for this item. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerValueItem --> | + | Gets or sets the style that could be any type of MarkerStyle. |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ===== Protected Properties ===== | + | The CustomMarkerStyle could be any type of MarkerStyle. This style has a higher priority than the DefaultMarkerStyle. This means that if you defined both DefaultMarkerStyle and CustomMarkerStyle, the CustomMarkerStyle will be used. |
- | ===== Public Events ===== | + | == Return Value == |
- | __NOTOC__ | + | * Type:[[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]] |
- | [[Category:MvcEdition]] | + | |
- | [[Category:ThinkGeo.MapSuite.MvcEdition]] | + | ==== Protected Properties ==== |
- | [[Category:UpdateDocumentation]] | + | ==== Public Events ==== |