Differences

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

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

User Tools

Site Tools

Differences

Page Tools