Differences

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

--- thinkgeo.mapsuite.core.geocolor [2015/09/17 10:29]
admin
+++ thinkgeo.mapsuite.core.geocolor [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.GeoColor ======
+{{section>upgrade_map_suite_to_10.0}}
 This structure represents a color for drawing on a GeoCanvas.
 ===== Inheritance Hierarchy =====
@@ Line 6: / Line 9: @@
       ***ThinkGeo.MapSuite.Core.GeoColor**
 ===== Members Summary =====
-=== Public Constructors ===
+==== Public Constructors ====
-<div class_table>
+** {{wiki:PublicMethod.gif|}} GeoColor(Int32,Int32,Int32) **
-**{{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>
+  * //This constructor creates a new color.//
-**{{wiki:PublicMethod.gif|}}[[#GeoColor(Int32,Int32,Int32,Int32)|GeoColor]]**
+== Remarks ==
-  * **Parameters**:Int32,Int32,Int32,Int32
+  * //None//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This constructor creates a new color.
+  * //red//
-</div>
+    * Type:Int32
+    * Description:This parameter specifies the red component of the color.
-<div class_table>
+  * //green//
-**{{wiki:PublicMethod.gif|}}[[#GeoColor(Int32,GeoColor)|GeoColor]]**
+    * Type:Int32
-  * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:This parameter specifies the green component of the color.
-  * **DeclaringType**:N/A
-  * **Summary**:This constructor creates a new color.
-</div>
-=== Protected Constructors ===
+  * //blue//
-<div class_table>
+    * Type:Int32
-**{{wiki:ProtectedMethod.gif|}}[[#GeoColor(String,ColorType,Int32,Int32,Int32,Int32)|GeoColor]]**
+    * Description:This parameter specifies the blue component of the color.
-  * **Parameters**:String,[[ThinkGeo.MapSuite.Core.ColorType|ColorType]],Int32,Int32,Int32,Int32
-  * **DeclaringType**:N/A
-  * **Summary**:N/A
-</div>
-=== Public Methods ===
+<div newline></div>
-<div class_table>
+** {{wiki:PublicMethod.gif|}} GeoColor(Int32,Int32,Int32,Int32) **
-**{{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>
+  * //This constructor creates a new color.//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromAhsl(Int32,Single,Single,Single)|FromAhsl]]**
+== Remarks ==
-  * **Parameters**:Int32,Single,Single,Single
+  * //None//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This parameter specifies the red component of the color. This method returns a GeoColor based on the Alpha, Hue, Saturation, and Luminosity components.
+  * //alpha//
-</div>
+    * Type:Int32
+    * Description:This parameter specifies the alpha, or transparent, component of the color.
-<div class_table>
+  * //red//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromArgb(Int32,Int32,Int32,Int32)|FromArgb]]**
+    * Type:Int32
-  * **Parameters**:Int32,Int32,Int32,Int32
+    * Description:This parameter specifies the red component of the color.
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
-</div>
-<div class_table>
+  * //green//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromArgb(Int32,GeoColor)|FromArgb]]**
+    * Type:Int32
-  * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:This parameter specifies the green component of the color.
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
-</div>
-<div class_table>
+  * //blue//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromHtml(String)|FromHtml]]**
+    * Type:Int32
-  * **Parameters**:String
+    * Description:This parameter specifies the blue component of the color.
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromOle(Int32)|FromOle]]**
+** {{wiki:PublicMethod.gif|}} GeoColor(Int32,GeoColor) **
-  * **Parameters**:Int32
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns a GeoColor from an OLE color.
-</div>
-<div class_table>
+  * //This constructor creates a new color.//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#FromWin32(Int32)|FromWin32]]**
+== Remarks ==
-  * **Parameters**:Int32
+  * //You can use this overload to create a transparent version of another color.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This method returns a GeoColor from a Win32 color.
+  * //alpha//
-</div>
+    * Type:Int32
+    * Description:This parameter specifies the alpha component. An alpha of 0 is totally transparent.
-<div class_table>
+  * //color//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetColorsInHueFamily(GeoColor,Int32)|GetColorsInHueFamily]]**
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32
+    * Description:This parameter specifies the base color.
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns a collection of GeoColors based on the same hue that is passed in.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetColorsInQualityFamily(GeoColor,Int32)|GetColorsInQualityFamily]]**
+==== Protected Constructors ====
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32
+** {{wiki:ProtectedMethod.gif|}} GeoColor(String,ColorType,Int32,Int32,Int32,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>
+  * //N/A//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection)|GetColorsInQualityFamily]]**
+== Remarks ==
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]],Int32,[[ThinkGeo.MapSuite.Core.ColorWheelDirection|ColorWheelDirection]]
+  * //N/A//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:N/A
+  * //name//
-</div>
+    * Type:String
+    * Description:N/A
-<div class_table>
+  * //colorType//
-**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
+    * Type:[[ThinkGeo.MapSuite.Core.ColorType|ColorType]]
-  * **Parameters**:N/A
+    * Description:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This method is an override of the GetHashCode functionality.
-</div>
-<div class_table>
+  * //alpha//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetRandomGeoColor(RandomColorType)|GetRandomGeoColor]]**
+    * Type:Int32
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
+    * Description:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:Creates a random GeoColor structure based on the specific ColorType
-</div>
-<div class_table>
+  * //red//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#GetRandomGeoColor(Int32,RandomColorType)|GetRandomGeoColor]]**
+    * Type:Int32
-  * **Parameters**:Int32,[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
+    * Description:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:Creates a random GeoColor structure
-</div>
-<div class_table>
+  * //green//
-**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
+    * Type:Int32
-  * **Parameters**:N/A
+    * Description:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //blue//
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToHtml(GeoColor)|ToHtml]]**
+    * Type:Int32
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns an HTML color from a GeoColor.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToOle(GeoColor)|ToOle]]**
+==== Public Methods ====
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns an OLE color from a GeoColor.
-</div>
-<div class_table>
+  * //This method is an override of the Equals functionality.//
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //None//
-  * **DeclaringType**:ValueType
-  * **Summary**:N/A
-</div>
-<div class_table>
+== Return Value ==
-**{{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}}[[#ToWin32(GeoColor)|ToWin32]]**
+  * Type:Boolean
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * Description:This method returns the Equals functionality.
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns a Win32 color from a GeoColor.
-</div>
-=== Protected Methods ===
+== Parameters ==
-<div class_table>
+  * //obj//
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
+    * Type:Object
-  * **Parameters**:N/A
+    * Description:This parameter is the object you want to check to see if it is equal to the current instance.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-=== Public Properties ===
+  * //This method is an override of the GetHashCode functionality.//
-**{{wiki:PublicProperty.gif|}}[[#AlphaComponent|AlphaComponent]]**
+== Remarks ==
-  * **Return**:Byte
+  * //None//
-  * **Summary**:This property returns the alpha component of the GeoColor.
-**{{wiki:PublicProperty.gif|}}[[#BlueComponent|BlueComponent]]**
+== Return Value ==
-  * **Return**:Byte
+  * Type:Int32
-  * **Summary**:This property returns the blue component of the GeoColor.
+  * Description:This method returns the hash code.
-**{{wiki:PublicProperty.gif|}}[[#GreenComponent|GreenComponent]]**
+== Parameters ==
-  * **Return**:Byte
+<div newline></div>
-  * **Summary**:This property returns the green component of the GeoColor.
+** {{wiki:PublicMethod.gif|}} ToString() **
-**{{wiki:PublicProperty.gif|}}[[#Hue|Hue]]**
+  * //N/A//
-  * **Return**:Single
+== Remarks ==
-  * **Summary**:This property returns the hue component of the GeoColor.
+  * //N/A//
-**{{wiki:PublicProperty.gif|}}[[#IsTransparent|IsTransparent]]**
+== Return Value ==
-  * **Return**:Boolean
+  * Type:String
-  * **Summary**:Verify if the GeoColor is transparent, it is considered to be transparent if the Alpha Value is 0.
+  * Description:N/A
-**{{wiki:PublicProperty.gif|}}[[#Luminance|Luminance]]**
+== Parameters ==
-  * **Return**:Single
+<div newline></div>
-  * **Summary**:This property returns the luminance component of the GeoColor.
+** {{wiki:PublicMethod.gif|}} GetType() **
-**{{wiki:PublicProperty.gif|}}[[#RedComponent|RedComponent]]**
+  * //N/A//
-  * **Return**:Byte
+== Remarks ==
-  * **Summary**:This property returns the red component of the GeoColor.
+  * //N/A//
-**{{wiki:PublicProperty.gif|}}[[#Saturation|Saturation]]**
+== Return Value ==
-  * **Return**:Single
+  * Type:Type
-  * **Summary**:This property returns the saturation component of the GeoColor.
+  * Description:N/A
-=== Protected Properties ===
+== Parameters ==
-=== Public Events ===
+<div newline></div>
-===== Public Constructors =====
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInHueFamily(GeoColor,Int32) **
-=== 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**
+  * //This method returns a collection of GeoColors based on the same hue that is passed in.//
-  * **Type**:Int32
+== Remarks ==
-  * **Description:This parameter specifies the green component of the color.
+  * //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.//
-**blue**
+== Return Value ==
-  * **Type**:Int32
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
-  * **Description:This parameter specifies the blue component of the color.
+  * Description:This method returns a collection of GeoColors based on the same hue that is passed in.
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== GeoColor(Int32,Int32,Int32,Int32) ===
+  * //baseColor//
-This constructor creates a new color.
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-==== Remarks ====
+    * Description:This parameter is the color on which you want to base the color collection.
-None
-==== Parameters ====
-**alpha**
-  * **Type**:Int32
-  * **Description:This parameter specifies the alpha, or transparent, component of the color.
-**red**
+  * //numbersOfColors//
-  * **Type**:Int32
+    * Type:Int32
-  * **Description:This parameter specifies the red component of the color.
+    * Description:This parameter represents the number of colors you want returned from the method.
-**green**
+<div newline></div>
-  * **Type**:Int32
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInQualityFamily(GeoColor,Int32) **
-  * **Description:This parameter specifies the green component of the color.
-**blue**
+  * //This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.//
-  * **Type**:Int32
+== Remarks ==
-  * **Description:This parameter specifies the blue component of the color.
+  * //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.//
-[[#Public Constructors|Go Back]]
+== Return Value ==
-=== GeoColor(Int32,GeoColor) ===
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
-This constructor creates a new color.
+  * Description:This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.
-==== 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**
+== Parameters ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * //baseColor//
-  * **Description:This parameter specifies the base color.
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:This parameter is the color on which you want to base the color collection.
-[[#Public Constructors|Go Back]]
+  * //numberOfColors//
-===== Protected Constructors =====
+    * Type:Int32
-=== GeoColor(String,ColorType,Int32,Int32,Int32,Int32) ===
+    * Description:This parameter represents the number of colors you want returned from the method.
-N/A
-==== Remarks ====
-N/A
-==== Parameters ====
-**name**
-  * **Type**:String
-  * **Description:N/A
-**colorType**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.ColorType|ColorType]]
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection) **
-  * **Description:N/A
-**alpha**
+  * //N/A//
-  * **Type**:Int32
+== Remarks ==
-  * **Description:N/A
+  * //N/A//
-**red**
+== Return Value ==
-  * **Type**:Int32
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
-  * **Description:N/A
+  * Description:N/A
-**green**
+== Parameters ==
-  * **Type**:Int32
+  * //fromColor//
-  * **Description:N/A
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:N/A
-**blue**
+  * //toColor//
-  * **Type**:Int32
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description:N/A
+    * Description:N/A
-[[#Protected Constructors|Go Back]]
+  * //numberOfColors//
-===== Public Methods =====
+    * Type:Int32
-=== Equals(Object) ===
+    * Description:N/A
-This method is an override of the Equals functionality.
-==== Remarks ====
-None
-**Return Value**
+  * //colorWheelDirection//
-  * **Return Type**:Boolean
+    * Type:[[ThinkGeo.MapSuite.Core.ColorWheelDirection|ColorWheelDirection]]
-  * **Description**:This method returns the Equals functionality.
+    * Description:N/A
-==== Parameters ====
+<div newline></div>
-**obj**
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromArgb(Int32,Int32,Int32,Int32) **
-  * **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]]
+  * //This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.//
-=== FromAhsl(Int32,Single,Single,Single) ===
+== Remarks ==
-This parameter specifies the red component of the color. This method returns a GeoColor based on the Alpha, Hue, Saturation, and Luminosity components.
+  * //None//
-==== Remarks ====
-None
-**Return Value**
+== Return Value ==
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:N/A
+  * Description:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
-==== Parameters ====
+== Parameters ==
-**alpha**
+  * //alpha//
-  * **Type**:Int32
+    * Type:Int32
-  * **Description**:This parameter specifies the alpha, or transparent, component of the color.
+    * Description:This parameter specifies the alpha, or transparent, component of the color.
-**hue**
+  * //red//
-  * **Type**:Single
+    * Type:Int32
-  * **Description**:This parameter specifies the hue component of the color.
+    * Description:This parameter specifies the red component of the color.
-**saturation**
+  * //green//
-  * **Type**:Single
+    * Type:Int32
-  * **Description**:This parameter specifies the saturation component of the color.
+    * Description:This parameter specifies the green component of the color.
-**luminance**
+  * //blue//
-  * **Type**:Single
+    * Type:Int32
-  * **Description**:This parameter specifies the luminance component of the color.
+    * Description:This parameter specifies the blue component of the color.
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== FromArgb(Int32,Int32,Int32,Int32) ===
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromArgb(Int32,GeoColor) **
-This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
-==== Remarks ====
-None
-**Return Value**
+  * //This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.//
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+== Remarks ==
-  * **Description**:This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-**alpha**
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Type**:Int32
+  * Description:You can use this overload to create a transparent version of another color.
-  * **Description**:This parameter specifies the alpha, or transparent, component of the color.
-**red**
+== Parameters ==
-  * **Type**:Int32
+  * //alpha//
-  * **Description**:This parameter specifies the red component of the color.
+    * Type:Int32
+    * Description:This parameter determines how transparent the color is. An alpha of 0 means it is totally transparent.
-**green**
+  * //baseColor//
-  * **Type**:Int32
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:This parameter specifies the green component of the color.
+    * Description:This parameter is the color you want to apply the transparency to.
-**blue**
+<div newline></div>
-  * **Type**:Int32
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromAhsl(Int32,Single,Single,Single) **
-  * **Description**:This parameter specifies the blue component of the color.
-[[#Public Methods|Go Back]]
+  * //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,GeoColor) ===
+== Remarks ==
-This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.
+  * //None//
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:You can use this overload to create a transparent version of another color.
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**alpha**
+  * //alpha//
-  * **Type**:Int32
+    * Type:Int32
-  * **Description**:This parameter determines how transparent the color is. An alpha of 0 means it is totally transparent.
+    * Description:This parameter specifies the alpha, or transparent, component of the color.
-**baseColor**
+  * //hue//
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Type:Single
-  * **Description**:This parameter is the color you want to apply the transparency to.
+    * Description:This parameter specifies the hue component of the color.
-[[#Public Methods|Go Back]]
+  * //saturation//
-=== FromHtml(String) ===
+    * Type:Single
-This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
+    * Description:This parameter specifies the saturation component of the color.
-==== Remarks ====
-None
-**Return Value**
+  * //luminance//
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Type:Single
-  * **Description**:This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
+    * Description:This parameter specifies the luminance component of the color.
-==== Parameters ====
+<div newline></div>
-**htmlColor**
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromOle(Int32) **
-  * **Type**:String
-  * **Description**:This parameter represents the HTML color that you want to convert.
-[[#Public Methods|Go Back]]
+  * //This method returns a GeoColor from an OLE color.//
-=== FromOle(Int32) ===
+== Remarks ==
-This method returns a GeoColor from an OLE color.
+  * //None//
-==== Remarks ====
-None
-**Return Value**
+== Return Value ==
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:This method returns a GeoColor from an OLE color.
+  * Description:This method returns a GeoColor from an OLE color.
-==== Parameters ====
+== Parameters ==
-**oleColor**
+  * //oleColor//
-  * **Type**:Int32
+    * Type:Int32
-  * **Description**:This parameter represents the OLE color you want to convert.
+    * Description:This parameter represents the OLE color you want to convert.
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== FromWin32(Int32) ===
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromHtml(String) **
-This method returns a GeoColor from a Win32 color.
-==== Remarks ====
-None
-**Return Value**
+  * //This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).//
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+== Remarks ==
-  * **Description**:This method returns a GeoColor from a Win32 color.
+  * //None//
-==== Parameters ====
+== Return Value ==
-**win32Color**
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Type**:Int32
+  * Description:This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).
-  * **Description**:This parameter represents the Win32 color you want to convert.
-[[#Public Methods|Go Back]]
+== Parameters ==
-=== GetColorsInHueFamily(GeoColor,Int32) ===
+  * //htmlColor//
-This method returns a collection of GeoColors based on the same hue that is passed in.
+    * Type:String
-==== Remarks ====
+    * Description:This parameter represents the HTML color that you want to convert.
-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**
+<div newline></div>
-  * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetRandomGeoColor(RandomColorType) **
-  * **Description**:This method returns a collection of GeoColors based on the same hue that is passed in.
-==== Parameters ====
+  * //Creates a random GeoColor structure based on the specific ColorType//
-**baseColor**
+== Remarks ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * //N/A//
-  * **Description**:This parameter is the color on which you want to base the color collection.
-**numbersOfColors**
+== Return Value ==
-  * **Type**:Int32
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:This parameter represents the number of colors you want returned from the method.
+  * Description:A GeoColor structure the method created.
-[[#Public Methods|Go Back]]
+== Parameters ==
-=== GetColorsInQualityFamily(GeoColor,Int32) ===
+  * //colorType//
-This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.
+    * Type:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
-==== Remarks ====
+    * Description:A ColorType defines types of color.
-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**
+<div newline></div>
-  * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetRandomGeoColor(Int32,RandomColorType) **
-  * **Description**:This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.
-==== Parameters ====
+  * //Creates a random GeoColor structure//
-**baseColor**
+== Remarks ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * //N/A//
-  * **Description**:This parameter is the color on which you want to base the color collection.
-**numberOfColors**
+== Return Value ==
-  * **Type**:Int32
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:This parameter represents the number of colors you want returned from the method.
+  * Description:A GeoColor structure the method created.
-[[#Public Methods|Go Back]]
+== Parameters ==
-=== GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection) ===
+  * //alpha//
-N/A
+    * Type:Int32
-==== Remarks ====
+    * Description:The alpha component. Valid values are 0 through 255.
-N/A
-**Return Value**
+  * //colorType//
-  * **Return Type**:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
+    * Type:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
-  * **Description**:N/A
+    * Description:A ColorType defines types of color.
-==== Parameters ====
+<div newline></div>
-**fromColor**
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromWin32(Int32) **
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:N/A
-**toColor**
+  * //This method returns a GeoColor from a Win32 color.//
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+== Remarks ==
-  * **Description**:N/A
+  * //None//
-**numberOfColors**
+== Return Value ==
-  * **Type**:Int32
+  * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:N/A
+  * Description:This method returns a GeoColor from a Win32 color.
-**colorWheelDirection**
+== Parameters ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.ColorWheelDirection|ColorWheelDirection]]
+  * //win32Color//
-  * **Description**:N/A
+    * Type:Int32
+    * Description:This parameter represents the Win32 color you want to convert.
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== GetHashCode() ===
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToOle(GeoColor) **
-This method is an override of the GetHashCode functionality.
-==== Remarks ====
-None
-**Return Value**
+  * //This method returns an OLE color from a GeoColor.//
-  * **Return Type**:Int32
+== Remarks ==
-  * **Description**:This method returns the hash code.
+  * //None//
-==== Parameters ====
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Int32
-=== GetRandomGeoColor(RandomColorType) ===
+  * Description:This method returns an OLE color from a GeoColor.
-Creates a random GeoColor structure based on the specific ColorType
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * //color//
-  * **Description**:A GeoColor structure the method created.
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+    * Description:This parameter represents the GeoColor you want to convert.
-==== Parameters ====
+<div newline></div>
-**colorType**
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToHtml(GeoColor) **
-  * **Type**:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
-  * **Description**:A ColorType defines types of color.
-[[#Public Methods|Go Back]]
+  * //This method returns an HTML color from a GeoColor.//
-=== GetRandomGeoColor(Int32,RandomColorType) ===
+== Remarks ==
-Creates a random GeoColor structure
+  * //None//
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * Type:String
-  * **Description**:A GeoColor structure the method created.
+  * Description:This method returns an HTML color from a GeoColor.
-==== Parameters ====
+== Parameters ==
-**alpha**
+  * //color//
-  * **Type**:Int32
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-  * **Description**:The alpha component. Valid values are 0 through 255.
+    * Description:This parameter represents the GeoColor you want to convert.
-**colorType**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.RandomColorType|RandomColorType]]
+** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWin32(GeoColor) **
-  * **Description**:A ColorType defines types of color.
-[[#Public Methods|Go Back]]
+  * //This method returns a Win32 color from a GeoColor.//
-=== GetType() ===
+== Remarks ==
-N/A
+  * //N/A//
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:Type
+  * Type:Int32
-  * **Description**:N/A
+  * Description:This method returns a Win32 color from a GeoColor.
-==== Parameters ====
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //color//
-=== ToHtml(GeoColor) ===
+    * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
-This method returns an HTML color from a GeoColor.
+    * Description:This parameter represents the GeoColor you want to convert.
-==== Remarks ====
-None
-**Return Value**
+<div newline></div>
-  * **Return Type**:String
+==== Protected Methods ====
-  * **Description**:This method returns an HTML color from a GeoColor.
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-==== Parameters ====
+  * //N/A//
-**color**
+== Remarks ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * //N/A//
-  * **Description**:This parameter represents the GeoColor you want to convert.
-[[#Public Methods|Go Back]]
+== Return Value ==
-=== ToOle(GeoColor) ===
+  * Type:Void
-This method returns an OLE color from a GeoColor.
+  * Description:N/A
-==== Remarks ====
-None
-**Return Value**
+== Parameters ==
-  * **Return Type**:Int32
+<div newline></div>
-  * **Description**:This method returns an OLE color from a GeoColor.
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-==== Parameters ====
+  * //N/A//
-**color**
+== Remarks ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+  * //N/A//
-  * **Description**:This parameter represents the GeoColor you want to convert.
-[[#Public Methods|Go Back]]
+== Return Value ==
-=== ToString() ===
+  * Type:Object
-N/A
+  * Description:N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:String
+<div newline></div>
-  * **Description**:N/A
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} IsTransparent **
-==== Parameters ====
+Verify if the GeoColor is transparent, it is considered to be transparent if the Alpha Value is 0.
-[[#Public Methods|Go Back]]
+== Remarks ==
-=== ToWin32(GeoColor) ===
-This method returns a Win32 color from a GeoColor.
-==== Remarks ====
 N/A
+== Return Value ==
+  * Type:Boolean
-**Return Value**
+** {{wiki:PublicProperty.gif|}} AlphaComponent **
-  * **Return Type**:Int32
-  * **Description**:This method returns a Win32 color from a GeoColor.
-==== Parameters ====
+This property returns the alpha component of the GeoColor.
-**color**
+== Remarks ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
+None
-  * **Description**:This parameter represents the GeoColor you want to convert.
+== Return Value ==
+  * Type:Byte
-[[#Public Methods|Go Back]]
+** {{wiki:PublicProperty.gif|}} RedComponent **
-===== Protected Methods =====
-=== Finalize() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+This property returns the red component of the GeoColor.
-  * **Return Type**:Void
+== Remarks ==
-  * **Description**:N/A
+None
+== Return Value ==
+  * Type:Byte
-==== Parameters ====
+** {{wiki:PublicProperty.gif|}} GreenComponent **
-[[#Protected Methods|Go Back]]
-=== MemberwiseClone() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+This property returns the green component of the GeoColor.
-  * **Return Type**:Object
+== Remarks ==
-  * **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 Value ==
-**Return Type**:Byte
+  * Type:Byte
+** {{wiki:PublicProperty.gif|}} BlueComponent **
-[[#Public Properties|Go Back]]
-=== BlueComponent ===
 This property returns the blue component of the GeoColor.
-==== Remarks ====
+== Remarks ==
 None
-==== Return Value ====
+== Return Value ==
-**Return Type**:Byte
+  * Type:Byte
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} Hue **
-=== 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 ====
+== Remarks ==
 None
-==== Return Value ====
+== Return Value ==
-**Return Type**:Single
+  * Type:Single
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} Saturation **
-=== 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]]
+This property returns the saturation component of the GeoColor.
-=== Luminance ===
+== Remarks ==
-This property returns the luminance component of the GeoColor.
-==== Remarks ====
 None
-==== Return Value ====
+== Return Value ==
-**Return Type**:Single
+  * Type:Single
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} Luminance **
-=== RedComponent ===
-This property returns the red component of the GeoColor.
-==== Remarks ====
-None
-==== Return Value ====
-**Return Type**:Byte
-[[#Public Properties|Go Back]]
+This property returns the luminance component of the GeoColor.
-=== Saturation ===
+== Remarks ==
-This property returns the saturation component of the GeoColor.
-==== Remarks ====
 None
-==== Return Value ====
+== Return Value ==
-**Return Type**:Single
+  * Type:Single
-[[#Public Properties|Go Back]]
+==== Protected Properties ====
-===== Protected Properties =====
+==== Public Events ====
-===== Public Events =====

User Tools

Site Tools

Differences

Page Tools