thinkgeo.mapsuite.core.regexitem
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.regexitem [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.RegexItem ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents a single Regex Match statement and styles to draw. | ||
| - | === Remarks === | ||
| - | The RegexItem represents a single matching criteria for a RegexStyle. | ||
| - | |||
| - | RegexStyle: | ||
| - | |||
| - | The RegexStyle allows you to use complex regular expression matching to determine how your features are drawn. A regular expression is a matching syntax that allows you to match a string based on very complex criteria. For example, let's say you have a layer that has a column in the data that contains school names. Most school names include the type of school they are. For instance, you may have "Lincoln Middle School" or "Bush High School." There are variations to these names though, containing words such as "Elementary" or "Prep." With a regular expression, you can create matching criteria that will allow you to match on many variations of the names. It is especially useful for fuzzy matches where your data is not clearly categorized. Another classic example is for matching or validating email addresses, where matching rules can become complex. | ||
| - | |||
| - | In the RegexStyle, you specify the matching criteria string and also the style you want to use to draw the feature if the criteria matches. It is a simple yet powerful style for dealing with complex rule sets and imprecise data. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Core.RegexItem]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem()|RegexItem]] | | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, AreaStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, LineStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, PointStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, TextStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | | This is a constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, Collection<Style>)|RegexItem]] | String, Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> | | This is a constructor for the class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomStyles|CustomStyles]] | Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]> | | This property gets the collection of custom styles. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultAreaStyle|DefaultAreaStyle]] | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]] | | This property gets and sets the default AreaStyle. You should use this style if your features are area-based. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultLineStyle|DefaultLineStyle]] | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] | | This property gets and sets the default LineStyle. You should use this style if your features are line-based. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultPointStyle|DefaultPointStyle]] | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]] | | This property gets and sets the default PointStyle. You should use this style if your features are point-based. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultTextStyle|DefaultTextStyle]] | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]] | | This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels). | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RegularExpression|RegularExpression]] | String | | This property gets and sets the regular expression text used for matching. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== RegexItem() ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | If you use this constructor, you should set the necessary properties manually. | ||
| - | === Remarks === | ||
| - | If you use this constructor, you should set the necessary properties manually. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RegexItem(String, AreaStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify an AreaStyle you want to use. You should use this if the features you are drawing are area-based. Alternatively, you can set the properties of the DefaultAreaStyle directly on 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | regularExpression | String<!-- System.String --> | This parameter is the regular expression statement you would like to match. | | ||
| - | | areaStyle | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle --> | This parameter is the style you want to draw with if the regular expression matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RegexItem(String, LineStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a LineStyle you want to use. You should use this if the features you are drawing are line-based. Alternatively, you can set the properties of the DefaultLineStyle directly on 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 DefaultLineStyle. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | regularExpression | String<!-- System.String --> | This parameter is the regular expression statement you would like to match. | | ||
| - | | lineStyle | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.Core.LineStyle --> | This parameter is the style you want to draw with if the regular expression matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RegexItem(String, PointStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a PointStyle you want to use. You should use this if the features you are drawing are point-based. Alternatively, you can set the properties of the DefaultPointStyle directly on 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 DefaultPointStyle. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | regularExpression | String<!-- System.String --> | This parameter is the regular expression statement you would like to match. | | ||
| - | | pointStyle | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.Core.PointStyle --> | This parameter is the style you want to draw with if the regular expression matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RegexItem(String, TextStyle) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify a TextStyle you want to use. You should use this if the features you are drawing are text-based. Alternatively, you can set the properties of the DefaultTextStyle directly on 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 DefaultTextStyle. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | regularExpression | String<!-- System.String --> | This parameter is the regular expression statement you would like to match. | | ||
| - | | textStyle | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.Core.TextStyle --> | This parameter is the style you want to draw with if the regular expression matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RegexItem(String, Collection<Style>) ==== | ||
| - | This is a constructor for the class. | ||
| - | === Overloads === | ||
| - | This constructor allows you to specify the TextStyles you want to use. You should use this if the features you are drawing are text-based. Alternatively, you can set the properties of the CustomStyles directly on 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 CustomStyles. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | regularExpression | String<!-- System.String --> | This parameter is the regular expression statement you would like to match. | | ||
| - | | styles | Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Style} --> | This parameter represents the styles you want to draw with if the regular expression matches. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== CustomStyles ==== | ||
| - | This property gets the collection of custom styles. | ||
| - | === 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 Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Style} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.RegexItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.RegexItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.Core.LineStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.RegexItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.Core.PointStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.RegexItem --> | ||
| - | [[#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 === | ||
| - | 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.Core.TextStyle --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.RegexItem --> | ||
| - | [[#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<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Core.RegexItem --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.regexitem.1440040129.txt.gz ยท Last modified: 2015/09/17 10:38 (external edit)
