ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.windowsphonecore.regexstyle
Table of Contents
ThinkGeo.MapSuite.WindowsPhoneCore.RegexStyle
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.
<!– Class –> This class allows you to draw features differently based on regular expression matching.
Remarks
RegexStyle:
The RegexStyle allows you to use complex regular expression matching to determine how your features are drawn. A regular expression is a matching syntax that allows you to match a string based on very complex criteria. For example, let's say you have a layer that has a column in the data that contains school names. Most school names include the type of school they are. For instance, you may have “Lincoln Middle School” or “Bush High School.” There are variations to these names though, containing words such as “Elementary” or “Prep.” With a regular expression, you can create matching criteria that will allow you to match on many variations of the names. It is especially useful for fuzzy matches where your data is not clearly categorized. Another classic example is for matching or validating email addresses, where matching rules can become complex.
In the RegexStyle, you specify the matching criteria string and also the style you want to use to draw the feature if the criteria matches. It is a simple yet powerful style for dealing with complex rule sets and imprecise data.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.WindowsPhoneCore.Style *ThinkGeo.MapSuite.WindowsPhoneCore.RegexStyle
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 RegexStyle | This is a constructor for the class. | ||
| RegexStyle | String, Collection<RegexItem> | This is a constructor for the class. | |
| RegexStyle | String, Collection<RegexItem>, RegexMatching | This is a constructor for the class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Draw | IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style | This method draws the shapes on the canvas you provided. |
| Draw | IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style | This method draws the features on the canvas you provided. |
| DrawSample | GeoCanvas, DrawingRectangleF | Style | |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetRequiredColumnNames | Style | This method returns the column data for each feature that is required for the style to properly draw. | |
| GetType | Object | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 DrawCore | IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style(overriden) | This method draws the features on the canvas you provided. |
| DrawSampleCore | GeoCanvas, DrawingRectangleF | Style | |
| Finalize | Object | ||
| GetRequiredColumnNamesCore | Style(overriden) | This method returns the column data for each feature that is required for the style to properly draw. | |
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 ColumnName | String | This property gets and sets the column name whose value will be tested against the regular expression. | |
| IsActive | Boolean | Style | This property gets and sets the active status of the style. |
| Name | String | Style | This property gets and set the name of the style. |
| RegexItems | Collection<RegexItem> | This property gets the collection of RegexItems. Each item can have its own regular expression to match. | |
| RegexMatchingRule | RegexMatching | This property gets and sets the regular expression matching rule. The rule determines whether we match the entire string or just any portion of it. | |
| RequiredColumnNames | Collection<String> | Style | This property gets the collection of fields that are required for the style. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
RegexStyle()
This is a constructor for the class.
Overloads
This is the default constructor for the class. If you use this constructor, you need to set the various properties manually.
Remarks
If you use this constructor, you need to set the various properties manually.
Parameters
| Name | Type | Description |
|---|
RegexStyle(String, Collection<RegexItem>)
This is a constructor for the class.
Overloads
This constructor allows you specify the columnName and regexItems for the class. You can also set the various properties manually.
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> | This parameter is the columnName you want to use in the style. |
| regexItems | Collection<RegexItem><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.RegexItem} –> | This parameter specifies the regexItems in the style. |
RegexStyle(String, Collection<RegexItem>, RegexMatching)
This is a constructor for the class.
Overloads
This constructor allows you specify the columnName, regexItems and regexMatching rule for the class. You can also set the various properties manually.
Parameters
| Name | Type | Description |
|---|---|---|
| columnName | String<!– System.String –> | This parameter is the columnName you want to use in the style. |
| regexItems | Collection<RegexItem><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.RegexItem} –> | This parameter specifies the regexItems in the style. |
| regexMatching | RegexMatching<!– ThinkGeo.MapSuite.WindowsPhoneCore.RegexMatching –> | This parameter specifies the regexMatching rule for the style. |
Protected Constructors
Public Methods
Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)
This method draws the shapes on the canvas you provided.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the shapes you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each shape differently.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| shapes | IEnumerable<BaseShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.WindowsPhoneCore.BaseShape} –> | This parameter represents the shapes you want to draw on the canvas. |
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | This parameter represents the canvas you want to draw the shapes on. |
| labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)
This method draws the features on the canvas you provided.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.WindowsPhoneCore.Feature} –> | This parameter represents the features you want to draw on the canvas. |
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
| labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
DrawSample(GeoCanvas, DrawingRectangleF)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | |
| drawingExtent | DrawingRectangleF<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingRectangleF –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetRequiredColumnNames()
This method returns the column data for each feature that is required for the style to properly draw.
Remarks
This method is the concrete wrapper for the abstract method GetRequiredColumnNamesCore. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw.
In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore we read that property and add it to the collection.
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns a collection of column names that the style needs. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)
This method draws the features on the canvas you provided.
Remarks
This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style based on its properties may draw each feature differently.
When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.WindowsPhoneCore.Feature} –> | This parameter represents the features you want to draw on the canvas. |
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
| labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style(overriden) –> Go Back
DrawSampleCore(GeoCanvas, DrawingRectangleF)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas –> | |
| drawingExtent | DrawingRectangleF<!– ThinkGeo.MapSuite.WindowsPhoneCore.DrawingRectangleF –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetRequiredColumnNamesCore()
This method returns the column data for each feature that is required for the style to properly draw.
Remarks
This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw.
In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns a collection of the column names that it needs. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style(overriden) –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
ColumnName
This property gets and sets the column name whose value will be tested against the regular expression.
Remarks
This is the column we use for matching.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.RegexStyle –> Go Back
IsActive
This property gets and sets the active status of the style.
Remarks
If the style is not active then it will not draw.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
Name
This property gets and set the name of the style.
Remarks
This name is not used by the system; it is only for the developer. However, it can be used if you generate your own legend.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
RegexItems
This property gets the collection of RegexItems. Each item can have its own regular expression to match.
Remarks
You will want to add RegexItems to this collection. Each item can have its own style and matching string.
Return Value
| Return Type |
|---|
| Collection<RegexItem><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WindowsPhoneCore.RegexItem} –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.RegexStyle –> Go Back
RegexMatchingRule
This property gets and sets the regular expression matching rule. The rule determines whether we match the entire string or just any portion of it.
Remarks
This is used to determine how much of a string needs to match a regular expression in order to declare it a match for that expression. Sometimes, you only need one part of the string to match in order for the expression to be considered a match; other times you may want the entire string to match.
Return Value
| Return Type |
|---|
| RegexMatching<!– ThinkGeo.MapSuite.WindowsPhoneCore.RegexMatching –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.RegexStyle –> Go Back
RequiredColumnNames
This property gets the collection of fields that are required for the style.
Remarks
This property gets the collection of fields that are required for the style. These are in addition to any other columns you specify in styles that inherit from this one. For example, if you have use a ValueStyle and it requires a column name for the value comparison, then that column does not need to be in this collection. You only use the RequiredColumnNames for columns you need beyond those required by specific inherited styles.
Return Value
| Return Type |
|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.WindowsPhoneCore.Style –> Go Back
Protected Properties
Public Events
thinkgeo.mapsuite.windowsphonecore.regexstyle.txt · Last modified: 2017/03/16 21:59 (external edit)