This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.silverlightcore.regexitem [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.silverlightcore.regexitem [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.SilverlightCore.RegexItem ====== | ====== ThinkGeo.MapSuite.SilverlightCore.RegexItem ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | + | This class represents a single Regex Match statement and styles to draw. | |
| - | <!-- Class --> | + | |
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.SilverlightCore.RegexItem]] | + | ***ThinkGeo.MapSuite.SilverlightCore.RegexItem** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} RegexItem() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem()|RegexItem]] | | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, AreaStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.SilverlightCore.AreaStyle|AreaStyle]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, LineStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.SilverlightCore.LineStyle|LineStyle]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, PointStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.SilverlightCore.PointStyle|PointStyle]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, TextStyle)|RegexItem]] | String, [[ThinkGeo.MapSuite.SilverlightCore.TextStyle|TextStyle]] | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RegexItem(String, Collection<Style>)|RegexItem]] | String, Collection<[[ThinkGeo.MapSuite.SilverlightCore.Style|Style]]> | | | | + | |
| - | ==== Protected Constructors ==== | + | * //This is a constructor for the class.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //If you use this constructor, you should set the necessary properties manually.// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} 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// | ||
| + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.AreaStyle|AreaStyle]] | ||
| + | * Description:This parameter is the style you want to draw with if the regular expression matches. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RegexItem(String,LineStyle) ** | ||
| + | |||
| + | * //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 DefaultLineStyle.// | ||
| + | == Parameters == | ||
| + | * //regularExpression// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the regular expression statement you would like to match. | ||
| + | |||
| + | * //lineStyle// | ||
| + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.LineStyle|LineStyle]] | ||
| + | * Description:This parameter is the style you want to draw with if the regular expression matches. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RegexItem(String,PointStyle) ** | ||
| + | |||
| + | * //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 DefaultPointStyle.// | ||
| + | == Parameters == | ||
| + | * //regularExpression// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the regular expression statement you would like to match. | ||
| + | |||
| + | * //pointStyle// | ||
| + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointStyle|PointStyle]] | ||
| + | * Description:This parameter is the style you want to draw with if the regular expression matches. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RegexItem(String,TextStyle) ** | ||
| + | |||
| + | * //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 DefaultTextStyle.// | ||
| + | == Parameters == | ||
| + | * //regularExpression// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the regular expression statement you would like to match. | ||
| + | |||
| + | * //textStyle// | ||
| + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.TextStyle|TextStyle]] | ||
| + | * Description:This parameter is the style you want to draw with if the regular expression matches. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RegexItem(String,Collection<Style>) ** | ||
| + | |||
| + | * //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 CustomStyles.// | ||
| + | == Parameters == | ||
| + | * //regularExpression// | ||
| + | * Type:String | ||
| + | * Description:This parameter is the regular expression statement you would like to match. | ||
| + | |||
| + | * //styles// | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.SilverlightCore.Style|Style]]> | ||
| + | * Description:This parameter represents the styles you want to draw with if the regular expression matches. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | | {{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 ==== | + | * //N/A// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomStyles|CustomStyles]] | Collection<[[ThinkGeo.MapSuite.SilverlightCore.Style|Style]]> | | | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultAreaStyle|DefaultAreaStyle]] | [[ThinkGeo.MapSuite.SilverlightCore.AreaStyle|AreaStyle]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultLineStyle|DefaultLineStyle]] | [[ThinkGeo.MapSuite.SilverlightCore.LineStyle|LineStyle]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultPointStyle|DefaultPointStyle]] | [[ThinkGeo.MapSuite.SilverlightCore.PointStyle|PointStyle]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultTextStyle|DefaultTextStyle]] | [[ThinkGeo.MapSuite.SilverlightCore.TextStyle|TextStyle]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RegularExpression|RegularExpression]] | String | | | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ==== RegexItem() ==== | + | * Type:Boolean |
| - | === Parameters === | + | * Description:N/A |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== RegexItem(String, AreaStyle) ==== | + | * //obj// |
| - | === Parameters === | + | * Type:Object |
| - | ^ Name ^ Type ^ Description ^ | + | * Description:N/A |
| - | | regularExpression | String<!-- System.String --> | | | + | |
| - | | areaStyle | [[ThinkGeo.MapSuite.SilverlightCore.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.AreaStyle --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ==== RegexItem(String, LineStyle) ==== | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | regularExpression | String<!-- System.String --> | | | + | |
| - | | lineStyle | [[ThinkGeo.MapSuite.SilverlightCore.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.LineStyle --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ==== RegexItem(String, PointStyle) ==== | + | == Remarks == |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | regularExpression | String<!-- System.String --> | | | + | |
| - | | pointStyle | [[ThinkGeo.MapSuite.SilverlightCore.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.PointStyle --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ==== RegexItem(String, TextStyle) ==== | + | * Type:Int32 |
| - | === Parameters === | + | * Description:N/A |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | regularExpression | String<!-- System.String --> | | | + | |
| - | | textStyle | [[ThinkGeo.MapSuite.SilverlightCore.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.TextStyle --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ==== RegexItem(String, Collection<Style>) ==== | + | <div newline></div> |
| - | === Parameters === | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | regularExpression | String<!-- System.String --> | | | + | |
| - | | styles | Collection<[[ThinkGeo.MapSuite.SilverlightCore.Style|Style]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.SilverlightCore.Style} --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ===== Protected Constructors ===== | + | == Remarks == |
| - | ===== Public Methods ===== | + | * //N/A// |
| - | ==== Equals(Object) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:N/A |
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== GetHashCode() ==== | + | ==== Protected Methods ==== |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== GetType() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== ToString() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ===== Protected Methods ===== | + | ==== Public Properties ==== |
| - | ==== Finalize() ==== | + | ** {{wiki:PublicProperty.gif|}} RegularExpression ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | This property gets and sets the regular expression text used for matching. |
| - | ^ Name ^ Type ^ Description ^ | + | == 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 == | ||
| + | * Type:String | ||
| - | <!-- System.Object --> | + | ** {{wiki:PublicProperty.gif|}} CustomStyles ** |
| - | [[#Protected Methods|Go Back]] | + | |
| - | ==== MemberwiseClone() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | This property gets the collection of custom styles. |
| - | ^ Name ^ Type ^ Description ^ | + | == 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 == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.SilverlightCore.Style|Style]]> | ||
| - | <!-- System.Object --> | + | ** {{wiki:PublicProperty.gif|}} DefaultAreaStyle ** |
| - | [[#Protected Methods|Go Back]] | + | |
| - | ===== Public Properties ===== | + | |
| - | ==== CustomStyles ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.SilverlightCore.Style|Style]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.SilverlightCore.Style} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.SilverlightCore.RegexItem --> | + | This property gets and sets the default AreaStyle. You should use this style if your features are area-based. |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== DefaultAreaStyle ==== | + | 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 ^ | + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.AreaStyle|AreaStyle]] |
| - | | [[ThinkGeo.MapSuite.SilverlightCore.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.AreaStyle --> | | + | |
| - | <!-- ThinkGeo.MapSuite.SilverlightCore.RegexItem --> | + | ** {{wiki:PublicProperty.gif|}} DefaultLineStyle ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== DefaultLineStyle ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.SilverlightCore.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.LineStyle --> | | + | |
| - | <!-- ThinkGeo.MapSuite.SilverlightCore.RegexItem --> | + | This property gets and sets the default LineStyle. You should use this style if your features are line-based. |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== DefaultPointStyle ==== | + | 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 ^ | + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.LineStyle|LineStyle]] |
| - | | [[ThinkGeo.MapSuite.SilverlightCore.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.PointStyle --> | | + | |
| - | <!-- ThinkGeo.MapSuite.SilverlightCore.RegexItem --> | + | ** {{wiki:PublicProperty.gif|}} DefaultPointStyle ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== DefaultTextStyle ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.SilverlightCore.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.SilverlightCore.TextStyle --> | | + | |
| - | <!-- ThinkGeo.MapSuite.SilverlightCore.RegexItem --> | + | This property gets and sets the default PointStyle. You should use this style if your features are point-based. |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== RegularExpression ==== | + | 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 ^ | + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointStyle|PointStyle]] |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.SilverlightCore.RegexItem --> | + | ** {{wiki:PublicProperty.gif|}} DefaultTextStyle ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | This property gets and sets the default TextStyle. You should use this style if your features are text-based (such as labels). |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | 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. |
| - | [[Category:SilverlightMapSuiteCore]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.SilverlightCore]] | + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.TextStyle|TextStyle]] |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||