User Tools

Site Tools

Trace:
thinkgeo.mapsuite.core.geohatchbrush

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
thinkgeo.mapsuite.core.geohatchbrush [2015/08/31 03:58]
admin [ThinkGeo.MapSuite.Core.GeoHatchBrush] 		thinkgeo.mapsuite.core.geohatchbrush [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Core.GeoHatchBrush ====== ====== ThinkGeo.MapSuite.Core.GeoHatchBrush ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-This class represents a brush that fills with various patterns. 
-=== Remarks === 
 This class represents a brush that fills with various patterns. This class represents a brush that fills with various patterns.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.Core.GeoBrush]] +    *ThinkGeo.MapSuite.Core.GeoBrush 
-***[[ThinkGeo.MapSuite.Core.GeoHatchBrush]]+      ***ThinkGeo.MapSuite.Core.GeoHatchBrush**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} GeoHatchBrush(GeoHatchStyle,​GeoColor) ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#GeoHatchBrush(GeoHatchStyle,​ GeoColor)|GeoHatchBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]],​ [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] ​  ​| ​   | This is the constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoHatchBrush(GeoHatchStyle,​ GeoColor, GeoColor)|GeoHatchBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]],​ [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],​ [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] ​  ​| ​   | This is the constructor for the class. ​  |+
  
-==== Protected Constructors ​==== +  * //This is the constructor for the class.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //You will use this constructor when you want to only specify the foreground color of the pattern and leave the background transparent.//​ 
 +== Parameters ​== 
 +  * //​hatchStyle//​ 
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]] 
 +    * Description:​This property is the hatch pattern you want to use to fill the area.
  
 +  * //​foregroundColor//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
 +    * Description:​This property is the foreground color you want to use for the pattern.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} GeoHatchBrush(GeoHatchStyle,​GeoColor,​GeoColor) **
 +
 +  * //This is the constructor for the class.//
 +== Remarks ==
 +  * //This constructor allows you to choose both the background and foreground color for the pattern.//
 +== Parameters ==
 +  * //​hatchStyle//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]]
 +    * Description:​This property is the hatch pattern you want to use to fill the area.
 +
 +  * //​foregroundColor//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
 +    * Description:​This property is the foreground color you want to use for the pattern.
 +
 +  * //​backgroundColor//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
 +    * Description:​This property is the background color you want to use for the pattern.
 +
 +<div newline></​div>​
 +==== Protected Constructors ====
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} CloneDeep() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] ​  ​| ​   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] ​  | Create a copy of GeoBrush using the deep clone process. ​  | +
-| {{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}}[[#​CloneDeepCore()|CloneDeepCore]] ​  ​| ​   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] ​  | Create a copy of GeoBrush using the deep clone process. The default implementation uses serialization. ​  | +  * //N/A//
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] 
-| {{wiki:PublicProperty.gif|Public Property}}[[#​BackgroundColor|BackgroundColor]] ​  ​| ​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]   |    | This property gets and sets the background color for the fill pattern. ​  | +  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#​ForegroundColor|ForegroundColor]] ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] ​  ​| ​   | This property gets and sets the foreground color for the fill pattern. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​HatchStyle|HatchStyle]] ​  | [[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]] ​  ​| ​   | This property gets and sets the pattern you want to use for the fill.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Id|Id]] ​  | Int64   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] ​  | The id of the GeoBrush. This is always used as a key when in the cached brushes. ​  |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} ToString() **
  
-==== Public Events ==== +  * //N/A// 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //N/A//
  
-===== Public Constructors ===== +== Return Value == 
-==== GeoHatchBrush(GeoHatchStyle,​ GeoColor) ==== +  ​* Type:String 
-This is the constructor for the class. +  * Description:N/A
-=== Overloads === +
-This constructor allows you to provide a foreground color for the pattern fill. +
-=== Remarks === +
-You will use this constructor when you want to only specify the foreground color of the pattern and leave the background transparent. +
-=== Parameters === +
-^  Name ^  ​Type ​^  ​Description ​^ +
-| hatchStyle ​  | [[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]]<​!-- ThinkGeo.MapSuite.Core.GeoHatchStyle --> ​  | This property is the hatch pattern you want to use to fill the area.   | +
-| foregroundColor ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<​!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  | This property is the foreground color you want to use for the pattern. ​  |+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== GeoHatchBrush(GeoHatchStyle,​ GeoColor, GeoColor) ==== +<div newline></div> 
-This is the constructor for the class. +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-=== Overloads === +
-This constructor allows you to provide a foreground and background color for the pattern fill. +
-=== Remarks === +
-This constructor allows you to choose both the background and foreground color for the pattern. +
-=== Parameters ​=== +
-^  Name ^  Type ^  Description ^ +
-| hatchStyle ​  | [[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]]<!-- ThinkGeo.MapSuite.Core.GeoHatchStyle -->   | This property is the hatch pattern you want to use to fill the area.   | +
-| foregroundColor ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor -->   | This property is the foreground color you want to use for the pattern. ​  | +
-| backgroundColor ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<​!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  | This property is the background color you want to use for the pattern. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-===== Protected Constructors ===== +== Remarks == 
-===== Public Methods ===== +  * //N/A//
-==== CloneDeep() ==== +
-Create a copy of GeoBrush 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.GeoBrush|GeoBrush]]<​!-- ThinkGeo.MapSuite.Core.GeoBrush --> ​  ​| ​A cloned GeoBrush. ​  |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Boolean 
 +  * Description:N/A
  
-<!-- ThinkGeo.MapSuite.Core.GeoBrush --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  * //obj// 
-==== Equals(Object) ​==== +    ​* ​Type:Object 
-=== Return Value === +    ​* Description:​N/​A
-^ Return ​Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-| obj   | Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== GetHashCode() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Int32 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetType() ​==== +** {{wiki:​PublicMethod.gif|}} 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:Type 
-==== ToString() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Protected Methods ==== 
 +** {{wiki:​ProtectedMethod.gif|}} CloneDeepCore() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks == 
-===== Protected Methods ===== +  * //N/A//
-==== CloneDeepCore() ==== +
-Create a copy of GeoBrush using the deep clone process. The default implementation 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.GeoBrush|GeoBrush]]<​!-- ThinkGeo.MapSuite.Core.GeoBrush --> ​  ​| ​A cloned GeoBrush. ​  |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] 
 +  * Description:N/A
  
-<!-- ThinkGeo.MapSuite.Core.GeoBrush --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></​div>​ 
-==== Finalize() ​==== +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== MemberwiseClone() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-===== Public Properties ​===== +  * //N/A// 
-==== BackgroundColor ​==== + 
-This property gets and sets the background color for the fill pattern. +== Return Value == 
-=== Remarks ​=== +  * Type:​Object 
-In this case the foreground color will be transparent. +  * Description:​N/​A 
-=== Return Value === + 
-^ Return ​Type ^ +== Parameters == 
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  |+<div newline></​div>​ 
 +==== Public Properties ​==== 
 +** {{wiki:​PublicProperty.gif|}} HatchStyle ** 
 + 
 +This property gets and sets the pattern you want to use for the fill. 
 +== Remarks == 
 +None 
 +== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]] 
 + 
 +** {{wiki:​PublicProperty.gif|}} ForegroundColor **
  
-<!-- ThinkGeo.MapSuite.Core.GeoHatchBrush --> 
-[[#Public Properties|Go Back]] 
-==== ForegroundColor ==== 
 This property gets and sets the foreground color for the fill pattern. This property gets and sets the foreground color for the fill pattern.
-=== Remarks ​===+== Remarks ==
 In this case the background color will be transparent. In this case the background color will be transparent.
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.GeoHatchBrush --> +** {{wiki:​PublicProperty.gif|}} BackgroundColor **
-[[#Public Properties|Go Back]] +
-==== HatchStyle ==== +
-This property gets and sets the pattern you want to use for the fill. +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.Core.GeoHatchStyle|GeoHatchStyle]]<​!-- ThinkGeo.MapSuite.Core.GeoHatchStyle --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.GeoHatchBrush --> +This property gets and sets the background color for the fill pattern. 
-[[#Public Properties|Go Back]] +== Remarks ​== 
-==== Id ==== +In this case the foreground color will be transparent. 
-The id of the GeoBrush. This is always used as a key when in the cached brushes. +== Return Value == 
-=== Return Value === +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-^ Return ​Type ^ +
-| Int64<​!-- System.Int64 --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.GeoBrush --> +** {{wiki:​PublicProperty.gif|}} Id ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +N/A 
-===== Public Events ===== +== Remarks == 
-__NOTOC__ +N/A 
-[[Category:​MapSuiteCore]] +== Return Value == 
-[[Category:​ThinkGeo.MapSuite.Core]] +  * Type:​Int64 
-[[Category:​UpdateDocumentation]]+ 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.core.geohatchbrush.1440993491.txt.gz · Last modified: 2015/08/31 03:58 by admin

Page Tools