User Tools

Site Tools


thinkgeo.mapsuite.core.regexstyle

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
thinkgeo.mapsuite.core.regexstyle [2015/09/17 10:38]
admin
thinkgeo.mapsuite.core.regexstyle [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Core.RegexStyle ====== ====== ThinkGeo.MapSuite.Core.RegexStyle ======
 +
 +{{section>​upgrade_map_suite_to_10.0}}
 +
 This class allows you to draw features differently based on regular expression matching. This class allows you to draw features differently based on regular expression matching.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
Line 6: Line 9:
       ***ThinkGeo.MapSuite.Core.RegexStyle**       ***ThinkGeo.MapSuite.Core.RegexStyle**
 ===== Members Summary ===== ===== Members Summary =====
-=== Public Constructors === +==== Public Constructors ==== 
-<div class_table>​ +** {{wiki:​PublicMethod.gif|}} RegexStyle() **
-**{{wiki:​PublicMethod.gif|}}[[#RegexStyle()|RegexStyle]]** +
-  * **Parameters**:​N/​A +
-  * **DeclaringType**:​N/​A +
-  * **Summary**:​This is a constructor for the class. +
-</​div>​+
  
-<​div ​class_table+  * //This is a constructor for the class.// 
-**{{wiki:​PublicMethod.gif|}}[[#RegexStyle(String,​Collection<​RegexItem>​)|RegexStyle]]** +== Remarks == 
-  * **Parameters**:​String,​Collection<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>​ +  * //If you use this constructor,​ you need to set the various properties manually.//​ 
-  * **DeclaringType**:​N/​A +== Parameters == 
-  * **Summary**:​This is a constructor for the class. +<​div ​newline></​div
-</​div>​+** {{wiki:​PublicMethod.gif|}} RegexStyle(String,​Collection<​RegexItem>​) **
  
-<div class_table>​ +  ​//This is a constructor for the class.// 
-**{{wiki:​PublicMethod.gif|}}[[#​RegexStyle(String,​Collection<​RegexItem>,​RegexMatching)|RegexStyle]]** +== Remarks == 
-  * **Parameters**:​String,​Collection<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>,​[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]] +  * //None.// 
-  * **DeclaringType**:N/A +== Parameters == 
-  * **Summary**:This is a constructor for the class. +  * //​columnName//​ 
-</​div>​+    ​Type:String 
 +    Description:This parameter ​is the columnName you want to use in the style.
  
-=== Protected Constructors === +  ​* //​regexItems//​ 
-=== Public Methods === +    Type:Collection<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]> 
-<div class_table>​ +    Description:This parameter specifies the regexItems in the style.
-**{{wiki:​PublicMethod.gif|}}[[#​CloneDeep()|CloneDeep]]** +
-  * **Parameters**:​N/A +
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:N/A +
-</​div>​+
  
-<​div ​class_table+<​div ​newline></​div
-**{{wiki:​PublicMethod.gif|}}[[#Draw(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,Collection<​SimpleCandidate>​)|Draw]]** +** {{wiki:​PublicMethod.gif|}} ​RegexStyle(String,​Collection<​RegexItem>,RegexMatching) **
-  * **Parameters**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:​N/​A +
-</​div>​+
  
-<div class_table>​ +  ​//This is a constructor for the class.// 
-**{{wiki:​PublicMethod.gif|}}[[#​Draw(IEnumerable<​BaseShape>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​)|Draw]]** +== Remarks == 
-  * **Parameters**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>,​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +  * //None.// 
-  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] +== Parameters == 
-  * **Summary**:N/A +  * //​columnName//​ 
-</​div>​+    ​Type:String 
 +    Description:This parameter is the columnName you want to use in the style.
  
-<div class_table>​ +  ​//​regexItems//​ 
-**{{wiki:​PublicMethod.gif|}}[[#​DrawSample(GeoCanvas,​DrawingRectangleF)|DrawSample]]*+    Type:Collection<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]> 
-  * **Parameters**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] +    Description:This parameter specifies the regexItems in the style.
-  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:​N/​A +
-</​div>​+
  
-<div class_table>​ +  ​//​regexMatching//​ 
-**{{wiki:​PublicMethod.gif|}}[[#​DrawSample(GeoCanvas)|DrawSample]]*+    Type:​[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]] 
-  * **Parameters**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] +    Description:This parameter specifies the regexMatching rule for the style.
-  * **DeclaringType**:[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:​N/​A +
-</​div>​+
  
-<​div ​class_table+<​div ​newline></​div>​ 
-**{{wiki:​PublicMethod.gif|}}[[#Equals(Object)|Equals]]** +==== Protected Constructors ==== 
-  * **Parameters**:​Object +==== Public Methods ==== 
-  * **DeclaringType**:​Object +** {{wiki:​PublicMethod.gif|}} ​CloneDeep() **
-  * **Summary**:​N/​A +
-</​div>​+
  
-<div class_table>​ +  ​//N/A// 
-**{{wiki:​PublicMethod.gif|}}[[#​GetHashCode()|GetHashCode]]** +== Remarks == 
-  * **Parameters**:​N/A +  * //N/A//
-  * **DeclaringType**:​Object +
-  * **Summary**:​N/A +
-</div>+
  
-<div class_table>​ +== Return Value == 
-**{{wiki:​PublicMethod.gif|}}[[#​GetRequiredColumnNames()|GetRequiredColumnNames]]** +  * Type:​[[ThinkGeo.MapSuite.Core.Style|Style]] 
-  * **Parameters**:​N/​A +  * Description:N/A
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:N/A +
-</​div>​+
  
-<​div ​class_table+== Parameters == 
-**{{wiki:​PublicMethod.gif|}}[[#GetType()|GetType]]** +<​div ​newline></​div
-  * **Parameters**:​N/​A +** {{wiki:​PublicMethod.gif|}} ​Draw(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
-  * **DeclaringType**:​Object +
-  * **Summary**:​N/​A +
-</​div>​+
  
-<div class_table>​ +  ​//N/A// 
-**{{wiki:​PublicMethod.gif|}}[[#​SaveStyle(String)|SaveStyle]]*+== Remarks == 
-  * **Parameters**:​String +  * //N/A//
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:​N/A +
-</div>+
  
-<div class_table>​ +== Return Value == 
-**{{wiki:​PublicMethod.gif|}}[[#​SaveStyle(Stream)|SaveStyle]]** +  * Type:Void 
-  * **Parameters**:Stream +  * Description:N/A
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:N/A +
-</​div>​+
  
-<div class_table>​ +== Parameters == 
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** +  //​features//​ 
-  * **Parameters**:N/A +    ​Type:IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]> 
-  * **DeclaringType**:​Object +    Description:N/A
-  * **Summary**:​N/​A +
-</​div>​+
  
-=== Protected Methods === +  ​* //canvas// 
-<div class_table>​ +    Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-**{{wiki:​ProtectedMethod.gif|}}[[#​CloneDeepCore()|CloneDeepCore]]** +    Description:N/A
-  * **Parameters**:​N/A +
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:N/A +
-</​div>​+
  
-<div class_table>​ +  ​//​labelsInThisLayer//​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​DrawCore(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​)|DrawCore]]*+    Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Parameters**:IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>,​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>,​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +    Description:N/A
-  * **DeclaringType**:N/A +
-  * **Summary**:​This method draws the features on the canvas you provided. +
-</​div>​+
  
-<div class_table>​ +  ​//​labelsInAllLayers//​ 
-**{{wiki:​ProtectedMethod.gif|}}[[#​DrawSampleCore(GeoCanvas,​DrawingRectangleF)|DrawSampleCore]]*+    Type:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> 
-  * **Parameters**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]],​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] +    Description:N/A
-  * **DeclaringType**:​[[ThinkGeo.MapSuite.Core.Style|Style]] +
-  * **Summary**:N/A +
-</​div>​+
  
-<​div ​class_table+<​div ​newline></​div
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** +** {{wiki:PublicMethod.gif|}} ​Draw(IEnumerable<​BaseShape>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
-  * **Parameters**:​N/​A +
-  * **DeclaringType**:​Object +
-  * **Summary**:​N/​A +
-</​div>​+
  
-<div class_table>​ +  ​//N/A// 
-**{{wiki:​ProtectedMethod.gif|}}[[#​GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]]** +== Remarks == 
-  * **Parameters**:​N/A +  * //N/A//
-  * **DeclaringType**:​N/A +
-  * **Summary**:​This method returns the column data for each feature that is required for the style to properly draw. +
-</div>+
  
-<div class_table>​ +== Return Value == 
-**{{wiki:​ProtectedMethod.gif|}}[[#​MemberwiseClone()|MemberwiseClone]]** +  * Type:Void 
-  * **Parameters**:N/A +  * Description:N/A
-  * **DeclaringType**:​Object +
-  * **Summary**:N/A +
-</​div>​+
  
-=== Public Properties === +== Parameters ​== 
-**{{wiki:PublicProperty.gif|}}[[#ColumnName|ColumnName]]** +  //​shapes//​ 
-  * **Return**:String +    ​Type:IEnumerable<​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]> 
-  * **Summary**:​This property gets and sets the column name whose value will be tested against the regular expression.+    Description:N/A
  
-**{{wiki:PublicProperty.gif|}}[[#Filters|Filters]]** +  ​//​canvas//​ 
-  * **Return**:​Collection<​String>​ +    ​Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-  * **Summary**:N/A+    Description:N/A
  
-**{{wiki:PublicProperty.gif|}}[[#IsActive|IsActive]]** +  ​//​labelsInThisLayer//​ 
-  * **Return**:​Boolean +    ​Type:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> 
-  * **Summary**:N/A+    Description:N/A
  
-**{{wiki:PublicProperty.gif|}}[[#Name|Name]]** +  ​//​labelsInAllLayers//​ 
-  * **Return**:​String +    ​Type:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> 
-  * **Summary**:N/A+    Description:N/A
  
-**{{wiki:PublicProperty.gif|}}[[#​RegexItems|RegexItems]]** +<div newline></​div>​ 
-  * **Return**:​Collection<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>​ +** {{wiki:PublicMethod.gif|}} ​GetRequiredColumnNames() ​**
-  * **Summary**:​This property gets the collection of RegexItems. Each item can have its own regular expression to match.+
  
-**{{wiki:​PublicProperty.gif|}}[[#​RegexMatchingRule|RegexMatchingRule]]** +  ​//N/A// 
-  * **Return**:​[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]] +== Remarks == 
-  * **Summary**:​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.+  * //N/A//
  
-**{{wiki:​PublicProperty.gif|}}[[#​RequiredColumnNames|RequiredColumnNames]]** +== Return Value == 
-  * **Return**:​Collection<​String>​ +  * Type:​Collection<​String>​ 
-  * **Summary**:N/A+  * Description:N/A
  
-=== Protected Properties === +== Parameters ​== 
-**{{wiki:ProtectedProperty.gif|}}[[#​FiltersCore|FiltersCore]]** +<div newline></​div>​ 
-  * **Return**:​Collection<​String>​ +** {{wiki:PublicMethod.gif|}} ​DrawSample(GeoCanvas,​DrawingRectangleF) ​**
-  * **Summary**:​N/​A+
  
-=== Public Events === +  * //N/A// 
-===== Public Constructors ===== +== Remarks == 
-=== RegexStyle() === +  * //N/A//
-This is a constructor for the class. +
-==== Remarks ​==== +
-If you use this constructor,​ you need to set the various properties manually. +
-==== Parameters ==== +
-[[#Public Constructors|Go Back]] +
-=== 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** +== Return Value == 
-  ​* **Type**:Collection<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>​ +  * Type:Void 
-  ​* **Description:​This parameter specifies the regexItems in the style.+  * Description:​N/A
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-=== RegexStyle(String,​Collection<​RegexItem>,​RegexMatching) === +  //canvas// 
-This is a constructor for the class. +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-==== Remarks ==== +    * Description:​N/A
-None. +
-==== Parameters ​==== +
-**columnName** +
-  * **Type**:String +
-  * **Description:​This parameter is the columnName you want to use in the style.+
  
-**regexItems** +  ​//​drawingExtent//​ 
-  * **Type**:Collection<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]> +    * Type:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-  * **Description:​This parameter specifies the regexItems in the style.+    * Description:​N/A
  
-**regexMatching** +<div newline></​div>​ 
-  * **Type**:[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]] +** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ​**
-  ​* **Description:​This parameter specifies the regexMatching rule for the style.+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-===== Protected Constructors ===== +== Remarks == 
-===== Public Methods ===== +  * //N/A//
-=== CloneDeep() === +
-N/A +
-==== Remarks ​==== +
-N/A+
  
-**Return Value** +== Return Value == 
-  * **Return ​Type**:[[ThinkGeo.MapSuite.Core.Style|Style]] +  * Type:Void 
-  ​* **Description**:N/A+  * Description:​N/​A
  
-==== Parameters ​==== +== Parameters == 
-[[#Public Methods|Go Back]] +  * //​canvas//​ 
-=== Draw(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) === +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-N/A +    * Description:​N/A
-==== Remarks ==== +
-N/A+
  
-**Return Value** +<div newline></​div>​ 
-  * **Return Type**:Void +** {{wiki:PublicMethod.gif|}} SaveStyle(String) ​**
-  ​* **Description**:​N/​A+
  
-==== Parameters ==== +  * //N/A// 
-**features** +== Remarks ​== 
-  * **Type**:​IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​ +  * //N/A//
-  * **Description**:​N/A+
  
-**canvas** +== Return Value == 
-  ​* **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] +  * Type:Void 
-  ​* **Description**:N/A+  * Description:​N/​A
  
-**labelsInThisLayer** +== Parameters == 
-  * **Type**:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +  * //​filePathName//​ 
-  * **Description**:N/A+    ​* Type:String 
 +    * Description:​N/​A
  
-**labelsInAllLayers** +<div newline></​div>​ 
-  * **Type**:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ​**
-  ​* **Description**:​N/​A+
  
-[[#Public Methods|Go Back]] +  * //N/A// 
-=== Draw(IEnumerable<​BaseShape>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) === +== Remarks == 
-N/A +  * //N/A//
-==== Remarks ​==== +
-N/A+
  
-**Return Value** +== Return Value == 
-  * **Return ​Type**:Void +  * Type:Void 
-  ​* **Description**:N/A+  * Description:​N/​A
  
-==== Parameters ​==== +== Parameters == 
-**shapes** +  //stream// 
-  * **Type**:IEnumerable<​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>​ +    * Type:Stream 
-  * **Description**:N/A+    * Description:​N/​A
  
-**canvas** +<div newline></​div>​ 
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] +** {{wiki:PublicMethod.gif|}} ToString() ​**
-  ​* **Description**:​N/​A+
  
-**labelsInThisLayer** +  ​//N/A// 
-  * **Type**:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +== Remarks == 
-  * **Description**:​N/A+  * //N/A//
  
-**labelsInAllLayers** +== Return Value == 
-  ​* **Type**:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +  * Type:String 
-  ​* **Description**:N/A+  * Description:​N/​A
  
-[[#Public Methods|Go Back]] +== Parameters ​== 
-=== DrawSample(GeoCanvas,​DrawingRectangleF) === +<div newline><​/div> 
-N/A +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-==== Remarks ==== +
-N/A+
  
-**Return Value** +  ​//N/A// 
-  * **Return Type**:Void +== Remarks == 
-  * **Description**:​N/A+  * //N/A//
  
-==== Parameters ==== +== Return Value == 
-**canvas** +  * Type:Boolean 
-  ​* **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] +  * Description:​N/​A
-  ​* **Description**:N/A+
  
-**drawingExtent** +== Parameters == 
-  * **Type**:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] +  * //obj// 
-  * **Description**:N/A+    ​* Type:Object 
 +    * Description:​N/​A
  
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-=== DrawSample(GeoCanvas=== +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-N/A +
-==== Remarks ==== +
-N/A+
  
-**Return Value** +  ​//N/A// 
-  * **Return Type**:Void +== Remarks == 
-  * **Description**:​N/A+  * //N/A//
  
-==== Parameters ==== +== Return Value == 
-**canvas** +  * Type:Int32 
-  ​* **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] +  * Description:​N/​A
-  ​* **Description**:N/A+
  
-[[#Public Methods|Go Back]] +== Parameters ​== 
-=== Equals(Object) === +<div newline><​/div> 
-N/A +** {{wiki:​PublicMethod.gif|}} GetType() **
-==== Remarks ==== +
-N/A+
  
-**Return Value** +  ​//N/A// 
-  * **Return Type**:​Boolean +== Remarks == 
-  * **Description**:​N/A+  * //N/A//
  
-==== Parameters ==== +== Return Value == 
-**obj** +  * Type:Type 
-  ​* **Type**:Object +  * Description:​N/​A
-  ​* **Description**:N/A+
  
-[[#Public Methods|Go Back]] +== Parameters ​== 
-=== GetHashCode() === +<div newline><​/div> 
-N/A +==== Protected Methods ​==== 
-==== Remarks ​==== +** {{wiki:​ProtectedMethod.gif|}} DrawCore(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
-N/A+
  
-**Return Value** +  ​//This method draws the features on the canvas you provided.// 
-  * **Return Type**:​Int32 +== Remarks == 
-  * **Description**:​N/A+  * //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.//​
  
-==== Parameters ==== +== Return Value == 
-[[#Public Methods|Go Back]] +  * Type:Void 
-=== GetRequiredColumnNames() === +  * Description:​None
-N/A +
-==== Remarks ==== +
-N/A+
  
-**Return Value** +== Parameters == 
-  * **Return ​Type**:Collection<String+  * //​features//​ 
-  * **Description**:N/A+    ​* Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]
 +    * Description:​This parameter represents the features you want to draw on the canvas.
  
-==== Parameters ==== +  * //canvas// 
-[[#Public Methods|Go Back]] +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-=== GetType() === +    * Description:​This parameter represents the canvas you want to draw the features on.
-N/A +
-==== Remarks ==== +
-N/A+
  
-**Return Value** +  ​//​labelsInThisLayer//​ 
-  **Return ​Type**:Type +    * Type:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ 
-  * **Description**:N/A+    * Description:​The labels will be drawn in the current layer only.
  
-==== Parameters ==== +  * //​labelsInAllLayers//​ 
-[[#Public Methods|Go Back]] +    * Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> 
-=== SaveStyle(String) === +    * Description:​The labels will be drawn in all layers.
-N/A +
-==== Remarks ==== +
-N/A+
  
-**Return Value** +<div newline></​div>​ 
-  * **Return Type**:Void +** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ​**
-  ​* **Description**:​N/​A+
  
-==== Parameters ==== +  * //This method returns the column data for each feature that is required for the style to properly draw.// 
-**filePathName** +== Remarks ​== 
-  * **Type**:​String +  * //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.//​
-  * **Description**:​N/A+
  
-[[#Public Methods|Go Back]] +== Return Value == 
-=== SaveStyle(Stream) === +  * Type:​Collection<​String>​ 
-N/A +  * Description:​This method returns a collection of the column names that it needs.
-==== Remarks ==== +
-N/A+
  
-**Return Value** +== Parameters == 
-  * **Return Type**:Void +<div newline></​div>​ 
-  ​* **Description**:​N/​A+** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ​**
  
-==== Parameters ==== +  * //N/A// 
-**stream** +== Remarks ​== 
-  * **Type**:​Stream +  * //N/A//
-  * **Description**:​N/A+
  
-[[#Public Methods|Go Back]] +== Return Value == 
-=== ToString() === +  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]] 
-N/A +  * Description:​N/A
-==== Remarks ==== +
-N/A+
  
-**Return Value** +== Parameters == 
-  * **Return Type**:String +<div newline></​div>​ 
-  ​* **Description**:​N/​A+** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,​DrawingRectangleF) ​**
  
-==== Parameters ==== +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks == 
-===== Protected Methods ===== +  * //N/A//
-=== CloneDeepCore() === +
-N/A +
-==== Remarks ​==== +
-N/A+
  
-**Return Value** +== Return Value == 
-  * **Return ​Type**:[[ThinkGeo.MapSuite.Core.Style|Style]] +  * Type:Void 
-  ​* **Description**:N/A+  * Description:​N/​A
  
-==== Parameters ​==== +== Parameters == 
-[[#Protected Methods|Go Back]] +  * //​canvas//​ 
-=== DrawCore(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) === +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-This method draws the features on the canvas you provided. +    * Description:​N/​A
-==== 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** +  ​//​drawingExtent//​ 
-  **Return ​Type**:Void +    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-  * **Description**:None+    * Description:​N/A
  
-==== Parameters ==== +<div newline></​div>​ 
-**features** +** {{wiki:ProtectedMethod.gif|}} Finalize() ​**
-  * **Type**:IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​ +
-  ​* **Description**:​This parameter represents the features you want to draw on the canvas.+
  
-**canvas** +  ​//N/A// 
-  * **Type**:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] +== Remarks == 
-  * **Description**:​This parameter represents the canvas you want to draw the features on.+  * //N/A//
  
-**labelsInThisLayer** +== Return Value == 
-  ​* **Type**:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +  * Type:Void 
-  ​* **Description**:The labels will be drawn in the current layer only.+  * Description:​N/A
  
-**labelsInAllLayers** +== Parameters == 
-  * **Type**:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​ +<div newline></​div>​ 
-  ​* **Description**:​The labels will be drawn in all layers.+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ​**
  
-[[#​Protected Methods|Go Back]] +  * //N/A// 
-=== DrawSampleCore(GeoCanvas,​DrawingRectangleF) === +== Remarks == 
-N/A +  * //N/A//
-==== Remarks ​==== +
-N/A+
  
-**Return Value** +== Return Value == 
-  * **Return ​Type**:Void +  * Type:Object 
-  ​* **Description**:N/A+  * Description:​N/​A
  
-==== Parameters ​==== +== Parameters ​== 
-**canvas** +<div newline></​div>​ 
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] +==== Public Properties ​==== 
-  ​* **Description**:​N/​A+** {{wiki:PublicProperty.gif|}} RegexMatchingRule ​**
  
-**drawingExtent** +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. 
-  ​* **Type**:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] +== Remarks == 
-  * **Description**:​N/​A+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]]
  
-[[#​Protected Methods|Go Back]] +** {{wiki:​PublicProperty.gif|}} ColumnName **
-=== Finalize() === +
-N/A +
-==== Remarks ==== +
-N/A+
  
-**Return Value** +This property gets and sets the column name whose value will be tested against the regular expression. 
-  * **Return ​Type**:Void +== Remarks == 
-  * **Description**:N/A+This is the column we use for matching. 
 +== Return Value == 
 +  * Type:String
  
-==== Parameters ==== +** {{wiki:​PublicProperty.gif|}} RegexItems ** 
-[[#​Protected Methods|Go Back]] + 
-=== GetRequiredColumnNamesCore() === +This property gets the collection of RegexItems. Each item can have its own regular expression ​to match
-This method returns ​the column data for each feature that is required for the style to properly draw+== Remarks == 
-==== Remarks ​==== +You will want to add RegexItems to this collectionEach item can have its own style and matching string. 
-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 properlyFor example, if you have style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column nameThis will ensure that the column data is returned to you in the feature when it is ready to drawIn 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<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>​
  
-**Return Value** +** {{wiki:PublicProperty.gif|}} Name **
-  * **Return Type**:Collection<​String>​ +
-  ​* **Description**:​This method returns a collection of the column names that it needs.+
  
-==== Parameters ==== 
-[[#​Protected Methods|Go Back]] 
-=== MemberwiseClone() === 
 N/A N/A
-==== Remarks ​====+== Remarks ==
 N/A N/A
 +== Return Value ==
 +  * Type:String
  
-**Return Value** +** {{wiki:PublicProperty.gif|}} IsActive ​**
-  * **Return Type**:Object +
-  ​* **Description**:​N/​A+
  
-==== Parameters ==== 
-[[#​Protected Methods|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 
- 
-[[#Public Properties|Go Back]] 
-=== Filters === 
 N/A N/A
-==== Remarks ​====+== Remarks ==
 N/A N/A
-==== Return Value ==== +== Return Value == 
-**Return ​Type**:Collection<​String>​+  * Type:Boolean
  
-[[#Public Properties|Go Back]] +** {{wiki:​PublicProperty.gif|}} RequiredColumnNames ​**
-=== IsActive === +
-N/A +
-==== Remarks ==== +
-N/A +
-==== Return Value ==== +
-**Return Type**:Boolean+
  
-[[#Public Properties|Go Back]] 
-=== Name === 
 N/A N/A
-==== Remarks ​====+== Remarks ==
 N/A N/A
-==== Return Value ==== +== Return Value == 
-**Return ​Type**:String+  * Type:Collection<​String>
  
-[[#Public Properties|Go Back]] +** {{wiki:PublicProperty.gif|}} Filters ​**
-=== 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<​[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>​ +
- +
-[[#Public Properties|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**:​[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]]+
  
-[[#Public Properties|Go Back]] 
-=== RequiredColumnNames === 
 N/A N/A
-==== Remarks ​====+== Remarks ==
 N/A N/A
-==== Return Value ==== +== Return Value == 
-**Return ​Type**:​Collection<​String>​+  * Type:​Collection<​String>​ 
 + 
 +==== Protected Properties ==== 
 +** {{wiki:​ProtectedProperty.gif|}} FiltersCore **
  
-[[#Public Properties|Go Back]] 
-===== Protected Properties ===== 
-=== FiltersCore === 
 N/A N/A
-==== Remarks ​====+== Remarks ==
 N/A N/A
-==== Return Value ==== +== Return Value == 
-**Return ​Type**:​Collection<​String>​+  * Type:​Collection<​String>​
  
-[[#​Protected Properties|Go Back]] +==== Public Events ====
-===== Public Events ​=====+
  
thinkgeo.mapsuite.core.regexstyle.1442486308.txt.gz · Last modified: 2015/09/17 10:38 by admin