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]
@@ Line 1: / Line 1: @@
-====== ThinkGeo.MapSuite.Core.GeoLinearGradientBrush ======
-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.GeoLinearGradientBrush]]
-===== Members Summary =====
-==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
-| {{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 ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GeoLinearGradientBrush()|GeoLinearGradientBrush]]   |    |    | Create a new instance of the GeoLinearGradientBrush with default settings.   |
-==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
-| {{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 ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
-| {{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.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
-^ Name ^ Return ^ DeclaringType ^ Summary ^
-| {{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 ====
-^ Name ^ Return ^ DeclaringType ^ Summary ^
-==== Public Events ====
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
-===== Public Constructors =====
-==== GeoLinearGradientBrush(GeoColor, GeoColor, GeoLinearGradientDirection) ====
-Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction enum.
-=== 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]]
-==== 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.
-=== 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]]
-===== Protected Constructors =====
-==== GeoLinearGradientBrush() ====
-Create a new instance of the GeoLinearGradientBrush with default settings.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Protected Constructors|Go Back]]
-===== Public Methods =====
-==== 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]]  | A cloned GeoBrush.   |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Methods|Go Back]]
-==== Equals(Object) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean |    |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| obj   | Object |    |
-[[#Public Methods|Go Back]]
-==== GetHashCode() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32 |    |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-<!-- System.Object -->
-[[#Public Methods|Go Back]]
-==== GetType() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type |    |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Methods|Go Back]]
-==== ToString() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| String |    |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Methods|Go Back]]
-===== Protected Methods =====
-==== 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]]  | A cloned GeoBrush.   |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Protected Methods|Go Back]]
-==== Finalize() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void |    |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Protected Methods|Go Back]]
-==== MemberwiseClone() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object |    |
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Protected Methods|Go Back]]
-===== Public Properties =====
-==== DirectionAngle ====
-Gets or sets the Direction angle of the GeoLinearGradientBrush.
-=== Return Value ===
-^ Return Type ^
-| Single |
-[[#Public Properties|Go Back]]
-==== EndColor ====
-Gets or sets the ending GeoColor of the gradient.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]  |
-[[#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 |
-[[#Public Properties|Go Back]]
-==== StartColor ====
-Gets or sets the starting GeoColor of the gradient.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]   |
-[[#Public Properties|Go Back]]
-==== WrapMode ====
-Gets or sets a GeoWrapMode enumeration that indicates the wrap mode for the GeoLinearGradientBrush.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]]   |
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
-===== Public Events =====
-__NOTOC__
-[[Category:MapSuiteCore]]
-[[Category:ThinkGeo.MapSuite.Core]]
-[[Category:UpdateDocumentation]]

User Tools

Site Tools

Differences

Page Tools