Differences

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

--- thinkgeo.mapsuite.core.regexstyle [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.core.regexstyle [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.RegexStyle ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- 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
+  *System.Object
-**[[ThinkGeo.MapSuite.Core.Style]]
+    *ThinkGeo.MapSuite.Core.Style
-***[[ThinkGeo.MapSuite.Core.RegexStyle]]
+      ***ThinkGeo.MapSuite.Core.RegexStyle**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} RegexStyle() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#RegexStyle()|RegexStyle]]   |    |    | This is a constructor for the class.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RegexStyle(String, Collection<RegexItem>)|RegexStyle]]   | String, Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>   |    | This is a constructor for the class.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RegexStyle(String, Collection<RegexItem>, RegexMatching)|RegexStyle]]   | String, Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>, [[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]]   |    | This is a constructor for the class.   |
-==== Protected Constructors ====
+  * //This is a constructor for the class.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== 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 ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} CloneDeep() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]]   |    | [[ThinkGeo.MapSuite.Core.Style|Style]]   | Create a copy of style using the deep clone process.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>   | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This method draws the features on the canvas you provided.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|Draw]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>   | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This method draws the shapes on the canvas you provided.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas)|DrawSample]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]   | [[ThinkGeo.MapSuite.Core.Style|Style]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#DrawSample(GeoCanvas, DrawingRectangleF)|DrawSample]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]   | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This method draws a sample feature on the canvas you provided.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetRequiredColumnNames()|GetRequiredColumnNames]]   |    | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This method returns the column data for each feature that is required for the style to properly draw.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Uri)|LoadStyle]]   | Uri   | [[ThinkGeo.MapSuite.Core.Style|Style]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadStyle(Stream)|LoadStyle]]   | Stream   | [[ThinkGeo.MapSuite.Core.Style|Style]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(String)|SaveStyle]]   | String   | [[ThinkGeo.MapSuite.Core.Style|Style]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#SaveStyle(Stream)|SaveStyle]]   | Stream   | [[ThinkGeo.MapSuite.Core.Style|Style]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //N/A//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]]   |    | [[ThinkGeo.MapSuite.Core.Style|Style]]   | Create a copy of style using the deep clone process. The default implementation method uses serialization.   |
+  * //N/A//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)|DrawCore]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>, [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>, Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>   | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden)   | This method draws the features on the canvas you provided.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawSampleCore(GeoCanvas, DrawingRectangleF)|DrawSampleCore]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]   | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This method draws a sample feature on the canvas you provided.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRequiredColumnNamesCore()|GetRequiredColumnNamesCore]]   |    | [[ThinkGeo.MapSuite.Core.Style|Style]](overriden)   | This method returns the column data for each feature that is required for the style to properly draw.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
-| {{wiki:PublicProperty.gif|Public Property}}[[#ColumnName|ColumnName]]   | String   |    | This property gets and sets the column name whose value will be tested against the regular expression.   |
+  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#Filters|Filters]]   | Collection<String>   | [[ThinkGeo.MapSuite.Core.Style|Style]]   |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsActive|IsActive]]   | Boolean   | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This property gets and sets the active status of the style.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This property gets and set the name of the style.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#RegexItems|RegexItems]]   | Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]>   |    | This property gets the collection of RegexItems. Each item can have its own regular expression to match.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#RegexMatchingRule|RegexMatchingRule]]   | [[ThinkGeo.MapSuite.Core.RegexMatching|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.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#RequiredColumnNames|RequiredColumnNames]]   | Collection<String>   | [[ThinkGeo.MapSuite.Core.Style|Style]]   | This property gets the collection of fields that are required for the style.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+<div newline></div>
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#FiltersCore|FiltersCore]]   | Collection<String>   | [[ThinkGeo.MapSuite.Core.Style|Style]]   |    |
+** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-==== Public Events ====
+  * //N/A//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //N/A//
-===== Public Constructors =====
+== Return Value ==
-==== RegexStyle() ====
+  * Type:Void
-This is a constructor for the class.
+  * Description:N/A
-=== 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 ^
-[[#Public Constructors|Go Back]]
+== Parameters ==
-==== RegexStyle(String, Collection<RegexItem>) ====
+  * //features//
-This is a constructor for the class.
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
-=== Overloads ===
+    * Description:N/A
-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<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.RegexItem} -->   | This parameter specifies the regexItems in the style.   |
-[[#Public Constructors|Go Back]]
+  * //canvas//
-==== RegexStyle(String, Collection<RegexItem>, RegexMatching) ====
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-This is a constructor for the class.
+    * Description:N/A
-=== 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<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.RegexItem} -->   | This parameter specifies the regexItems in the style.   |
-| regexMatching   | [[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]]<!-- ThinkGeo.MapSuite.Core.RegexMatching -->   | This parameter specifies the regexMatching rule for the style.   |
-[[#Public Constructors|Go Back]]
+  * //labelsInThisLayer//
-===== Protected Constructors =====
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-===== Public Methods =====
+    * Description:N/A
-==== CloneDeep() ====
-Create a copy of style using the deep clone process.
-=== Remarks ===
-The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style -->   | A cloned style.   |
-=== Parameters ===
+  * //labelsInAllLayers//
-^  Name ^  Type ^  Description ^
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Style -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-==== 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.
+  * //N/A//
-=== Return Value ===
+== Remarks ==
-^ Return Type ^ Description ^
+  * //N/A//
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
-| features   | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} -->   | This parameter represents the features you want to draw on the canvas.   |
+  * Description:N/A
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
-| labelsInThisLayer   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | The labels will be drawn in the current layer only.   |
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | The labels will be drawn in all layers.   |
-<!-- ThinkGeo.MapSuite.Core.Style -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //shapes//
-==== Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ====
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>
-This method draws the shapes on the canvas you provided.
+    * Description:N/A
-=== 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.
+  * //canvas//
-=== Return Value ===
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-^ Return Type ^ Description ^
+    * Description:N/A
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //labelsInThisLayer//
-^  Name ^  Type ^  Description ^
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-| shapes   | IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.BaseShape} -->   | This parameter represents the shapes you want to draw on the canvas.   |
+    * Description:N/A
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter represents the canvas you want to draw the shapes on.   |
-| labelsInThisLayer   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | The labels will be drawn in the current layer only.   |
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | The labels will be drawn in all layers.   |
-<!-- ThinkGeo.MapSuite.Core.Style -->
+  * //labelsInAllLayers//
-[[#Public Methods|Go Back]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-==== DrawSample(GeoCanvas) ====
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Style -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== DrawSample(GeoCanvas, DrawingRectangleF) ====
+  * //N/A//
-This method draws a sample feature on the canvas you provided.
-=== Remarks ===
-This method is the concrete wrapper for the abstract method DrawSampleCore. In this method we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area.
-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 Value ===
+  * Type:Collection<String>
-^ Return Type ^ Description ^
+  * Description:N/A
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
+** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) **
-| drawingExtent   | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Style -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== Equals(Object) ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
-| obj   | Object<!-- System.Object -->   |    |
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //canvas//
-==== GetHashCode() ====
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+  * //drawingExtent//
-^  Name ^  Type ^  Description ^
+    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
+    * Description:N/A
-<!-- System.Object -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) **
-==== 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.
+  * //N/A//
+== Remarks ==
+  * //N/A//
-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 Value ===
+  * Type:Void
-^ Return Type ^ Description ^
+  * Description:N/A
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   | This method returns a collection of column names that the style needs.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //canvas//
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Style -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} SaveStyle(String) **
-==== GetType() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-==== LoadStyle(Uri) ====
+  * Description:N/A
-<!-- static -->
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //filePathName//
-| styleUri   | Uri<!-- System.Uri -->   |    |
+    * Type:String
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Style -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) **
-==== LoadStyle(Stream) ====
-<!-- static -->
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| styleStream   | Stream<!-- System.IO.Stream -->   |    |
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Style -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-==== SaveStyle(String) ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //stream//
-| filePathName   | String<!-- System.String -->   |    |
+    * Type:Stream
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Style -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} ToString() **
-==== SaveStyle(Stream) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| stream   | Stream<!-- System.IO.Stream -->   |    |
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Style -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:String
-==== ToString() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-<!-- System.Object -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-===== Protected Methods =====
+  * //N/A//
-==== CloneDeepCore() ====
-Create a copy of style using the deep clone process. The default implementation method uses serialization.
-=== Remarks ===
-The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Style|Style]]<!-- ThinkGeo.MapSuite.Core.Style -->   | A cloned style.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Boolean
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Style -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //obj//
-==== DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>) ====
+    * Type:Object
-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.
+<div newline></div>
-=== Return Value ===
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| features   | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} -->   | This parameter represents the features you want to draw on the canvas.   |
+  * //N/A//
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
-| labelsInThisLayer   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | The labels will be drawn in the current layer only.   |
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | The labels will be drawn in all layers.   |
-<!-- ThinkGeo.MapSuite.Core.Style(overriden) -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Int32
-==== DrawSampleCore(GeoCanvas, DrawingRectangleF) ====
+  * Description:N/A
-This method draws a sample feature on the canvas you provided.
-=== Remarks ===
-This virtual method is called from the concrete public method Draw. In this method, we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area.
-When implementing this virtual method, consider the canvas size and draw the sample image appropriately. You should keep in mind that the sample typically shows up on a legend.
+== Parameters ==
-=== Return Value ===
+<div newline></div>
-^ Return Type ^ Description ^
+** {{wiki:PublicMethod.gif|}} GetType() **
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter represents the canvas you want to draw the features on.   |
+  * //N/A//
-| drawingExtent   | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]<!-- ThinkGeo.MapSuite.Core.DrawingRectangleF -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Style -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Type
-==== Finalize() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-<!-- System.Object -->
+  * //This method draws the features on the canvas you provided.//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== GetRequiredColumnNamesCore() ====
+  * //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.//
-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 Value ===
+  * Type:Void
-^ Return Type ^ Description ^
+  * Description:None
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   | This method returns a collection of the column names that it needs.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //features//
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
+    * Description:This parameter represents the features you want to draw on the canvas.
-<!-- ThinkGeo.MapSuite.Core.Style(overriden) -->
+  * //canvas//
-[[#Protected Methods|Go Back]]
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-==== MemberwiseClone() ====
+    * Description:This parameter represents the canvas you want to draw the features on.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+  * //labelsInThisLayer//
-^  Name ^  Type ^  Description ^
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
+    * Description:The labels will be drawn in the current layer only.
-<!-- System.Object -->
+  * //labelsInAllLayers//
-[[#Protected Methods|Go Back]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-===== Public Properties =====
+    * Description:The labels will be drawn in all layers.
-==== 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.Core.RegexStyle -->
+<div newline></div>
-[[#Public Properties|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() **
-==== Filters ====
-=== Return Value ===
-^ Return Type ^
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   |
-<!-- ThinkGeo.MapSuite.Core.Style -->
+  * //This method returns the column data for each feature that is required for the style to properly draw.//
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== IsActive ====
+  * //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.//
-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.Core.Style -->
+== Return Value ==
-[[#Public Properties|Go Back]]
+  * Type:Collection<String>
-==== Name ====
+  * Description:This method returns a collection of the column names that it needs.
-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.Core.Style -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+<div newline></div>
-==== RegexItems ====
+** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
-This property gets the collection of RegexItems. Each item can have its own regular expression to match.
-=== Remarks ===
+  * //N/A//
-You will want to add RegexItems to this collection. Each item can have its own style and matching string.
+== Remarks ==
-=== Return Value ===
+  * //N/A//
-^ Return Type ^
-| Collection<[[ThinkGeo.MapSuite.Core.RegexItem|RegexItem]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.RegexItem} -->   |
+== 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 **
-<!-- ThinkGeo.MapSuite.Core.RegexStyle -->
-[[#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 ===
+== 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 Value ==
-^ Return Type ^
+  * Type:[[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]]
-| [[ThinkGeo.MapSuite.Core.RegexMatching|RegexMatching]]<!-- ThinkGeo.MapSuite.Core.RegexMatching -->   |
-<!-- ThinkGeo.MapSuite.Core.RegexStyle -->
+** {{wiki:PublicProperty.gif|}} ColumnName **
-[[#Public Properties|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.Core.Style -->
+This property gets and sets the column name whose value will be tested against the regular expression.
-[[#Public Properties|Go Back]]
+== Remarks ==
-===== Protected Properties =====
+This is the column we use for matching.
-==== FiltersCore ====
+== Return Value ==
-=== Return Value ===
+  * Type:String
-^ Return Type ^
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   |
-<!-- ThinkGeo.MapSuite.Core.Style -->
+** {{wiki:PublicProperty.gif|}} RegexItems **
-[[#Protected Properties|Go Back]]
-===== Public Events =====
+This property gets the collection of RegexItems. Each item can have its own regular expression to match.
-__NOTOC__
+== Remarks ==
-[[Category:MapSuiteCore]]
+You will want to add RegexItems to this collection. Each item can have its own style and matching string.
-[[Category:ThinkGeo.MapSuite.Core]]
+== Return Value ==
-[[Category:UpdateDocumentation]]
+  * 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 ====

User Tools

Site Tools

Differences

Page Tools