UIColor UIColor Class

Definition

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, IDisposable
type 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(CGColor)

Creates a new UIColor from the specified CGColor.

UIColor(CIColor) UIColor(CIColor)

Creates a new UIColor from the specified CIColor.

UIColor(IntPtr) UIColor(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

UIColor(nfloat, nfloat) UIColor(nfloat, nfloat)

Creates a new color with the grayscale value in white and the opacity value in alpha.

UIColor(nfloat, nfloat, nfloat, nfloat) UIColor(nfloat, nfloat, nfloat, nfloat)

UIColor constructor from red, green, blue and alpha components.

UIColor(NSCoder) UIColor(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

UIColor(NSObjectFlag) UIColor(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

UIColor(UIImage) UIColor(UIImage)

Creates a new "color" that fills its area with the provide pattern image.

Properties

Black Black

A color with grayscale 0.0 and alpha 1.0.

Blue Blue

A color with RGBA of (0,0,1,1).

Brown Brown

A color with RGBA of (0.6, 0.4, 0.2, 1.0).

CGColor CGColor

Returns the CoreGraphics CGColor for this UIColor.

CIColor CIColor

Gets a CIColor representation of the color.

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

Clear Clear

A color with grayscale 0 and alpha 0.

Cyan Cyan

A color with RGBA of (0, 1, 1, 1).

DarkGray DarkGray

A color with grayscale 1/3 and alpha 1.

DarkTextColor DarkTextColor

The system color for displaying text on a light background.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Gray Gray

A color object with grayscale 0.5 and alpha 1.0.

Green Green

A color with RGBA of (0,1,0,1).

GroupTableViewBackgroundColor GroupTableViewBackgroundColor

The operating system color used for the background in groupped UITableViews.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
LightGray LightGray

A color with grayscale 2/3 and alpha 1.

LightTextColor LightTextColor

The operating system color used for displaying text on a dark background.

Magenta Magenta

A color with RGBA of (1,0,1,1).

Orange Orange

A color with RGBA of (1.0, 0.5, 0.0, 1.0).

Purple Purple

A color with RGBA of (0.5, 0.0, 0.5, 1.0).

ReadableTypeIdentifiers ReadableTypeIdentifiers

Gets an array of Uniform Type Identifiers (UTIs) that describe the types from which this class can be converted.

Red Red

A color with RGBA of (1,0,0,1).

RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
ScrollViewTexturedBackgroundColor ScrollViewTexturedBackgroundColor

Developers should not use this deprecated property, that renders the area behind scrollable content.

Self Self Inherited from NSObject
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
UnderPageBackgroundColor UnderPageBackgroundColor

Developers should not use this deprecated method, indicating the color used to render the background of a page.

ViewFlipsideBackgroundColor ViewFlipsideBackgroundColor

Developers should not use this deprecated property, that specifies the back of pages during a flip transition.

White White

A color with grayscale 1 and alpha 1.

WritableTypeIdentifiers WritableTypeIdentifiers

Gets the array of uniform type identifiers that specify which data types can be loaded into a color.

WritableTypeIdentifiersForItemProvider WritableTypeIdentifiersForItemProvider

Gets the array of uniform type identifiers that specify which data types can be loaded into a color.

Yellow Yellow

A color with RGBA of (1, 1, 0, 1).

Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) 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) 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>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
ColorWithAlpha(nfloat) ColorWithAlpha(nfloat)

Creates a new color with the specified alpha channel from a reference color.

CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone) Copy(NSZone)

Performs a copy of the underlying Objective-C object.

DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder) EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
FromCGColor(CGColor) FromCGColor(CGColor)

Creates a UIColor based on the Core Graphics Quartz color reference.

FromCIColor(CIColor) FromCIColor(CIColor)

Creates a UIColor from a CoreImage CIColor.

FromDisplayP3(nfloat, nfloat, nfloat, nfloat) FromDisplayP3(nfloat, nfloat, nfloat, nfloat)

Creates a new color from the specified values in the P3 color space.

FromHSB(nfloat, nfloat, nfloat) FromHSB(nfloat, nfloat, nfloat)

Creates a color from using the hue, saturation and brightness components.

FromHSBA(nfloat, nfloat, nfloat, nfloat) FromHSBA(nfloat, nfloat, nfloat, nfloat)

Creates a color from using the hue, saturation, brightness and alpha components.

FromName(String) 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) 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) 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) FromRGB(Byte, Byte, Byte)

Creates a solid color using the red, green and blue components specified.

FromRGB(Int32, Int32, Int32) FromRGB(Int32, Int32, Int32)

Creates a color from the specified combinated of red, green, and blue components.

FromRGB(nfloat, nfloat, nfloat) FromRGB(nfloat, nfloat, nfloat)

Creates a solid color using the red, green and blue components specified.

FromRGBA(Byte, Byte, Byte, Byte) 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) 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) FromRGBA(nfloat, nfloat, nfloat, nfloat)

Creates a color with the specified alpha transparency using the red, green and blue components specified.

FromWhiteAlpha(nfloat, nfloat) FromWhiteAlpha(nfloat, nfloat)

Creates a grayscale color, based on the current colorspace.

GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetHSBA(nfloat, nfloat, nfloat, nfloat) GetHSBA(nfloat, nfloat, nfloat, nfloat)

Returns the hue, saturation, brightness and alpha components of the color.

GetItemProviderVisibilityForTypeIdentifier(String) GetItemProviderVisibilityForTypeIdentifier(String)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetObject(NSData, String, NSError) GetObject(NSData, String, NSError)
GetRGBA(nfloat, nfloat, nfloat, nfloat) GetRGBA(nfloat, nfloat, nfloat, nfloat)

Returns the red, green, blue and alpha components of this color.

GetWhite(nfloat, nfloat) GetWhite(nfloat, nfloat)

The grayscale components of the color.

Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
LoadData(String, Action<NSData,NSError>) LoadData(String, Action<NSData,NSError>)

Loads data for the identified type from an item provider.

LoadDataAsync(String) LoadDataAsync(String)

Asynchronously loads data for the identified type from an item provider, returning a task that contains the data.

LoadDataAsync(String, NSProgress) 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 result.

MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) 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) 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) 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) 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) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetColor() SetColor()

Sets both the fill and stroke color for drawing.

SetFill() SetFill()

Sets the fill color for drawing.

SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetStroke() SetStroke()

Sets the stroke color for drawing.

SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) 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) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) 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) 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) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

GetItemProviderVisibilityForTypeIdentifier(INSItemProviderWriting, String) GetItemProviderVisibilityForTypeIdentifier(INSItemProviderWriting, String)
GetWritableTypeIdentifiersForItemProvider(INSItemProviderWriting) GetWritableTypeIdentifiersForItemProvider(INSItemProviderWriting)
LoadDataAsync(INSItemProviderWriting, String) LoadDataAsync(INSItemProviderWriting, String)
LoadDataAsync(INSItemProviderWriting, String, NSProgress) LoadDataAsync(INSItemProviderWriting, String, NSProgress)
GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also