UIColor Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Colors and Patterns as used in MonoTouch.UIKit.
[Foundation.Register("UIColor", true)]
public class UIColor : Foundation.NSObject, Foundation.INSCopying, Foundation.INSItemProviderReading, Foundation.INSItemProviderWriting, Foundation.INSSecureCoding, IDisposabletype UIColor = class
inherit NSObject
interface INSCoding
interface INativeObject
interface IDisposable
interface INSCopying
interface INSItemProviderReading
interface INSItemProviderWriting
interface INSSecureCoding- Inheritance
- Attributes
- Implements
Remarks
Basic representation for colors in UIKit. UIColors can be created from various color representations as well as encoding an alpha transparency channel. In addition to solid or transparent colors, it is possible to create a UIColor instance from an image, and use the resulting UIColor as a brush whenever a UIKit UIColor is used.
In addition to providing various constructors and some common colors, the following colors represent system colors: LightTextColor, DarkTextColor, GroupTableViewBackgroundColor, ViewFlipsideBackgroundColor, ScrollViewTexturedBackgroundColor and UnderPageBackgroundColor.
The members of this class can be used from a background thread.
Constructors
| UIColor(CGColor) | |
| UIColor(CIColor) | |
| UIColor(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| UIColor(nfloat, nfloat) |
Creates a new color with the grayscale value in |
| UIColor(nfloat, nfloat, nfloat, nfloat) |
UIColor constructor from red, green, blue and alpha components. |
| UIColor(NSCoder) |
A constructor that initializes the object from the data stored in the unarchiver object. |
| UIColor(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
| UIColor(UIImage) |
Creates a new "color" that fills its area with the provide pattern image. |
Properties
| Black |
A color with grayscale 0.0 and alpha 1.0. |
| Blue |
A color with RGBA of (0,0,1,1). |
| Brown |
A color with RGBA of (0.6, 0.4, 0.2, 1.0). |
| CGColor |
Returns the CoreGraphics CGColor for this UIColor. |
| CIColor |
Gets a CIColor representation of the color. |
| Class | (Inherited from NSObject) |
| ClassHandle |
The handle for this class. |
| Clear |
A color with grayscale 0 and alpha 0. |
| Cyan |
A color with RGBA of (0, 1, 1, 1). |
| DarkGray |
A color with grayscale 1/3 and alpha 1. |
| DarkTextColor |
The system color for displaying text on a light background. |
| DebugDescription |
A developer-meaningful description of this object. (Inherited from NSObject) |
| Description |
Description of the object, the Objective-C version of ToString. (Inherited from NSObject) |
| Gray |
A color object with grayscale 0.5 and alpha 1.0. |
| Green |
A color with RGBA of (0,1,0,1). |
| GroupTableViewBackgroundColor |
The operating system color used for the background in groupped UITableViews. |
| Handle |
Handle (pointer) to the unmanaged object representation. (Inherited from NSObject) |
| IsDirectBinding | (Inherited from NSObject) |
| IsProxy | (Inherited from NSObject) |
| LightGray |
A color with grayscale 2/3 and alpha 1. |
| LightTextColor |
The operating system color used for displaying text on a dark background. |
| Magenta |
A color with RGBA of (1,0,1,1). |
| Orange |
A color with RGBA of (1.0, 0.5, 0.0, 1.0). |
| Purple |
A color with RGBA of (0.5, 0.0, 0.5, 1.0). |
| ReadableTypeIdentifiers |
Gets an array of Uniform Type Identifiers (UTIs) that describe the types from which this class can be converted. |
| Red |
A color with RGBA of (1,0,0,1). |
| RetainCount |
Returns the current Objective-C retain count for the object. (Inherited from NSObject) |
| ScrollViewTexturedBackgroundColor |
Developers should not use this deprecated property, that renders the area behind scrollable content. |
| Self | (Inherited from NSObject) |
| Superclass | (Inherited from NSObject) |
| SuperHandle |
Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject) |
| UnderPageBackgroundColor |
Developers should not use this deprecated method, indicating the color used to render the background of a page. |
| ViewFlipsideBackgroundColor |
Developers should not use this deprecated property, that specifies the back of pages during a flip transition. |
| White |
A color with grayscale 1 and alpha 1. |
| WritableTypeIdentifiers |
Gets the array of uniform type identifiers that specify which data types can be loaded into a color. |
| WritableTypeIdentifiersForItemProvider |
Gets the array of uniform type identifiers that specify which data types can be loaded into a color. |
| Yellow |
A color with RGBA of (1, 1, 0, 1). |
| Zone | (Inherited from NSObject) |
Methods
| AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) |
Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject) |
| AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) |
Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject) |
| AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) |
Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject) |
| AwakeFromNib() |
Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject) |
| BeginInvokeOnMainThread(Action) | (Inherited from NSObject) |
| BeginInvokeOnMainThread(Selector, NSObject) |
Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject) |
| Bind(NSString, NSObject, String, NSDictionary) | (Inherited from NSObject) |
| Bind(String, NSObject, String, NSDictionary) |
Obsolete.
(Inherited from NSObject)
|
| BindingInfo(String) |
Obsolete.
(Inherited from NSObject)
|
| BindingOptionDescriptions(String) |
Obsolete.
(Inherited from NSObject)
|
| BindingValueClass(String) |
Obsolete.
(Inherited from NSObject)
|
| ColorWithAlpha(nfloat) |
Creates a new color with the specified alpha channel from a reference color. |
| CommitEditing() | (Inherited from NSObject) |
| CommitEditing(NSObject, Selector, IntPtr) | (Inherited from NSObject) |
| ConformsToProtocol(IntPtr) |
Invoked to determine if this object implements the specified protocol. (Inherited from NSObject) |
| Copy() |
Performs a copy of the underlying Objective-C object. (Inherited from NSObject) |
| Copy(NSZone) |
Performs a copy of the underlying Objective-C object. |
| DangerousAutorelease() | (Inherited from NSObject) |
| DangerousRelease() | (Inherited from NSObject) |
| DangerousRetain() | (Inherited from NSObject) |
| DidChange(NSKeyValueChange, NSIndexSet, NSString) |
Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject) |
| DidChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| DidChangeValue(String) |
Indicates that a change occurred on the specified key. (Inherited from NSObject) |
| Dispose() |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| Dispose(Boolean) |
Releases the resources used by the NSObject object. (Inherited from NSObject) |
| DoesNotRecognizeSelector(Selector) |
Indicates that this object does not recognize the specified selector. (Inherited from NSObject) |
| EncodeTo(NSCoder) |
Encodes the state of the object on the provided encoder |
| Equals(NSObject) | (Inherited from NSObject) |
| Equals(Object) | (Inherited from NSObject) |
| ExposedBindings() | (Inherited from NSObject) |
| FromCGColor(CGColor) |
Creates a UIColor based on the Core Graphics Quartz color reference. |
| FromCIColor(CIColor) |
Creates a UIColor from a CoreImage CIColor. |
| FromDisplayP3(nfloat, nfloat, nfloat, nfloat) |
Creates a new color from the specified values in the P3 color space. |
| FromHSB(nfloat, nfloat, nfloat) |
Creates a color from using the hue, saturation and brightness components. |
| FromHSBA(nfloat, nfloat, nfloat, nfloat) |
Creates a color from using the hue, saturation, brightness and alpha components. |
| FromName(String) |
Creates and returns a new color object from the asset with the specified name, with the gamut in the specified asset. |
| FromName(String, NSBundle, UITraitCollection) |
Creates and returns a new color object from the asset with the specified name in the specified bundle, with the gamut in the specified trait collection. |
| FromPatternImage(UIImage) |
Creates a UIColor based on an image, the color can then be used as a brush to paint with the image. |
| FromRGB(Byte, Byte, Byte) |
Creates a solid color using the red, green and blue components specified. |
| FromRGB(Int32, Int32, Int32) |
Creates a color from the specified combinated of red, green, and blue components. |
| FromRGB(nfloat, nfloat, nfloat) |
Creates a solid color using the red, green and blue components specified. |
| FromRGBA(Byte, Byte, Byte, Byte) |
Creates a color with the specified alpha transparency using the red, green and blue components specified. |
| FromRGBA(Int32, Int32, Int32, Int32) |
Creates a color from the specified combination of red, green, and blue elements, with the specified transparency. |
| FromRGBA(nfloat, nfloat, nfloat, nfloat) |
Creates a color with the specified alpha transparency using the red, green and blue components specified. |
| FromWhiteAlpha(nfloat, nfloat) |
Creates a grayscale color, based on the current colorspace. |
| GetBindingInfo(NSString) | (Inherited from NSObject) |
| GetBindingOptionDescriptions(NSString) | (Inherited from NSObject) |
| GetBindingValueClass(NSString) | (Inherited from NSObject) |
| GetDictionaryOfValuesFromKeys(NSString[]) |
Retrieves the values of the specified keys. (Inherited from NSObject) |
| GetHashCode() |
Generates a hash code for the current instance. (Inherited from NSObject) |
| GetHSBA(nfloat, nfloat, nfloat, nfloat) |
Returns the hue, saturation, brightness and alpha components of the color. |
| GetItemProviderVisibilityForTypeIdentifier(String) | |
| GetMethodForSelector(Selector) | (Inherited from NSObject) |
| GetNativeField(String) |
Obsolete.
(Inherited from NSObject)
|
| GetNativeHash() | (Inherited from NSObject) |
| GetObject(NSData, String, NSError) | |
| GetRGBA(nfloat, nfloat, nfloat, nfloat) |
Returns the red, green, blue and alpha components of this color. |
| GetWhite(nfloat, nfloat) |
The grayscale components of the color. |
| Init() | (Inherited from NSObject) |
| InitializeHandle(IntPtr) | (Inherited from NSObject) |
| InitializeHandle(IntPtr, String) | (Inherited from NSObject) |
| Invoke(Action, Double) | (Inherited from NSObject) |
| Invoke(Action, TimeSpan) | (Inherited from NSObject) |
| InvokeOnMainThread(Action) | (Inherited from NSObject) |
| InvokeOnMainThread(Selector, NSObject) |
Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject) |
| IsEqual(NSObject) | (Inherited from NSObject) |
| IsKindOfClass(Class) | (Inherited from NSObject) |
| IsMemberOfClass(Class) | (Inherited from NSObject) |
| LoadData(String, Action<NSData,NSError>) |
Loads data for the identified type from an item provider. |
| LoadDataAsync(String) |
Asynchronously loads data for the identified type from an item provider, returning a task that contains the data. |
| LoadDataAsync(String, NSProgress) |
Asynchronously loads data for the identified type from an item provider, returning a task that contains the data, and updating progress in |
| MarkDirty() |
Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject) |
| MutableCopy() |
Creates a mutable copy of the specified NSObject. (Inherited from NSObject) |
| ObjectDidEndEditing(NSObject) | (Inherited from NSObject) |
| ObserveValue(NSString, NSObject, NSDictionary, IntPtr) |
Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject) |
| PerformSelector(Selector) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, Double) |
Invokes the selector on the current instance and if the |
| PerformSelector(Selector, NSObject, Double, NSString[]) | (Inherited from NSObject) |
| PerformSelector(Selector, NSObject, NSObject) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean) | (Inherited from NSObject) |
| PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) | (Inherited from NSObject) |
| PrepareForInterfaceBuilder() | (Inherited from NSObject) |
| RemoveObserver(NSObject, NSString) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject) |
| RemoveObserver(NSObject, NSString, IntPtr) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject) |
| RemoveObserver(NSObject, String) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject) |
| RemoveObserver(NSObject, String, IntPtr) |
Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject) |
| RespondsToSelector(Selector) |
Whether this object recognizes the specified selector. (Inherited from NSObject) |
| SetColor() |
Sets both the fill and stroke color for drawing. |
| SetFill() |
Sets the fill color for drawing. |
| SetNativeField(String, NSObject) |
Obsolete.
(Inherited from NSObject)
|
| SetNilValueForKey(NSString) |
Sets the value of the specified key to null. (Inherited from NSObject) |
| SetStroke() |
Sets the stroke color for drawing. |
| SetValueForKey(NSObject, NSString) |
Sets the value of the property specified by the key to the specified value. (Inherited from NSObject) |
| SetValueForKeyPath(IntPtr, NSString) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject) |
| SetValueForKeyPath(NSObject, NSString) |
Sets the value of a property that can be reached using a keypath. (Inherited from NSObject) |
| SetValueForUndefinedKey(NSObject, NSString) |
Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject) |
| SetValuesForKeysWithDictionary(NSDictionary) |
Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject) |
| ToString() |
Returns a string representation of the value of the current instance. |
| Unbind(NSString) | (Inherited from NSObject) |
| Unbind(String) |
Obsolete.
(Inherited from NSObject)
|
| ValueForKey(NSString) |
Returns the value of the property associated with the specified key. (Inherited from NSObject) |
| ValueForKeyPath(NSString) |
Returns the value of a property that can be reached using a keypath. (Inherited from NSObject) |
| ValueForUndefinedKey(NSString) |
Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject) |
| WillChange(NSKeyValueChange, NSIndexSet, NSString) |
Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject) |
| WillChange(NSString, NSKeyValueSetMutationKind, NSSet) | (Inherited from NSObject) |
| WillChangeValue(String) |
Indicates that the value of the specified key is about to change. (Inherited from NSObject) |
Extension Methods
| GetItemProviderVisibilityForTypeIdentifier(INSItemProviderWriting, String) | |
| GetWritableTypeIdentifiersForItemProvider(INSItemProviderWriting) | |
| LoadDataAsync(INSItemProviderWriting, String) | |
| LoadDataAsync(INSItemProviderWriting, String, NSProgress) | |
| GetDebugDescription(INSObjectProtocol) | |
| GetAccessibilityCustomRotors(NSObject) |
Gets the array of UIAccessibilityCustomRotor objects appropriate for |
| SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) |
Sets the array of UIAccessibilityCustomRotor objects appropriate for |