User Tools

Site Tools


thinkgeo.mapsuite.core.geolineargradientbrush

This is an old revision of the document!


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

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodGeoLinearGradientBrush GeoColor, GeoColor, GeoLinearGradientDirection Create an instance of GeoLinearGradientBrush by passing a gradient start color and gradient end color followed by the gradient direction enum.
Public MethodGeoLinearGradientBrush 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
Protected MethodGeoLinearGradientBrush Create a new instance of the GeoLinearGradientBrush with default settings.

Public Methods

Name Parameters DeclaringType Summary
Public MethodCloneDeep GeoBrush Create a copy of GeoBrush using the deep clone process.
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloneDeepCore GeoBrush Create a copy of GeoBrush using the deep clone process. The default implementation uses serialization.
Protected MethodFinalize Object
Protected MethodMemberwiseClone Object

Public Properties

Name Return DeclaringType Summary
Public PropertyDirectionAngle Single Gets or sets the Direction angle of the GeoLinearGradientBrush.
Public PropertyEndColor GeoColor Gets or sets the ending GeoColor of the gradient.
Public PropertyId Int64 GeoBrush The id of the GeoBrush. This is always used as a key when in the cached brushes.
Public PropertyStartColor GeoColor Gets or sets the starting GeoColor of the gradient.
Public PropertyWrapMode 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 GeoColor This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.
endColor GeoColor This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.
direction GeoLinearGradientDirection This parameter specifies the GeoLinearGradientDirection enumeration of the GeoLinearGradientBrush.

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 GeoColor This parameter specifies the starting GeoColor of the GeoLinearGradientBrush.
endColor GeoColor This parameter specifies the endding GeoColor of the GeoLinearGradientBrush.
directionAngle Single This parameter specifies the direction angle value of the GeoLinearGradientBrush.

Go Back

Protected Constructors

GeoLinearGradientBrush()

Create a new instance of the GeoLinearGradientBrush with default settings.

Parameters

Name Type Description

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
GeoBrush A cloned GeoBrush.

Parameters

Name Type Description

Go Back

Equals(Object)

Return Value

Return Type Description
Boolean

Parameters

Name Type Description
obj Object

Go Back

GetHashCode()

Return Value

Return Type Description
Int32

Parameters

Name Type Description

Go Back

GetType()

Return Value

Return Type Description
Type

Parameters

Name Type Description

Go Back

ToString()

Return Value

Return Type Description
String

Parameters

Name Type Description

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
GeoBrush A cloned GeoBrush.

Parameters

Name Type Description

Go Back

Finalize()

Return Value

Return Type Description
Void

Parameters

Name Type Description

Go Back

MemberwiseClone()

Return Value

Return Type Description
Object

Parameters

Name Type Description

Go Back

Public Properties

DirectionAngle

Gets or sets the Direction angle of the GeoLinearGradientBrush.

Return Value

Return Type
Single

Go Back

EndColor

Gets or sets the ending GeoColor of the gradient.

Return Value

Return Type
GeoColor

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

Go Back

StartColor

Gets or sets the starting GeoColor of the gradient.

Return Value

Return Type
GeoColor

Go Back

WrapMode

Gets or sets a GeoWrapMode enumeration that indicates the wrap mode for the GeoLinearGradientBrush.

Return Value

Return Type
GeoWrapMode

Go Back

Protected Properties

Public Events

thinkgeo.mapsuite.core.geolineargradientbrush.1440998469.txt.gz · Last modified: 2015/08/31 05:21 by admin