User Tools

Site Tools

Trace:
thinkgeo.mapsuite.core.geolineargradientbrush

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.core.geolineargradientbrush [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.core.geolineargradientbrush [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Core.GeoLinearGradientBrush ====== ====== ThinkGeo.MapSuite.Core.GeoLinearGradientBrush ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 Encapsulates a GeoBrush with a linear gradient. Encapsulates a GeoBrush with a linear gradient.
-=== Remarks === 
-This class encapsulates both two-color gradients and custom multicolor gradients. 
- 
-All linear gradients are defined along a line specified either by the width of a rectangle or by two points. 
- 
-By default, a two-color linear gradient is an even horizontal linear blend from the starting color to the ending color along the specified line. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.Core.GeoBrush]] +    *ThinkGeo.MapSuite.Core.GeoBrush 
-***[[ThinkGeo.MapSuite.Core.GeoLinearGradientBrush]]+      ***ThinkGeo.MapSuite.Core.GeoLinearGradientBrush**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} GeoLinearGradientBrush(GeoColor,​GeoColor,​GeoLinearGradientDirection) ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#GeoLinearGradientBrush(GeoColor,​ GeoColor, GeoLinearGradientDirection)|GeoLinearGradientBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],​ [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],​ [[ThinkGeo.MapSuite.Core.GeoLinearGradientDirection|GeoLinearGradientDirection]] ​  ​| ​   | Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction enum.   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoLinearGradientBrush(GeoColor,​ GeoColor, Single)|GeoLinearGradientBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],​ [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],​ Single ​  ​| ​   | Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction angle. ​  |+
  
 +  * //Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction enum.//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //​startColor//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
 +    * Description:​This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.
 +
 +  * //​endColor//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
 +    * Description:​This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.
 +
 +  * //​direction//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoLinearGradientDirection|GeoLinearGradientDirection]]
 +    * Description:​This parameter specifies the GeoLinearGradientDirection enumeration of the GeoLinearGradientBrush.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} GeoLinearGradientBrush(GeoColor,​GeoColor,​Single) **
 +
 +  * //Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction angle.//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +  * //​startColor//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
 +    * Description:​This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.
 +
 +  * //​endColor//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
 +    * Description:​This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.
 +
 +  * //​directionAngle//​
 +    * Type:Single
 +    * Description:​This parameter specifies the direction angle value of the GeoLinearGradientBrush.
 +
 +<div newline></​div>​
 ==== Protected Constructors ==== ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​ProtectedMethod.gif|}} GeoLinearGradientBrush() ​**
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#GeoLinearGradientBrush()|GeoLinearGradientBrush]] ​  ​| ​   |    | Create a new instance of the GeoLinearGradientBrush with default settings. ​  |+
  
 +  * //Create a new instance of the GeoLinearGradientBrush with default settings.//
 +== Remarks ==
 +  * //N/A//
 +== Parameters ==
 +<div newline></​div>​
 ==== 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}}[[#​DirectionAngle|DirectionAngle]] ​  | Single ​  ​| ​   | Gets or sets the Direction angle of the GeoLinearGradientBrush. ​  | +  * Description:N/A
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​EndColor|EndColor]] ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] ​  ​| ​   | Gets or sets the ending GeoColor of the gradient. ​  | +
-| {{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. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​StartColor|StartColor]] ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] ​  ​| ​   | Gets or sets the starting GeoColor of the gradient. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​WrapMode|WrapMode]] ​  | [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] ​  ​| ​   | Gets or sets a GeoWrapMode enumeration that indicates the wrap mode for the GeoLinearGradientBrush. ​  |+
  
-==== 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 == 
-==== GeoLinearGradientBrush(GeoColor,​ GeoColor, GeoLinearGradientDirection) ==== +  ​* Type:String 
-Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction enum. +  * Description:N/A
-=== Parameters === +
-^  Name ^  ​Type ​^  ​Description ​^ +
-| startColor ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<​!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  | This parameter specifies the starting GeoColor of the GeoLinearGradientBrush. ​  | +
-| endColor ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<​!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  | This parameter specifies the endding GeoColor of the GeoLinearGradientBrush. ​  | +
-| direction ​  | [[ThinkGeo.MapSuite.Core.GeoLinearGradientDirection|GeoLinearGradientDirection]]<​!-- ThinkGeo.MapSuite.Core.GeoLinearGradientDirection --> ​  | This parameter specifies the GeoLinearGradientDirection enumeration of the GeoLinearGradientBrush. ​  |+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== GeoLinearGradientBrush(GeoColor,​ GeoColor, Single) ==== +<div newline></div> 
-Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction angle. +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-=== Parameters ​=== +
-^  Name ^  Type ^  Description ^ +
-| startColor ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor -->   | This parameter specifies the starting GeoColor of the GeoLinearGradientBrush. ​  | +
-| endColor ​  | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor -->   | This parameter specifies the endding GeoColor of the GeoLinearGradientBrush. ​  | +
-| directionAngle ​  | Single<​!-- System.Single --> ​  | This parameter specifies the direction angle value of the GeoLinearGradientBrush. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-===== Protected Constructors ===== +== Remarks ​== 
-==== GeoLinearGradientBrush() ==== +  ​* //N/A//
-Create a new instance of the GeoLinearGradientBrush with default settings. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^+
  
-[[#​Protected Constructors|Go Back]] +== Return Value == 
-===== Public Methods ===== +  ​* ​Type:Boolean 
-==== CloneDeep() ==== +  * Description:N/A
-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 ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-<!-- ThinkGeo.MapSuite.Core.GeoBrush --> +<div newline></​div> 
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-==== Equals(Object) ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Int32 
-==== GetHashCode() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== GetType() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Type 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== ToString() ​==== +==== Protected Methods ​==== 
-=== Return Value === +** {{wiki:​ProtectedMethod.gif|}} CloneDeepCore() **
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] 
-===== Protected Methods ===== +  * Description:​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 === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-<!-- ThinkGeo.MapSuite.Core.GeoBrush --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-==== Finalize() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Void 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></​div>​ 
-==== MemberwiseClone() ​==== +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  * Type:​Object 
-===== Public Properties ===== +  * Description:​N/​A 
-==== DirectionAngle ​==== + 
-Gets or sets the Direction angle of the GeoLinearGradientBrush. +== Parameters ​== 
-=== Return Value === +<div newline></​div>​ 
-^ Return ​Type ^ +==== Public Properties ​==== 
-| Single<​!-- System.Single --> ​  |+** {{wiki:​PublicProperty.gif|}} StartColor ** 
 + 
 +Gets or sets the starting GeoColor ​of the gradient. 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  ​* ​Type:​[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] 
 + 
 +** {{wiki:​PublicProperty.gif|}} EndColor **
  
-<!-- ThinkGeo.MapSuite.Core.GeoLinearGradientBrush --> 
-[[#Public Properties|Go Back]] 
-==== EndColor ==== 
 Gets or sets the ending GeoColor of the gradient. Gets or sets the ending GeoColor of the gradient.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  
-<!-- ThinkGeo.MapSuite.Core.GeoLinearGradientBrush --> +** {{wiki:​PublicProperty.gif|}} DirectionAngle **
-[[#Public Properties|Go Back]] +
-==== Id ==== +
-The id of the GeoBrush. This is always used as a key when in the cached brushes. +
-=== Return Value === +
-^ Return Type ^ +
-| Int64<​!-- System.Int64 --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Core.GeoBrush --> +Gets or sets the Direction angle of the GeoLinearGradientBrush. 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== StartColor ==== +N/A 
-Gets or sets the starting GeoColor ​of the gradient. +== Return Value == 
-=== Return Value === +  ​* ​Type:Single 
-^ Return ​Type ^ + 
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]<​!-- ThinkGeo.MapSuite.Core.GeoColor --> ​  |+** {{wiki:​PublicProperty.gif|}} WrapMode **
  
-<!-- ThinkGeo.MapSuite.Core.GeoLinearGradientBrush --> 
-[[#Public Properties|Go Back]] 
-==== WrapMode ==== 
 Gets or sets a GeoWrapMode enumeration that indicates the wrap mode for the GeoLinearGradientBrush. Gets or sets a GeoWrapMode enumeration that indicates the wrap mode for the GeoLinearGradientBrush.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +N/A 
-| [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]]<!-- ThinkGeo.MapSuite.Core.GeoWrapMode --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]]
  
-<!-- ThinkGeo.MapSuite.Core.GeoLinearGradientBrush --> +** {{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.geolineargradientbrush.1440040128.txt.gz · Last modified: 2015/08/31 05:20 (external edit)

Page Tools