This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.geocolor [2015/09/18 05:42] admin |
thinkgeo.mapsuite.core.geocolor [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.GeoColor ====== | ====== ThinkGeo.MapSuite.Core.GeoColor ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This structure represents a color for drawing on a GeoCanvas. | This structure represents a color for drawing on a GeoCanvas. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} GeoColor(Int32,Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}} GeoColor(Int32,Int32,Int32) ** | ||
| - | This constructor creates a new color. | + | * //This constructor creates a new color.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //red// | * //red// | ||
| Line 28: | Line 31: | ||
| ** {{wiki:PublicMethod.gif|}} GeoColor(Int32,Int32,Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}} GeoColor(Int32,Int32,Int32,Int32) ** | ||
| - | This constructor creates a new color. | + | * //This constructor creates a new color.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| * //alpha// | * //alpha// | ||
| Line 51: | Line 54: | ||
| ** {{wiki:PublicMethod.gif|}} GeoColor(Int32,GeoColor) ** | ** {{wiki:PublicMethod.gif|}} GeoColor(Int32,GeoColor) ** | ||
| - | This constructor creates a new color. | + | * //This constructor creates a new color.// |
| == Remarks == | == Remarks == | ||
| - | You can use this overload to create a transparent version of another color. | + | * //You can use this overload to create a transparent version of another color.// |
| == Parameters == | == Parameters == | ||
| * //alpha// | * //alpha// | ||
| Line 67: | Line 70: | ||
| ** {{wiki:ProtectedMethod.gif|}} GeoColor(String,ColorType,Int32,Int32,Int32,Int32) ** | ** {{wiki:ProtectedMethod.gif|}} GeoColor(String,ColorType,Int32,Int32,Int32,Int32) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Parameters == | == Parameters == | ||
| * //name// | * //name// | ||
| Line 99: | Line 102: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | This method is an override of the Equals functionality. | + | * //This method is an override of the Equals functionality.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 115: | Line 118: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | This method is an override of the GetHashCode functionality. | + | * //This method is an override of the GetHashCode functionality.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 127: | Line 130: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 139: | Line 142: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 151: | Line 154: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInHueFamily(GeoColor,Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInHueFamily(GeoColor,Int32) ** | ||
| - | This method returns a collection of GeoColors based on the same hue that is passed in. | + | * //This method returns a collection of GeoColors based on the same hue that is passed in.// |
| == Remarks == | == 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. | + | * //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 Value == | ||
| Line 171: | Line 174: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInQualityFamily(GeoColor,Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInQualityFamily(GeoColor,Int32) ** | ||
| - | This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in. | + | * //This method returns a collection of GeoColors based on the same quality (luminosity and saturation) that is passed in.// |
| == Remarks == | == 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. | + | * //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 Value == | ||
| Line 191: | Line 194: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetColorsInQualityFamily(GeoColor,GeoColor,Int32,ColorWheelDirection) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 219: | Line 222: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromArgb(Int32,Int32,Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromArgb(Int32,Int32,Int32,Int32) ** | ||
| - | This method returns a GeoColor based on the Alpha, Red, Green, and Blue components. | + | * //This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 247: | Line 250: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromArgb(Int32,GeoColor) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromArgb(Int32,GeoColor) ** | ||
| - | This method returns a GeoColor based on the Alpha, Red, Green, and Blue components. | + | * //This method returns a GeoColor based on the Alpha, Red, Green, and Blue components.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 267: | Line 270: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromAhsl(Int32,Single,Single,Single) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} 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. | + | * //This parameter specifies the red component of the color. This method returns a GeoColor based on the Alpha, Hue, Saturation, and Luminosity components.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 295: | Line 298: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromOle(Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromOle(Int32) ** | ||
| - | This method returns a GeoColor from an OLE color. | + | * //This method returns a GeoColor from an OLE color.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 311: | Line 314: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromHtml(String) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromHtml(String) ** | ||
| - | This method returns a GeoColor from an HTML color (either in hexadecimal or a named color). | + | * //This method returns a GeoColor from an HTML color (either in hexadecimal or a named color).// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 327: | Line 330: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetRandomGeoColor(RandomColorType) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetRandomGeoColor(RandomColorType) ** | ||
| - | Creates a random GeoColor structure based on the specific ColorType | + | * //Creates a random GeoColor structure based on the specific ColorType// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 343: | Line 346: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetRandomGeoColor(Int32,RandomColorType) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} GetRandomGeoColor(Int32,RandomColorType) ** | ||
| - | Creates a random GeoColor structure | + | * //Creates a random GeoColor structure// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 363: | Line 366: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromWin32(Int32) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} FromWin32(Int32) ** | ||
| - | This method returns a GeoColor from a Win32 color. | + | * //This method returns a GeoColor from a Win32 color.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 379: | Line 382: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToOle(GeoColor) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToOle(GeoColor) ** | ||
| - | This method returns an OLE color from a GeoColor. | + | * //This method returns an OLE color from a GeoColor.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 395: | Line 398: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToHtml(GeoColor) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToHtml(GeoColor) ** | ||
| - | This method returns an HTML color from a GeoColor. | + | * //This method returns an HTML color from a GeoColor.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 411: | Line 414: | ||
| ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWin32(GeoColor) ** | ** {{wiki:PublicMethod.gif|}}{{wiki:Static.gif|}} ToWin32(GeoColor) ** | ||
| - | This method returns a Win32 color from a GeoColor. | + | * //This method returns a Win32 color from a GeoColor.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 428: | Line 431: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 440: | Line 443: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||