Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.portablecore.geocolor
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.PortableCore.GeoColor
<!– Structure –> This structure represents a color for drawing on a GeoCanvas.
Inheritance Hierarchy
*System.ValueType **ThinkGeo.MapSuite.PortableCore.GeoColor
Members Summary
Public Constructors
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Equals | Object | Object(overriden) | This method is an override of the Equals functionality. |
 FromAhsl | Int32, Single, Single, Single | This parameter specifies the red component of the color. This method returns a GeoColor based on the Alpha, Hue, Saturation, and Luminosity components. | |
| FromArgb | Int32, Int32, Int32, Int32 | This method returns a GeoColor based on the Alpha, Red, Green, and Blue components. | |
| FromArgb | Int32, GeoColor | This method returns a GeoColor based on the Alpha, Red, Green, and Blue components. | |
| FromHtml | String | This method returns a GeoColor from an HTML color (either in hexadecimal or a named color). | |
| FromOle | Int32 | This method returns a GeoColor from an OLE color. | |
| FromWin32 | Int32 | This method returns a GeoColor from a Win32 color. | |
| GetColorsInHueFamily | GeoColor, Int32 | This method returns a collection of GeoColors based on the same hue that is passed in. | |
| GetColorsInQualityFamily | GeoColor, Int32 | This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in. | |
| GetColorsInQualityFamily | GeoColor, GeoColor, Int32, ColorWheelDirection | ||
| GetHashCode | Object(overriden) | This method is an override of the GetHashCode functionality. | |
| GetRandomGeoColor | Int32, RandomColorType | Creates a random GeoColor structure | |
| GetRandomGeoColor | RandomColorType | Creates a random GeoColor structure based on the specific ColorType | |
| GetType | Object | ||
| ToHtml | GeoColor | This method returns an HTML color from a GeoColor. | |
| ToOle | GeoColor | This method returns an OLE color from a GeoColor. | |
| ToString | Object(overriden) | ||
| ToWin32 | GeoColor | This method returns a Win32 color from a GeoColor. |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 AlphaComponent | Byte | This property returns the alpha component of the GeoColor. | |
| BlueComponent | Byte | This property returns the blue component of the GeoColor. | |
| GeographicColors | GeographicColors | This method returns a list of commonly-used predefined geographic colors. | |
| GreenComponent | Byte | This property returns the green component of the GeoColor. | |
| Hue | Single | This property returns the hue component of the GeoColor. | |
| IsTransparent | Boolean | Verify if the GeoColor is transparent, it is considered to be transparent if the Alpha Value is 0. | |
| Luminance | Single | This property returns the luminance component of the GeoColor. | |
| RedComponent | Byte | This property returns the red component of the GeoColor. | |
| Saturation | Single | This property returns the saturation component of the GeoColor. | |
| SimpleColors | SimpleColors | This method returns a list of simple predefined colors. | |
| StandardColors | StandardColors | This method returns a list of commonly-used predefined colors. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
GeoColor(Int32, Int32, Int32)
This constructor creates a new color.
Overloads
This constructor allows you to specify the red, green, and blue component.
Parameters
| Name | Type | Description |
|---|---|---|
| red | Int32<!– System.Int32 –> | This parameter specifies the red component of the color. |
| green | Int32<!– System.Int32 –> | This parameter specifies the green component of the color. |
| blue | Int32<!– System.Int32 –> | This parameter specifies the blue component of the color. |
GeoColor(Int32, Int32, Int32, Int32)
This constructor creates a new color.
Overloads
This constructor allows you to specify the red, green, blue, and alpha component.
Parameters
| Name | Type | Description |
|---|---|---|
| alpha | Int32<!– System.Int32 –> | This parameter specifies the alpha, or transparent, component of the color. |
| red | Int32<!– System.Int32 –> | This parameter specifies the red component of the color. |
| green | Int32<!– System.Int32 –> | This parameter specifies the green component of the color. |
| blue | Int32<!– System.Int32 –> | This parameter specifies the blue component of the color. |
GeoColor(Int32, GeoColor)
This constructor creates a new color.
Overloads
This overload creates a transparent version of another color.
Remarks
You can use this overload to create a transparent version of another color.
Parameters
| Name | Type | Description |
|---|---|---|
| alpha | Int32<!– System.Int32 –> | This parameter specifies the alpha component. An alpha of 0 is totally transparent. |
| color | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This parameter specifies the base color. |
Protected Constructors
Public Methods
Equals(Object)
This method is an override of the Equals functionality.
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> | This method returns the Equals functionality. |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> | This parameter is the object you want to check to see if it is equal to the current instance. |
<!– System.Object(overriden) –> Go Back
FromAhsl(Int32, Single, Single, Single)
<!– static –> This parameter specifies the red component of the color. This method returns a GeoColor based on the Alpha, Hue, Saturation, and Luminosity components.
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> |
Parameters
| Name | Type | Description |
|---|---|---|
| alpha | Int32<!– System.Int32 –> | This parameter specifies the alpha, or transparent, component of the color. |
| hue | Single<!– System.Single –> | This parameter specifies the hue component of the color. |
| saturation | Single<!– System.Single –> | This parameter specifies the saturation component of the color. |
| luminance | Single<!– System.Single –> | This parameter specifies the luminance component of the color. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
FromArgb(Int32, Int32, Int32, Int32)
<!– static –> This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
Overloads
This overload lets you specify each component.
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This method returns a GeoColor based on the Alpha, Red, Green, and Blue components. |
Parameters
| Name | Type | Description |
|---|---|---|
| alpha | Int32<!– System.Int32 –> | This parameter specifies the alpha, or transparent, component of the color. |
| red | Int32<!– System.Int32 –> | This parameter specifies the red component of the color. |
| green | Int32<!– System.Int32 –> | This parameter specifies the green component of the color. |
| blue | Int32<!– System.Int32 –> | This parameter specifies the blue component of the color. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
FromArgb(Int32, GeoColor)
<!– static –> This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
Overloads
This method creates a transparent version of another color.
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | You can use this overload to create a transparent version of another color. |
Parameters
| Name | Type | Description |
|---|---|---|
| alpha | Int32<!– System.Int32 –> | This parameter determines how transparent the color is. An alpha of 0 means it is totally transparent. |
| baseColor | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This parameter is the color you want to apply the transparency to. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
FromHtml(String)
<!– static –> This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This method returns a GeoColor from an HTML color (either in hexadecimal or a named color). |
Parameters
| Name | Type | Description |
|---|---|---|
| htmlColor | String<!– System.String –> | This parameter represents the HTML color that you want to convert. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
FromOle(Int32)
<!– static –> This method returns a GeoColor from an OLE color.
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This method returns a GeoColor from an OLE color. |
Parameters
| Name | Type | Description |
|---|---|---|
| oleColor | Int32<!– System.Int32 –> | This parameter represents the OLE color you want to convert. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
FromWin32(Int32)
<!– static –> This method returns a GeoColor from a Win32 color.
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This method returns a GeoColor from a Win32 color. |
Parameters
| Name | Type | Description |
|---|---|---|
| win32Color | Int32<!– System.Int32 –> | This parameter represents the Win32 color you want to convert. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GetColorsInHueFamily(GeoColor, Int32)
<!– static –> This method returns a collection of GeoColors based on the same hue that is passed in.
Remarks
This method is useful when you want to get a number of colors that have the same hue. For example, you can use this in maps that represent class breaks. If you passed in a red hue, then the method would return variations such as light red, dark red, pastel red, etc.
Return Value
| Return Type | Description |
|---|---|
| Collection<GeoColor><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.GeoColor} –> | This method returns a collection of GeoColors based on the same hue that is passed in. |
Parameters
| Name | Type | Description |
|---|---|---|
| baseColor | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This parameter is the color on which you want to base the color collection. |
| numbersOfColors | Int32<!– System.Int32 –> | This parameter represents the number of colors you want returned from the method. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GetColorsInQualityFamily(GeoColor, Int32)
<!– static –> This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.
Remarks
This method is useful when you want to get a number of different colors that have the same quality. For example, you can use this in maps that represent countries or connected places. If you passed in bright red, then the method would return variants such as bright blue, bright green, etc. If you passed in dark red, you would get dark blue, dark green, etc.
Return Value
| Return Type | Description |
|---|---|
| Collection<GeoColor><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.GeoColor} –> | This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in. |
Parameters
| Name | Type | Description |
|---|---|---|
| baseColor | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This parameter is the color on which you want to base the color collection. |
| numberOfColors | Int32<!– System.Int32 –> | This parameter represents the number of colors you want returned from the method. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GetColorsInQualityFamily(GeoColor, GeoColor, Int32, ColorWheelDirection)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| Collection<GeoColor><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.GeoColor} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| fromColor | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | |
| toColor | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | |
| numberOfColors | Int32<!– System.Int32 –> | |
| colorWheelDirection | ColorWheelDirection<!– ThinkGeo.MapSuite.PortableCore.ColorWheelDirection –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GetHashCode()
This method is an override of the GetHashCode functionality.
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> | This method returns the hash code. |
Parameters
| Name | Type | Description |
|---|
<!– System.Object(overriden) –> Go Back
GetRandomGeoColor(Int32, RandomColorType)
<!– static –> Creates a random GeoColor structure
Overloads
Creates a GeoColor structure with random color
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | A GeoColor structure the method created. |
Parameters
| Name | Type | Description |
|---|---|---|
| alpha | Int32<!– System.Int32 –> | The alpha component. Valid values are 0 through 255. |
| colorType | RandomColorType<!– ThinkGeo.MapSuite.PortableCore.RandomColorType –> | A ColorType defines types of color. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GetRandomGeoColor(RandomColorType)
<!– static –> Creates a random GeoColor structure based on the specific ColorType
Overloads
Creates a GeoColor structure with random color
Return Value
| Return Type | Description |
|---|---|
| GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | A GeoColor structure the method created. |
Parameters
| Name | Type | Description |
|---|---|---|
| colorType | RandomColorType<!– ThinkGeo.MapSuite.PortableCore.RandomColorType –> | A ColorType defines types of color. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToHtml(GeoColor)
<!– static –> This method returns an HTML color from a GeoColor.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | This method returns an HTML color from a GeoColor. |
Parameters
| Name | Type | Description |
|---|---|---|
| color | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This parameter represents the GeoColor you want to convert. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
ToOle(GeoColor)
<!– static –> This method returns an OLE color from a GeoColor.
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> | This method returns an OLE color from a GeoColor. |
Parameters
| Name | Type | Description |
|---|---|---|
| color | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This parameter represents the GeoColor you want to convert. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object(overriden) –> Go Back
ToWin32(GeoColor)
<!– static –> This method returns a Win32 color from a GeoColor.
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> | This method returns a Win32 color from a GeoColor. |
Parameters
| Name | Type | Description |
|---|---|---|
| color | GeoColor<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> | This parameter represents the GeoColor you want to convert. |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
Protected Methods
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
AlphaComponent
This property returns the alpha component of the GeoColor.
Return Value
| Return Type |
|---|
| Byte<!– System.Byte –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
BlueComponent
This property returns the blue component of the GeoColor.
Return Value
| Return Type |
|---|
| Byte<!– System.Byte –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GeographicColors
<!– static –> This method returns a list of commonly-used predefined geographic colors.
Remarks
You can use these as colors to represent many different types of geographic features.
Return Value
| Return Type |
|---|
| GeographicColors<!– ThinkGeo.MapSuite.PortableCore.GeographicColors –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
GreenComponent
This property returns the green component of the GeoColor.
Return Value
| Return Type |
|---|
| Byte<!– System.Byte –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
Hue
This property returns the hue component of the GeoColor.
Return Value
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
IsTransparent
Verify if the GeoColor is transparent, it is considered to be transparent if the Alpha Value is 0.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
Luminance
This property returns the luminance component of the GeoColor.
Return Value
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
RedComponent
This property returns the red component of the GeoColor.
Return Value
| Return Type |
|---|
| Byte<!– System.Byte –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
Saturation
This property returns the saturation component of the GeoColor.
Return Value
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
SimpleColors
<!– static –> This method returns a list of simple predefined colors.
Return Value
| Return Type |
|---|
| SimpleColors<!– ThinkGeo.MapSuite.PortableCore.SimpleColors –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
StandardColors
<!– static –> This method returns a list of commonly-used predefined colors.
Return Value
| Return Type |
|---|
| StandardColors<!– ThinkGeo.MapSuite.PortableCore.StandardColors –> |
<!– ThinkGeo.MapSuite.PortableCore.GeoColor –> Go Back
Protected Properties
Public Events
thinkgeo.mapsuite.portablecore.geocolor.1440040132.txt.gz · Last modified: 2015/09/21 08:08 (external edit)
