Differences

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

--- thinkgeo.mapsuite.core.regexitem [2015/09/17 10:38]
admin
+++ thinkgeo.mapsuite.core.regexitem [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.RegexItem ======
+{{section>upgrade_map_suite_to_10.0}}
 This class represents a single Regex Match statement and styles to draw.
 ===== Inheritance Hierarchy =====
@@ Line 5: / Line 8: @@
     ***ThinkGeo.MapSuite.Core.RegexItem**
 ===== Members Summary =====
-=== Public Constructors ===
+==== Public Constructors ====
-<div class_table>
+** {{wiki:PublicMethod.gif|}} RegexItem() **
-**{{wiki:PublicMethod.gif|}}[[#RegexItem()|RegexItem]]**
-  * **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|}}[[#RegexItem(String,AreaStyle)|RegexItem]]**
+== Remarks ==
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+  * //If you use this constructor, you should set the necessary properties manually.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is a constructor for the class.
+<div newline></div>
-</div>
+** {{wiki:PublicMethod.gif|}} RegexItem(String,AreaStyle) **
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#RegexItem(String,LineStyle)|RegexItem]]**
+== Remarks ==
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+  * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultAreaStyle.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is a constructor for the class.
+  * //regularExpression//
-</div>
+    * Type:String
+    * Description:This parameter is the regular expression statement you would like to match.
-<div class_table>
+  * //areaStyle//
-**{{wiki:PublicMethod.gif|}}[[#RegexItem(String,PointStyle)|RegexItem]]**
+    * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+    * Description:This parameter is the style you want to draw with if the regular expression matches.
-  * **DeclaringType**:N/A
-  * **Summary**:This is a constructor for the class.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#RegexItem(String,TextStyle)|RegexItem]]**
+** {{wiki:PublicMethod.gif|}} RegexItem(String,LineStyle) **
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-  * **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|}}[[#RegexItem(String,Collection<Style>)|RegexItem]]**
+== Remarks ==
-  * **Parameters**:String,Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+  * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultLineStyle.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is a constructor for the class.
+  * //regularExpression//
-</div>
+    * Type:String
+    * Description:This parameter is the regular expression statement you would like to match.
-=== Protected Constructors ===
+  * //lineStyle//
-=== Public Methods ===
+    * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
-<div class_table>
+    * Description:This parameter is the style you want to draw with if the regular expression matches.
-**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
-  * **Parameters**:Object
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
+** {{wiki:PublicMethod.gif|}} RegexItem(String,PointStyle) **
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultPointStyle.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //regularExpression//
-</div>
+    * Type:String
+    * Description:This parameter is the regular expression statement you would like to match.
-<div class_table>
+  * //pointStyle//
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
+    * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
-  * **Parameters**:N/A
+    * Description:This parameter is the style you want to draw with if the regular expression matches.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-=== Protected Methods ===
+<div newline></div>
-<div class_table>
+** {{wiki:PublicMethod.gif|}} RegexItem(String,TextStyle) **
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This is a constructor for the class.//
-**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultTextStyle.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //regularExpression//
-</div>
+    * Type:String
+    * Description:This parameter is the regular expression statement you would like to match.
-=== Public Properties ===
+  * //textStyle//
-**{{wiki:PublicProperty.gif|}}[[#CustomStyles|CustomStyles]]**
+    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-  * **Return**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+    * Description:This parameter is the style you want to draw with if the regular expression matches.
-  * **Summary**:This property gets the collection of custom styles.
-**{{wiki:PublicProperty.gif|}}[[#DefaultAreaStyle|DefaultAreaStyle]]**
+<div newline></div>
-  * **Return**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+** {{wiki:PublicMethod.gif|}} RegexItem(String,Collection<Style>) **
-  * **Summary**:This property gets and sets the default AreaStyle. You should use this style if your features are area-based.
-**{{wiki:PublicProperty.gif|}}[[#DefaultLineStyle|DefaultLineStyle]]**
+  * //This is a constructor for the class.//
-  * **Return**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+== Remarks ==
-  * **Summary**:This property gets and sets the default LineStyle. You should use this style if your features are line-based.
+  * //It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the CustomStyles.//
+== Parameters ==
+  * //regularExpression//
+    * Type:String
+    * Description:This parameter is the regular expression statement you would like to match.
-**{{wiki:PublicProperty.gif|}}[[#DefaultPointStyle|DefaultPointStyle]]**
+  * //styles//
-  * **Return**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-  * **Summary**:This property gets and sets the default PointStyle. You should use this style if your features are point-based.
+    * Description:This parameter represents the styles you want to draw with if the regular expression matches.
-**{{wiki:PublicProperty.gif|}}[[#DefaultTextStyle|DefaultTextStyle]]**
+<div newline></div>
-  * **Return**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+==== Protected Constructors ====
-  * **Summary**:This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels).
+==== Public Methods ====
+** {{wiki:PublicMethod.gif|}} ToString() **
-**{{wiki:PublicProperty.gif|}}[[#RegularExpression|RegularExpression]]**
+  * //N/A//
-  * **Return**:String
+== Remarks ==
-  * **Summary**:This property gets and sets the regular expression text used for matching.
+  * //N/A//
-=== Protected Properties ===
+== Return Value ==
-=== Public Events ===
+  * Type:String
-===== Public Constructors =====
+  * Description:N/A
-=== RegexItem() ===
-This is a constructor for the class.
-==== Remarks ====
-If you use this constructor, you should set the necessary properties manually.
-==== Parameters ====
-[[#Public Constructors|Go Back]]
-=== RegexItem(String,AreaStyle) ===
-This is a constructor for the class.
-==== Remarks ====
-It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultAreaStyle.
-==== Parameters ====
-**regularExpression**
-  * **Type**:String
-  * **Description:This parameter is the regular expression statement you would like to match.
-**areaStyle**
+== Parameters ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+<div newline></div>
-  * **Description:This parameter is the style you want to draw with if the regular expression matches.
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-[[#Public Constructors|Go Back]]
+  * //N/A//
-=== RegexItem(String,LineStyle) ===
+== Remarks ==
-This is a constructor for the class.
+  * //N/A//
-==== Remarks ====
-It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultLineStyle.
-==== Parameters ====
-**regularExpression**
-  * **Type**:String
-  * **Description:This parameter is the regular expression statement you would like to match.
-**lineStyle**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+  * Type:Boolean
-  * **Description:This parameter is the style you want to draw with if the regular expression matches.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== RegexItem(String,PointStyle) ===
+  * //obj//
-This is a constructor for the class.
+    * Type:Object
-==== Remarks ====
+    * Description:N/A
-It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultPointStyle.
-==== Parameters ====
-**regularExpression**
-  * **Type**:String
-  * **Description:This parameter is the regular expression statement you would like to match.
-**pointStyle**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-  * **Description:This parameter is the style you want to draw with if the regular expression matches.
-[[#Public Constructors|Go Back]]
+  * //N/A//
-=== RegexItem(String,TextStyle) ===
+== Remarks ==
-This is a constructor for the class.
+  * //N/A//
-==== Remarks ====
-It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the DefaultTextStyle.
-==== Parameters ====
-**regularExpression**
-  * **Type**:String
-  * **Description:This parameter is the regular expression statement you would like to match.
-**textStyle**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * Type:Int32
-  * **Description:This parameter is the style you want to draw with if the regular expression matches.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== RegexItem(String,Collection<Style>) ===
+<div newline></div>
-This is a constructor for the class.
+** {{wiki:PublicMethod.gif|}} GetType() **
-==== Remarks ====
-It is recommended that you do not use this constructor unless it is absolutely necessary. Instead, you can set the properties directly on the CustomStyles.
-==== Parameters ====
-**regularExpression**
-  * **Type**:String
-  * **Description:This parameter is the regular expression statement you would like to match.
-**styles**
+  * //N/A//
-  * **Type**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+== Remarks ==
-  * **Description:This parameter represents the styles you want to draw with if the regular expression matches.
+  * //N/A//
-[[#Public Constructors|Go Back]]
+== Return Value ==
-===== Protected Constructors =====
+  * Type:Type
-===== Public Methods =====
+  * Description:N/A
-=== Equals(Object) ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Boolean
+<div newline></div>
-  * **Description**:N/A
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-==== Parameters ====
+  * //N/A//
-**obj**
+== Remarks ==
-  * **Type**:Object
+  * //N/A//
-  * **Description**:N/A
-[[#Public Methods|Go Back]]
+== Return Value ==
-=== GetHashCode() ===
+  * Type:Void
-N/A
+  * Description:N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Int32
+<div newline></div>
-  * **Description**:N/A
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-==== Parameters ====
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-=== GetType() ===
+  * //N/A//
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:Type
+  * Type:Object
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== ToString() ===
+==== Public Properties ====
-N/A
+** {{wiki:PublicProperty.gif|}} RegularExpression **
-==== Remarks ====
-N/A
-**Return Value**
+This property gets and sets the regular expression text used for matching.
-  * **Return Type**:String
+== Remarks ==
-  * **Description**:N/A
+This should be a valid regular expression string. Formatting regular expression strings is outside the scope of this documentation; however, there are many useful resources on the web for learning about regular expressions.
+== Return Value ==
-==== Parameters ====
+  * Type:String
-[[#Public Methods|Go Back]]
-===== Protected Methods =====
-=== Finalize() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
-  * **Return Type**:Void
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-=== MemberwiseClone() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+** {{wiki:PublicProperty.gif|}} CustomStyles **
-  * **Return Type**:Object
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-===== Public Properties =====
-=== CustomStyles ===
 This property gets the collection of custom styles.
-==== Remarks ====
+== Remarks ==
 The custom styles allow you to use styles other than the default style properties of the class. In this way, you can use a DotDensityStyle or any other style in the API.
-==== Return Value ====
+== Return Value ==
-**Return Type**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+** {{wiki:PublicProperty.gif|}} DefaultAreaStyle **
-[[#Public Properties|Go Back]]
-=== DefaultAreaStyle ===
 This property gets and sets the default AreaStyle. You should use this style if your features are area-based.
-==== Remarks ====
+== Remarks ==
 The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultLineStyle **
-[[#Public Properties|Go Back]]
-=== DefaultLineStyle ===
 This property gets and sets the default LineStyle. You should use this style if your features are line-based.
-==== Remarks ====
+== Remarks ==
 The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultPointStyle **
-[[#Public Properties|Go Back]]
-=== DefaultPointStyle ===
 This property gets and sets the default PointStyle. You should use this style if your features are point-based.
-==== Remarks ====
+== Remarks ==
 The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultTextStyle **
-[[#Public Properties|Go Back]]
-=== DefaultTextStyle ===
 This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels).
-==== Remarks ====
+== Remarks ==
 The default style allows you to directly set properties on the styles without having to create a new style each time. You can start simply by setting properties like color, etc. This makes modifying styles very easy.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-[[#Public Properties|Go Back]]
-=== RegularExpression ===
-This property gets and sets the regular expression text used for matching.
-==== Remarks ====
-This should be a valid regular expression string. Formatting regular expression strings is outside the scope of this documentation; however, there are many useful resources on the web for learning about regular expressions.
-==== Return Value ====
-**Return Type**:String
-[[#Public Properties|Go Back]]
+==== Protected Properties ====
-===== Protected Properties =====
+==== Public Events ====
-===== Public Events =====

User Tools

Site Tools

Differences

Page Tools