ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.GeoColor ======
This structure represents a color for drawing on a GeoCanvas.
===== Inheritance Hierarchy =====
  *System.Object
    *System.ValueType
      ***ThinkGeo.MapSuite.Core.GeoColor**
===== Members Summary =====
=== Public Constructors ===
<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GeoColor(Int32,Int32,Int32)|GeoColor]]**
  * **Parameters**:Int32,Int32,Int32
  * **DeclaringType**:N/A
  * **Summary**:This constructor creates a new color.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GeoColor(Int32,Int32,Int32,Int32)|GeoColor]]**
  * **Parameters**:Int32,Int32,Int32,Int32
  * **DeclaringType**:N/A
  * **Summary**:This constructor creates a new color.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GeoColor(Int32,GeoColor)|GeoColor]]**
  * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **DeclaringType**:N/A
  * **Summary**:This constructor creates a new color.
</div>

=== Protected Constructors ===
<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#GeoColor(String,ColorType,Int32,Int32,Int32,Int32)|GeoColor]]**
  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.ColorType|ColorType]],Int32,Int32,Int32,Int32
  * **DeclaringType**:N/A
  * **Summary**:N/A
</div>

=== Public Methods ===
<div class_table>
**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
  * **Parameters**:Object
  * **DeclaringType**:N/A
  * **Summary**:This method is an override of the Equals functionality.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromAhsl(Int32,Single,Single,Single)|FromAhsl]]**
  * **Parameters**:Int32,Single,Single,Single
  * **DeclaringType**:N/A
  * **Summary**:This parameter specifies the red component of the color. This method returns a GeoColor based on the Alpha, Hue, Saturation, and Luminosity components.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromArgb(Int32,Int32,Int32,Int32)|FromArgb]]**
  * **Parameters**:Int32,Int32,Int32,Int32
  * **DeclaringType**:N/A
  * **Summary**:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromArgb(Int32,GeoColor)|FromArgb]]**
  * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **DeclaringType**:N/A
  * **Summary**:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromHtml(String)|FromHtml]]**
  * **Parameters**:String
  * **DeclaringType**:N/A
  * **Summary**:This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromOle(Int32)|FromOle]]**
  * **Parameters**:Int32
  * **DeclaringType**:N/A
  * **Summary**:This method returns a GeoColor from an OLE color.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromWin32(Int32)|FromWin32]]**
  * **Parameters**:Int32
  * **DeclaringType**:N/A
  * **Summary**:This method returns a GeoColor from a Win32 color.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetColorsInHueFamily(GeoColor,Int32)|GetColorsInHueFamily]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32
  * **DeclaringType**:N/A
  * **Summary**:This method returns a collection of GeoColors based on the same hue that is passed in.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetColorsInQualityFamily(GeoColor,Int32)|GetColorsInQualityFamily]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32
  * **DeclaringType**:N/A
  * **Summary**:This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection)|GetColorsInQualityFamily]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32,[[ThinkGeo.MapSuite.Core.ColorWheelDirection|ColorWheelDirection]]
  * **DeclaringType**:N/A
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
  * **Parameters**:N/A
  * **DeclaringType**:N/A
  * **Summary**:This method is an override of the GetHashCode functionality.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetRandomGeoColor(RandomColorType)|GetRandomGeoColor]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
  * **DeclaringType**:N/A
  * **Summary**:Creates a random GeoColor structure based on the specific ColorType
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetRandomGeoColor(Int32,RandomColorType)|GetRandomGeoColor]]**
  * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
  * **DeclaringType**:N/A
  * **Summary**:Creates a random GeoColor structure
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToHtml(GeoColor)|ToHtml]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **DeclaringType**:N/A
  * **Summary**:This method returns an HTML color from a GeoColor.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToOle(GeoColor)|ToOle]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **DeclaringType**:N/A
  * **Summary**:This method returns an OLE color from a GeoColor.
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
  * **Parameters**:N/A
  * **DeclaringType**:ValueType
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToWin32(GeoColor)|ToWin32]]**
  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **DeclaringType**:N/A
  * **Summary**:This method returns a Win32 color from a GeoColor.
</div>

=== Protected Methods ===
<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

<div class_table>
**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
  * **Parameters**:N/A
  * **DeclaringType**:Object
  * **Summary**:N/A
</div>

=== Public Properties ===
**{{wiki:PublicProperty.gif|}}[[#AlphaComponent|AlphaComponent]]**
  * **Return**:Byte
  * **Summary**:This property returns the alpha component of the GeoColor.

**{{wiki:PublicProperty.gif|}}[[#BlueComponent|BlueComponent]]**
  * **Return**:Byte
  * **Summary**:This property returns the blue component of the GeoColor.

**{{wiki:PublicProperty.gif|}}[[#GreenComponent|GreenComponent]]**
  * **Return**:Byte
  * **Summary**:This property returns the green component of the GeoColor.

**{{wiki:PublicProperty.gif|}}[[#Hue|Hue]]**
  * **Return**:Single
  * **Summary**:This property returns the hue component of the GeoColor.

**{{wiki:PublicProperty.gif|}}[[#IsTransparent|IsTransparent]]**
  * **Return**:Boolean
  * **Summary**:Verify if the GeoColor is transparent, it is considered to be transparent if the Alpha Value is 0.

**{{wiki:PublicProperty.gif|}}[[#Luminance|Luminance]]**
  * **Return**:Single
  * **Summary**:This property returns the luminance component of the GeoColor.

**{{wiki:PublicProperty.gif|}}[[#RedComponent|RedComponent]]**
  * **Return**:Byte
  * **Summary**:This property returns the red component of the GeoColor.

**{{wiki:PublicProperty.gif|}}[[#Saturation|Saturation]]**
  * **Return**:Single
  * **Summary**:This property returns the saturation component of the GeoColor.

=== Protected Properties ===
=== Public Events ===
===== Public Constructors =====
=== GeoColor(Int32,Int32,Int32) ===
This constructor creates a new color.
==== Remarks ====
None
==== Parameters ====
**red**
  * **Type**:Int32
  * **Description:This parameter specifies the red component of the color.

**green**
  * **Type**:Int32
  * **Description:This parameter specifies the green component of the color.

**blue**
  * **Type**:Int32
  * **Description:This parameter specifies the blue component of the color.

[[#Public Constructors|Go Back]]
=== GeoColor(Int32,Int32,Int32,Int32) ===
This constructor creates a new color.
==== Remarks ====
None
==== Parameters ====
**alpha**
  * **Type**:Int32
  * **Description:This parameter specifies the alpha, or transparent, component of the color.

**red**
  * **Type**:Int32
  * **Description:This parameter specifies the red component of the color.

**green**
  * **Type**:Int32
  * **Description:This parameter specifies the green component of the color.

**blue**
  * **Type**:Int32
  * **Description:This parameter specifies the blue component of the color.

[[#Public Constructors|Go Back]]
=== GeoColor(Int32,GeoColor) ===
This constructor creates a new color.
==== Remarks ====
You can use this overload to create a transparent version of another color.
==== Parameters ====
**alpha**
  * **Type**:Int32
  * **Description:This parameter specifies the alpha component. An alpha of 0 is totally transparent.

**color**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description:This parameter specifies the base color.

[[#Public Constructors|Go Back]]
===== Protected Constructors =====
=== GeoColor(String,ColorType,Int32,Int32,Int32,Int32) ===
N/A
==== Remarks ====
N/A
==== Parameters ====
**name**
  * **Type**:String
  * **Description:N/A

**colorType**
  * **Type**:[[ThinkGeo.MapSuite.Core.ColorType|ColorType]]
  * **Description:N/A

**alpha**
  * **Type**:Int32
  * **Description:N/A

**red**
  * **Type**:Int32
  * **Description:N/A

**green**
  * **Type**:Int32
  * **Description:N/A

**blue**
  * **Type**:Int32
  * **Description:N/A

[[#Protected Constructors|Go Back]]
===== Public Methods =====
=== Equals(Object) ===
This method is an override of the Equals functionality.
==== Remarks ====
None

**Return Value**
  * **Return Type**:Boolean
  * **Description**:This method returns the Equals functionality.

==== Parameters ====
**obj**
  * **Type**:Object
  * **Description**:This parameter is the object you want to check to see if it is equal to the current instance.

[[#Public Methods|Go Back]]
=== 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.
==== Remarks ====
None

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:N/A

==== Parameters ====
**alpha**
  * **Type**:Int32
  * **Description**:This parameter specifies the alpha, or transparent, component of the color.

**hue**
  * **Type**:Single
  * **Description**:This parameter specifies the hue component of the color.

**saturation**
  * **Type**:Single
  * **Description**:This parameter specifies the saturation component of the color.

**luminance**
  * **Type**:Single
  * **Description**:This parameter specifies the luminance component of the color.

[[#Public Methods|Go Back]]
=== FromArgb(Int32,Int32,Int32,Int32) ===
This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
==== Remarks ====
None

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.

==== Parameters ====
**alpha**
  * **Type**:Int32
  * **Description**:This parameter specifies the alpha, or transparent, component of the color.

**red**
  * **Type**:Int32
  * **Description**:This parameter specifies the red component of the color.

**green**
  * **Type**:Int32
  * **Description**:This parameter specifies the green component of the color.

**blue**
  * **Type**:Int32
  * **Description**:This parameter specifies the blue component of the color.

[[#Public Methods|Go Back]]
=== FromArgb(Int32,GeoColor) ===
This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:You can use this overload to create a transparent version of another color.

==== Parameters ====
**alpha**
  * **Type**:Int32
  * **Description**:This parameter determines how transparent the color is. An alpha of 0 means it is totally transparent.

**baseColor**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This parameter is the color you want to apply the transparency to.

[[#Public Methods|Go Back]]
=== FromHtml(String) ===
This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
==== Remarks ====
None

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).

==== Parameters ====
**htmlColor**
  * **Type**:String
  * **Description**:This parameter represents the HTML color that you want to convert.

[[#Public Methods|Go Back]]
=== FromOle(Int32) ===
This method returns a GeoColor from an OLE color.
==== Remarks ====
None

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This method returns a GeoColor from an OLE color.

==== Parameters ====
**oleColor**
  * **Type**:Int32
  * **Description**:This parameter represents the OLE color you want to convert.

[[#Public Methods|Go Back]]
=== FromWin32(Int32) ===
This method returns a GeoColor from a Win32 color.
==== Remarks ====
None

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This method returns a GeoColor from a Win32 color.

==== Parameters ====
**win32Color**
  * **Type**:Int32
  * **Description**:This parameter represents the Win32 color you want to convert.

[[#Public Methods|Go Back]]
=== GetColorsInHueFamily(GeoColor,Int32) ===
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**:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
  * **Description**:This method returns a collection of GeoColors based on the same hue that is passed in.

==== Parameters ====
**baseColor**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This parameter is the color on which you want to base the color collection.

**numbersOfColors**
  * **Type**:Int32
  * **Description**:This parameter represents the number of colors you want returned from the method.

[[#Public Methods|Go Back]]
=== GetColorsInQualityFamily(GeoColor,Int32) ===
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**:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
  * **Description**:This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.

==== Parameters ====
**baseColor**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This parameter is the color on which you want to base the color collection.

**numberOfColors**
  * **Type**:Int32
  * **Description**:This parameter represents the number of colors you want returned from the method.

[[#Public Methods|Go Back]]
=== GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection) ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
  * **Description**:N/A

==== Parameters ====
**fromColor**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:N/A

**toColor**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:N/A

**numberOfColors**
  * **Type**:Int32
  * **Description**:N/A

**colorWheelDirection**
  * **Type**:[[ThinkGeo.MapSuite.Core.ColorWheelDirection|ColorWheelDirection]]
  * **Description**:N/A

[[#Public Methods|Go Back]]
=== GetHashCode() ===
This method is an override of the GetHashCode functionality.
==== Remarks ====
None

**Return Value**
  * **Return Type**:Int32
  * **Description**:This method returns the hash code.

==== Parameters ====
[[#Public Methods|Go Back]]
=== GetRandomGeoColor(RandomColorType) ===
Creates a random GeoColor structure based on the specific ColorType
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:A GeoColor structure the method created.

==== Parameters ====
**colorType**
  * **Type**:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
  * **Description**:A ColorType defines types of color.

[[#Public Methods|Go Back]]
=== GetRandomGeoColor(Int32,RandomColorType) ===
Creates a random GeoColor structure
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:A GeoColor structure the method created.

==== Parameters ====
**alpha**
  * **Type**:Int32
  * **Description**:The alpha component. Valid values are 0 through 255.

**colorType**
  * **Type**:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
  * **Description**:A ColorType defines types of color.

[[#Public Methods|Go Back]]
=== GetType() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Type
  * **Description**:N/A

==== Parameters ====
[[#Public Methods|Go Back]]
=== ToHtml(GeoColor) ===
This method returns an HTML color from a GeoColor.
==== Remarks ====
None

**Return Value**
  * **Return Type**:String
  * **Description**:This method returns an HTML color from a GeoColor.

==== Parameters ====
**color**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This parameter represents the GeoColor you want to convert.

[[#Public Methods|Go Back]]
=== ToOle(GeoColor) ===
This method returns an OLE color from a GeoColor.
==== Remarks ====
None

**Return Value**
  * **Return Type**:Int32
  * **Description**:This method returns an OLE color from a GeoColor.

==== Parameters ====
**color**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This parameter represents the GeoColor you want to convert.

[[#Public Methods|Go Back]]
=== ToString() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:String
  * **Description**:N/A

==== Parameters ====
[[#Public Methods|Go Back]]
=== ToWin32(GeoColor) ===
This method returns a Win32 color from a GeoColor.
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Int32
  * **Description**:This method returns a Win32 color from a GeoColor.

==== Parameters ====
**color**
  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
  * **Description**:This parameter represents the GeoColor you want to convert.

[[#Public Methods|Go Back]]
===== Protected Methods =====
=== Finalize() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Void
  * **Description**:N/A

==== Parameters ====
[[#Protected Methods|Go Back]]
=== MemberwiseClone() ===
N/A
==== Remarks ====
N/A

**Return Value**
  * **Return Type**:Object
  * **Description**:N/A

==== Parameters ====
[[#Protected Methods|Go Back]]
===== Public Properties =====
=== AlphaComponent ===
This property returns the alpha component of the GeoColor.
==== Remarks ====
None
==== Return Value ====
**Return Type**:Byte

[[#Public Properties|Go Back]]
=== BlueComponent ===
This property returns the blue component of the GeoColor.
==== Remarks ====
None
==== Return Value ====
**Return Type**:Byte

[[#Public Properties|Go Back]]
=== GreenComponent ===
This property returns the green component of the GeoColor.
==== Remarks ====
None
==== Return Value ====
**Return Type**:Byte

[[#Public Properties|Go Back]]
=== Hue ===
This property returns the hue component of the GeoColor.
==== Remarks ====
None
==== Return Value ====
**Return Type**:Single

[[#Public Properties|Go Back]]
=== IsTransparent ===
Verify if the GeoColor is transparent, it is considered to be transparent if the Alpha Value is 0.
==== Remarks ====
N/A
==== Return Value ====
**Return Type**:Boolean

[[#Public Properties|Go Back]]
=== Luminance ===
This property returns the luminance component of the GeoColor.
==== Remarks ====
None
==== Return Value ====
**Return Type**:Single

[[#Public Properties|Go Back]]
=== RedComponent ===
This property returns the red component of the GeoColor.
==== Remarks ====
None
==== Return Value ====
**Return Type**:Byte

[[#Public Properties|Go Back]]
=== Saturation ===
This property returns the saturation component of the GeoColor.
==== Remarks ====
None
==== Return Value ====
**Return Type**:Single

[[#Public Properties|Go Back]]
===== Protected Properties =====
===== Public Events =====
User Tools

Site Tools

Page Tools
