thinkgeo.mapsuite.portablecore.geohatchbrush
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.geohatchbrush [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.geohatchbrush [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.GeoHatchBrush ====== | + | ====== ThinkGeo.MapSuite.Core.GeoHatchBrush ====== |
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| - | 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.PortableCore.GeoBrush]] | + | *ThinkGeo.MapSuite.Core.GeoBrush |
| - | ***[[ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoHatchStyle|GeoHatchStyle]], [[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]] | | This is the constructor for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GeoHatchBrush(GeoHatchStyle, GeoColor, GeoColor)|GeoHatchBrush]] | [[ThinkGeo.MapSuite.PortableCore.GeoHatchStyle|GeoHatchStyle]], [[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]], [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.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.PortableCore.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.PortableCore.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.PortableCore.GeoColor|GeoColor]] | | This property gets and sets the foreground color for the fill pattern. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HatchStyle|HatchStyle]] | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.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.PortableCore.GeoHatchStyle|GeoHatchStyle]]<!-- ThinkGeo.MapSuite.PortableCore.GeoHatchStyle --> | This property is the hatch pattern you want to use to fill the area. | | + | |
| - | | foregroundColor | [[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoHatchStyle|GeoHatchStyle]]<!-- ThinkGeo.MapSuite.PortableCore.GeoHatchStyle --> | This property is the hatch pattern you want to use to fill the area. | | + | |
| - | | foregroundColor | [[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.PortableCore.GeoColor --> | This property is the foreground color you want to use for the pattern. | | + | |
| - | | backgroundColor | [[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoBrush|GeoBrush]]<!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> | A cloned GeoBrush. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoBrush|GeoBrush]]<!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> | A cloned GeoBrush. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.PortableCore.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. | + | |
| - | === Remarks === | + | |
| - | In this case the foreground color will be transparent. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.PortableCore.GeoColor --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GeoHatchBrush --> | + | == Return Value == |
| - | [[#Public Properties|Go Back]] | + | * Type:Object |
| - | ==== ForegroundColor ==== | + | * Description:N/A |
| - | This property gets and sets the foreground color for the fill pattern. | + | |
| - | === Remarks === | + | |
| - | In this case the background color will be transparent. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.PortableCore.GeoColor --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GeoHatchBrush --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | <div newline></div> |
| - | ==== HatchStyle ==== | + | ==== Public Properties ==== |
| - | This property gets and sets the pattern you want to use for the fill. | + | ** {{wiki:PublicProperty.gif|}} HatchStyle ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.PortableCore.GeoHatchStyle|GeoHatchStyle]]<!-- ThinkGeo.MapSuite.PortableCore.GeoHatchStyle --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GeoHatchBrush --> | + | * //This property gets and sets the pattern you want to use for the fill.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== Id ==== | + | * //None// |
| - | 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.GeoHatchStyle|GeoHatchStyle]] |
| - | ^ Return Type ^ | + | |
| - | | Int64<!-- System.Int64 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> | + | ** {{wiki:PublicProperty.gif|}} ForegroundColor ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | * //This property gets and sets the foreground color for the fill pattern.// |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | * //In this case the background color will be transparent.// |
| - | [[Category:MapSuitePortableCore]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ** {{wiki:PublicProperty.gif|}} BackgroundColor ** | ||
| + | |||
| + | * //This property gets and sets the background color for the fill pattern.// | ||
| + | == Remarks == | ||
| + | * //In this case the foreground color will be transparent.// | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Id ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Int64 | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.portablecore.geohatchbrush.1440040132.txt.gz · Last modified: 2015/09/21 08:08 (external edit)