Differences

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

--- thinkgeo.mapsuite.core.geolineargradientbrush [2015/08/31 05:21]
admin [CloneDeep()]
+++ thinkgeo.mapsuite.core.geolineargradientbrush [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.GeoLinearGradientBrush ======
+{{section>upgrade_map_suite_to_10.0}}
 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 =====
   *System.Object
-    *[[ThinkGeo.MapSuite.Core.GeoBrush]]
+    *ThinkGeo.MapSuite.Core.GeoBrush
-      *[[ThinkGeo.MapSuite.Core.GeoLinearGradientBrush]]
+      ***ThinkGeo.MapSuite.Core.GeoLinearGradientBrush**
 ===== Members Summary =====
 ==== 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.   |
-==== Protected Constructors ====
+  * //Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction enum.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GeoLinearGradientBrush()|GeoLinearGradientBrush]]   |    |    | Create a new instance of the GeoLinearGradientBrush with default settings.   |
+  * //N/A//
+== Parameters ==
+  * //startColor//
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.
-==== Public Methods ====
+  * //endColor//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]]   |    | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]   | Create a copy of GeoBrush using the deep clone process.   |
+    * Description:This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.
-| {{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 ====
+  * //direction//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+    * Type:[[ThinkGeo.MapSuite.Core.GeoLinearGradientDirection|GeoLinearGradientDirection]]
-| {{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.   |
+    * Description:This parameter specifies the GeoLinearGradientDirection enumeration of the GeoLinearGradientBrush.
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+<div newline></div>
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} GeoLinearGradientBrush(GeoColor,GeoColor,Single) **
-| {{wiki:PublicProperty.gif|Public Property}}[[#DirectionAngle|DirectionAngle]]   | Single   |    | Gets or sets the Direction angle of the GeoLinearGradientBrush.   |
-| {{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 ====
+  * //Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction angle.//
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //N/A//
+== Parameters ==
+  * //startColor//
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.
-==== Public Events ====
+  * //endColor//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.
-===== Public Constructors =====
+  * //directionAngle//
-==== GeoLinearGradientBrush(GeoColor, GeoColor, GeoLinearGradientDirection) ====
+    * Type:Single
-Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction enum.
+    * Description:This parameter specifies the direction angle value of the GeoLinearGradientBrush.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| startColor   | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]   | This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.   |
-| endColor   | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]  | This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.   |
-| direction   | [[ThinkGeo.MapSuite.Core.GeoLinearGradientDirection|GeoLinearGradientDirection]]   | This parameter specifies the GeoLinearGradientDirection enumeration of the GeoLinearGradientBrush.   |
-[[#Public Constructors|Go Back]]
+<div newline></div>
-==== GeoLinearGradientBrush(GeoColor, GeoColor, Single) ====
+==== Protected Constructors ====
-Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction angle.
+** {{wiki:ProtectedMethod.gif|}} GeoLinearGradientBrush() **
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| startColor   | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]   | This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.   |
-| endColor   | [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]  | This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.   |
-| directionAngle   | Single  | This parameter specifies the direction angle value of the GeoLinearGradientBrush.   |
-[[#Public Constructors|Go Back]]
+  * //Create a new instance of the GeoLinearGradientBrush with default settings.//
-===== Protected Constructors =====
+== Remarks ==
-==== GeoLinearGradientBrush() ====
+  * //N/A//
-Create a new instance of the GeoLinearGradientBrush with default settings.
+== Parameters ==
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+==== Public Methods ====
+** {{wiki:PublicMethod.gif|}} CloneDeep() **
-[[#Protected Constructors|Go Back]]
+  * //N/A//
-===== Public Methods =====
+== Remarks ==
-==== CloneDeep() ====
+  * //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]]  | A cloned GeoBrush.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
+  * Description:N/A
-[[#Public Methods|Go Back]]
+== Parameters ==
-==== Equals(Object) ====
+<div newline></div>
-=== Return Value ===
+** {{wiki:PublicMethod.gif|}} ToString() **
-^ Return Type ^ Description ^
-| Boolean |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| obj   | Object |    |
+  * //N/A//
+== Return Value ==
+  * Type:String
+  * Description:N/A
-[[#Public Methods|Go Back]]
+== Parameters ==
-==== GetHashCode() ====
+<div newline></div>
-=== Return Value ===
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-^ Return Type ^ Description ^
-| Int32 |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Boolean
-==== GetType() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //obj//
+    * Type:Object
+    * Description:N/A
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-[[#Public Methods|Go Back]]
+  * //N/A//
-==== ToString() ====
+== Remarks ==
-=== Return Value ===
+  * //N/A//
-^ Return Type ^ Description ^
-| String |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
+  * Description:N/A
-[[#Public Methods|Go Back]]
+== Parameters ==
-===== Protected Methods =====
+<div newline></div>
-==== CloneDeepCore() ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-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]]  | A cloned GeoBrush.   |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Return Value ==
-==== Finalize() ====
+  * Type:Type
-=== Return Value ===
+  * Description:N/A
-^ Return Type ^ Description ^
-| Void |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Return Value ==
-==== MemberwiseClone() ====
+  * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
-=== Return Value ===
+  * Description:N/A
-^ Return Type ^ Description ^
-| Object |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-[[#Protected Methods|Go Back]]
+  * //N/A//
-===== Public Properties =====
+== Remarks ==
-==== DirectionAngle ====
+  * //N/A//
-Gets or sets the Direction angle of the GeoLinearGradientBrush.
-=== Return Value ===
-^ Return Type ^
-| Single |
-[[#Public Properties|Go Back]]
+== Return Value ==
-==== EndColor ====
+  * Type:Void
-Gets or sets the ending GeoColor of the gradient.
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]  |
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-[[#Public Properties|Go Back]]
+  * //N/A//
-==== Id ====
+== Remarks ==
-The id of the GeoBrush. This is always used as a key when in the cached brushes.
+  * //N/A//
-=== Return Value ===
-^ Return Type ^
-| Int64 |
+== Return Value ==
+  * Type:Object
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} StartColor **
-[[#Public Properties|Go Back]]
-==== StartColor ====
 Gets or sets the starting GeoColor of the gradient.
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+N/A
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]   |
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+** {{wiki:PublicProperty.gif|}} EndColor **
+Gets or sets the ending GeoColor of the gradient.
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+** {{wiki:PublicProperty.gif|}} DirectionAngle **
+Gets or sets the Direction angle of the GeoLinearGradientBrush.
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Single
+** {{wiki:PublicProperty.gif|}} WrapMode **
-[[#Public Properties|Go Back]]
-==== WrapMode ====
 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]]   |
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]]
+** {{wiki:PublicProperty.gif|}} Id **
-[[#Public Properties|Go Back]]
+N/A
-===== Protected Properties =====
+== Remarks ==
-===== Public Events =====
+N/A
-__NOTOC__
+== Return Value ==
-[[Category:MapSuiteCore]]
+  * Type:Int64
-[[Category:ThinkGeo.MapSuite.Core]]
-[[Category:UpdateDocumentation]]
+==== Protected Properties ====
+==== Public Events ====

User Tools

Site Tools

Differences

Page Tools