Share via


NSGradient Constructors

Definition

Overloads

Name Description
NSGradient()

Creates a new NSGradient with default values.

NSGradient(NSColor[])
NSGradient(NSCoder)

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

NSGradient(NSObjectFlag)

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

NSGradient(NativeHandle)

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

NSGradient(NSColor, NSColor)
NSGradient(NSColor[], Double[])

Create a new NSGradient instance with the specified colors and color locations.

NSGradient(NSColor[], NFloat[])

Create a new NSGradient instance with the specified colors and color locations.

NSGradient(NSColor[], Single[])

Create a new NSGradient instance with the specified colors and color locations.

NSGradient(NSColor[], Double[], NSColorSpace)

Create a new NSGradient instance with the specified colors and color locations.

NSGradient(NSColor[], NFloat[], NSColorSpace)

Create a new NSGradient instance with the specified colors and color locations.

NSGradient(NSColor[], Single[], NSColorSpace)

Create a new NSGradient instance with the specified colors and color locations.

NSGradient()

Creates a new NSGradient with default values.

[Foundation.Export("init")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSGradient();
Attributes

Applies to

NSGradient(NSColor[])

[Foundation.Export("initWithColors:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSGradient(AppKit.NSColor[] colorArray);
[<Foundation.Export("initWithColors:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new AppKit.NSGradient : AppKit.NSColor[] -> AppKit.NSGradient

Parameters

colorArray
NSColor[]
Attributes

Applies to

NSGradient(NSCoder)

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

[Foundation.Export("initWithCoder:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
[ObjCRuntime.DesignatedInitializer]
public NSGradient(Foundation.NSCoder coder);
[<Foundation.Export("initWithCoder:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
[<ObjCRuntime.DesignatedInitializer>]
new AppKit.NSGradient : Foundation.NSCoder -> AppKit.NSGradient

Parameters

coder
NSCoder

The unarchiver object.

Attributes

Remarks

This constructor is provided to allow the class to be initialized from an unarchiver (for example, during NIB deserialization). This is part of the NSCoding protocol.

If developers want to create a subclass of this object and continue to support deserialization from an archive, they should implement a constructor with an identical signature: taking a single parameter of type NSCoder and decorate it with the [Export("initWithCoder:"] attribute.

The state of this object can also be serialized by using the EncodeTo(NSCoder) companion method.

Applies to

NSGradient(NSObjectFlag)

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

[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
protected NSGradient(Foundation.NSObjectFlag t);
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new AppKit.NSGradient : Foundation.NSObjectFlag -> AppKit.NSGradient

Parameters

t
NSObjectFlag

Unused sentinel value, pass NSObjectFlag.Empty.

Attributes

Remarks

This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject. This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object. When developers invoke this constructor, they take advantage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together. The actual initialization of the object is up to the developer.

This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place. Once the allocation has taken place, the constructor has to initialize the object. With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.

It is the developer's responsibility to completely initialize the object if they chain up using this constructor chain.

In general, if the developer's constructor invokes the corresponding base implementation, then it should also call an Objective-C init method. If this is not the case, developers should instead chain to the proper constructor in their class.

The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration. Typically the chaining would look like this:

//
// The NSObjectFlag constructor merely allocates the object and registers the C# class with the Objective-C runtime if necessary.
// No actual initXxx method is invoked, that is done later in the constructor
//
// This is taken from the iOS SDK's source code for the UIView class:
//
[Export ("initWithFrame:")]
public UIView (CGRect frame) : base (NSObjectFlag.Empty)
{
    // Invoke the init method now.
    var initWithFrame = new Selector ("initWithFrame:").Handle;
    if (IsDirectBinding) {
        Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSend_CGRect (this.Handle, initWithFrame, frame);
    } else {
        Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_CGRect (this.SuperHandle, initWithFrame, frame);
    }
}

Applies to

NSGradient(NativeHandle)

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

[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
protected internal NSGradient(ObjCRuntime.NativeHandle handle);
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new AppKit.NSGradient : ObjCRuntime.NativeHandle -> AppKit.NSGradient

Parameters

handle
NativeHandle

Pointer (handle) to the unmanaged object.

Attributes

Remarks

This constructor is invoked by the runtime infrastructure (GetNSObject(IntPtr)) to create a new managed representation for a pointer to an unmanaged Objective-C object. Developers should not invoke this method directly, instead they should call GetNSObject(IntPtr) as it will prevent two instances of a managed object pointing to the same native object.

Applies to

NSGradient(NSColor, NSColor)

[Foundation.Export("initWithStartingColor:endingColor:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSGradient(AppKit.NSColor startingColor, AppKit.NSColor endingColor);
[<Foundation.Export("initWithStartingColor:endingColor:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new AppKit.NSGradient : AppKit.NSColor * AppKit.NSColor -> AppKit.NSGradient

Parameters

startingColor
NSColor
endingColor
NSColor
Attributes

Applies to

NSGradient(NSColor[], Double[])

Create a new NSGradient instance with the specified colors and color locations.

public NSGradient(AppKit.NSColor[] colors, double[] locations);
new AppKit.NSGradient : AppKit.NSColor[] * double[] -> AppKit.NSGradient

Parameters

colors
NSColor[]

The colors for the new gradient.

locations
Double[]

The locations for each color in the new gradient. Each location must be a value between 0.0 and 1.0.

Remarks

This gradient is created in the GenericRGBColorSpace generic RGB color space.

Applies to

NSGradient(NSColor[], NFloat[])

Create a new NSGradient instance with the specified colors and color locations.

public NSGradient(AppKit.NSColor[] colors, System.Runtime.InteropServices.NFloat[] locations);
new AppKit.NSGradient : AppKit.NSColor[] * System.Runtime.InteropServices.NFloat[] -> AppKit.NSGradient

Parameters

colors
NSColor[]

The colors for the new gradient.

locations
NFloat[]

The locations for each color in the new gradient. Each location must be a value between 0.0 and 1.0.

Remarks

This gradient is created in the GenericRGBColorSpace generic RGB color space.

Applies to

NSGradient(NSColor[], Single[])

Create a new NSGradient instance with the specified colors and color locations.

public NSGradient(AppKit.NSColor[] colors, float[] locations);
new AppKit.NSGradient : AppKit.NSColor[] * single[] -> AppKit.NSGradient

Parameters

colors
NSColor[]

The colors for the new gradient.

locations
Single[]

The locations for each color in the new gradient. Each location must be a value between 0.0 and 1.0.

Remarks

This gradient is created in the GenericRGBColorSpace generic RGB color space.

Applies to

NSGradient(NSColor[], Double[], NSColorSpace)

Create a new NSGradient instance with the specified colors and color locations.

public NSGradient(AppKit.NSColor[] colors, double[] locations, AppKit.NSColorSpace colorSpace);
new AppKit.NSGradient : AppKit.NSColor[] * double[] * AppKit.NSColorSpace -> AppKit.NSGradient

Parameters

colors
NSColor[]

The colors for the new gradient.

locations
Double[]

The locations for each color in the new gradient. Each location must be a value between 0.0 and 1.0.

colorSpace
NSColorSpace

The color space for the new gradient.

Applies to

NSGradient(NSColor[], NFloat[], NSColorSpace)

Create a new NSGradient instance with the specified colors and color locations.

public NSGradient(AppKit.NSColor[] colors, System.Runtime.InteropServices.NFloat[] locations, AppKit.NSColorSpace colorSpace);
new AppKit.NSGradient : AppKit.NSColor[] * System.Runtime.InteropServices.NFloat[] * AppKit.NSColorSpace -> AppKit.NSGradient

Parameters

colors
NSColor[]

The colors for the new gradient.

locations
NFloat[]

The locations for each color in the new gradient. Each location must be a value between 0.0 and 1.0.

colorSpace
NSColorSpace

The color space for the new gradient.

Applies to

NSGradient(NSColor[], Single[], NSColorSpace)

Create a new NSGradient instance with the specified colors and color locations.

public NSGradient(AppKit.NSColor[] colors, float[] locations, AppKit.NSColorSpace colorSpace);
new AppKit.NSGradient : AppKit.NSColor[] * single[] * AppKit.NSColorSpace -> AppKit.NSGradient

Parameters

colors
NSColor[]

The colors for the new gradient.

locations
Single[]

The locations for each color in the new gradient. Each location must be a value between 0.0 and 1.0.

colorSpace
NSColorSpace

The color space for the new gradient.

Applies to