====== ThinkGeo.MapSuite.Core.RegexStyle ======

{{section>upgrade_map_suite_to_10.0}}

This class allows you to draw features differently based on regular expression matching.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.Core.Style
      ***ThinkGeo.MapSuite.Core.RegexStyle**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} RegexStyle() **

  * //This is a constructor for the class.//
== Remarks ==
  * //If you use this constructor, you need to set the various properties manually.//
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} RegexStyle(String,Collection<RegexItem>) **

  * //This is a constructor for the class.//
== Remarks ==
  * //None.//
== Parameters ==
  * //columnName//
    * Type:String
    * Description:This parameter is the columnName you want to use in the style.

  * //regexItems//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>
    * Description:This parameter specifies the regexItems in the style.

<div newline></div>
** {{wiki:PublicMethod.gif|}} RegexStyle(String,Collection<RegexItem>,RegexMatching) **

  * //This is a constructor for the class.//
== Remarks ==
  * //None.//
== Parameters ==
  * //columnName//
    * Type:String
    * Description:This parameter is the columnName you want to use in the style.

  * //regexItems//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>
    * Description:This parameter specifies the regexItems in the style.

  * //regexMatching//
    * Type:[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]]
    * Description:This parameter specifies the regexMatching rule for the style.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} CloneDeep() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //features//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //shapes//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //drawingExtent//
    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} SaveStyle(String) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //filePathName//
    * Type:String
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //stream//
    * Type:Stream
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} 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 ==
  * Type:Void
  * Description:None

== Parameters ==
  * //features//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:This parameter represents the features you want to draw on the canvas.

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:This parameter represents the canvas you want to draw the features on.

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in the current layer only.

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in all layers.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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 ==
  * Type:Collection<String>
  * Description:This method returns a collection of the column names that it needs.

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //drawingExtent//
    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

  * //N/A//
== Remarks ==
  * //N/A//

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} 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 ==
  * Type:[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]]

** {{wiki:PublicProperty.gif|}} 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 ==
  * Type:String

** {{wiki:PublicProperty.gif|}} 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 ==
  * Type:Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>

** {{wiki:PublicProperty.gif|}} Name **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} IsActive **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} RequiredColumnNames **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<String>

** {{wiki:PublicProperty.gif|}} Filters **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<String>

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} FiltersCore **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<String>

==== Public Events ====