ShinobiControls Xamarin Bindings Documentation

ShinobiEssentials : Shinobi.Essentials Namespace

SEssentialsFlowLayoutStyle Class

The SEssentialsFlowLayoutStyle defines the look and feel for an instance of the SEssentialsFlowLayout class.

Syntax

[Foundation.Register("SEssentialsFlowLayoutStyle", true)]
public class SEssentialsFlowLayoutStyle : SEssentialsStyle

Remarks

If you wish to configure how your flow layout looks, you should modify the properties on this class.

SEssentialsFlowLayoutStyle derives from SEssentialsStyle, and so it is initialized from a SEssentialsTheme object. The theme provides the default settings for the style.

The following default settings are taken from the theme:

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

Members

See Also: Inherited members from SEssentialsStyle.

Public Constructors

Default constructor.
Instantiates the style with the specified theme.
Initializes the style object with a set of custom icons for the flow layout.
DEPRECATED in ShinobiEssentials v2.1, use SEssentialsFlowLayoutStyle(SEssentialsTheme, SEssentialsFlowLayoutImagesWrapper) instead.

Protected Constructors

Constructor to call on derived classes to skip initialization and merely allocate the object.
A constructor used when creating managed representations of unmanaged objects.

Public Properties

[read-only]
override
ClassHandle IntPtr . The handle for this class.
[read-only]
override
ClassHandle IntPtr . The handle for this class. (Inherited from SEssentialsStyle.)
[read-only]
DeleteImage UIKit.UIImage . The delete image
[read-only]
DeletePressedImage UIKit.UIImage . The delete pressed image
[read-only]
DoneButtonImage UIKit.UIImage . The done button image
[read-only]
DoneButtonPressedImage UIKit.UIImage . The done button pressed image
MainViewTexture UIKit.UIColor . The texture of the view background.
MainViewTintColor UIKit.UIColor . The tint color of the view background.
SelectedScaleFactor nfloat . The amount to scale a view by when it is selected.
Theme SEssentialsTheme . DEPRECATED: We create a style object with a theme, but we no longer hold a persistent reference to it. (Inherited from SEssentialsStyle.)
[read-only]
TrashcanImage UIKit.UIImage . The trash can image
[read-only]
TrashcanMask UIKit.UIImage . The trash can mask image
TrashCanTintColor UIKit.UIColor . The tint color of the FlowLayout trashcan icon.

Public Methods

ApplyTheme (SEssentialsTheme)
Applies the properties of the specified theme to this style object. (Inherited from SEssentialsStyle.)

Protected Methods

override
Dispose (bool)
Releases unmanaged resources.
override
Dispose (bool)
Releases unmanaged resources. (Inherited from SEssentialsStyle.)

Member Details

SEssentialsFlowLayoutStyle Constructor

Default constructor.

Syntax

[Foundation.Export("init")]
[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
public SEssentialsFlowLayoutStyle ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsFlowLayoutStyle Constructor

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

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SEssentialsFlowLayoutStyle (Foundation.NSObjectFlag t)

Parameters

t
Unused sentinel value

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsFlowLayoutStyle Constructor

Instantiates the style with the specified theme.

Syntax

public SEssentialsFlowLayoutStyle (SEssentialsTheme theme)

Parameters

theme
The theme

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsFlowLayoutStyle Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SEssentialsFlowLayoutStyle (IntPtr handle)

Parameters

handle
Handle of the unmanaged object

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsFlowLayoutStyle Constructor

Initializes the style object with a set of custom icons for the flow layout.

Syntax

[Foundation.Export("initWithTheme:customImages:")]
public SEssentialsFlowLayoutStyle (SEssentialsTheme theme, SEssentialsFlowLayoutImagesWrapper customImages)

Parameters

theme
Documentation for this section has not yet been entered.
customImages
Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsFlowLayoutStyle Constructor

Syntax

[Foundation.Export("initWithTheme:trashcanImage:trashcanMask:doneButtonImage:doneButtonPressedImage:deleteImage:deletePressedImage:")]
[System.Obsolete("Use Constructor(SEssentialsTheme, SEssentialsFlowLayoutImagesWrapper) instead", false)]
public SEssentialsFlowLayoutStyle (SEssentialsTheme theme, UIKit.UIImage trashcanImage, UIKit.UIImage trashcanMask, UIKit.UIImage doneButtonImage, UIKit.UIImage doneButtonPressedImage, UIKit.UIImage deleteImage, UIKit.UIImage deletePressedImage)

Parameters

theme
trashcanImage
trashcanMask
doneButtonImage
doneButtonPressedImage
deleteImage
deletePressedImage

Remarks

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

ClassHandle Property

The handle for this class.

Syntax

public override IntPtr ClassHandle { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

DeleteImage Property

The delete image

Syntax

[get: Foundation.Export("deleteImage")]
public virtual UIKit.UIImage DeleteImage { get; }

Value

Documentation for this section has not yet been entered.

Remarks

This is the image which appears on the corner of individual flow elements during edit mode when the SEssentialsFlowLayout is using `SEssentialsFlowDeleteIdiomIcon` delete idiom. This is the image for the default button state.

Has a default image provided by the ShinobiEssentials framework. To override, subclass SEssentialsFlowLayoutStyle.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

DeletePressedImage Property

The delete pressed image

Syntax

[get: Foundation.Export("deletePressedImage")]
public virtual UIKit.UIImage DeletePressedImage { get; }

Value

Documentation for this section has not yet been entered.

Remarks

This is the image which appears on the corner of individual flow elements during edit mode when the SEssentialsFlowLayout is using `SEssentialsFlowDeleteIdiomIcon` delete idiom. This is the image for the pressed button state.

Has a default image provided by the ShinobiEssentials framework. To override, subclass SEssentialsFlowLayoutStyle.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

Dispose Method

Releases unmanaged resources.

Syntax

protected override void Dispose (bool disposing)

Parameters

disposing
True if called by Dispose, false if called from a finalizer

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

DoneButtonImage Property

The done button image

Syntax

[get: Foundation.Export("doneButtonImage")]
public virtual UIKit.UIImage DoneButtonImage { get; }

Value

Documentation for this section has not yet been entered.

Remarks

This is the image which appears to exit edit mode on a SEssentialsFlowLayout when the `SEssentialsFlowDeleteIdiomIcon` delete idiom is used. This is the image for the default state.

Has a default image provided by the ShinobiEssentials framework. To override, subclass SEssentialsFlowLayoutStyle.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

DoneButtonPressedImage Property

The done button pressed image

Syntax

[get: Foundation.Export("doneButtonPressedImage")]
public virtual UIKit.UIImage DoneButtonPressedImage { get; }

Value

Documentation for this section has not yet been entered.

Remarks

This is the image which appears to exit edit mode on a SEssentialsFlowLayout when the `SEssentialsFlowDeleteIdiomIcon` delete idiom is used. This is the image for the pressed state.

Has a default image provided by the ShinobiEssentials framework. To override, subclass SEssentialsFlowLayoutStyle.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

MainViewTexture Property

The texture of the view background.

Syntax

[get: Foundation.Export("mainViewTexture", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setMainViewTexture:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor MainViewTexture { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This defaults to the PrimaryTexture on the theme.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

MainViewTintColor Property

The tint color of the view background.

Syntax

[get: Foundation.Export("mainViewTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setMainViewTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor MainViewTintColor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This defaults to the PrimaryTintColor on the theme.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SelectedScaleFactor Property

The amount to scale a view by when it is selected.

Syntax

[get: Foundation.Export("selectedScaleFactor", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setSelectedScaleFactor:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat SelectedScaleFactor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

A value of 1.0F will not scale the subview. The default value for this property is 1.1F.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

TrashcanImage Property

The trash can image

Syntax

[get: Foundation.Export("trashcanImage")]
public virtual UIKit.UIImage TrashcanImage { get; }

Value

Documentation for this section has not yet been entered.

Remarks

This is the image which appears for flow elements to be dragged to for deletion when the SEssentialsFlowLayout is set to use the SEssentialsFlowDeleteIdiom.TrashCan delete idiom.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom constructor above.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

TrashcanMask Property

The trash can mask image

Syntax

[get: Foundation.Export("trashcanMask")]
public virtual UIKit.UIImage TrashcanMask { get; }

Value

Documentation for this section has not yet been entered.

Remarks

This mask defines where the trashcan will be colored with trashcanTintColor.

Has a default image provided by the ShinobiEssentials framework. To override, use the custom constructor above.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

TrashCanTintColor Property

The tint color of the FlowLayout trashcan icon.

Syntax

[get: Foundation.Export("trashcanTintColor", ObjCRuntime.ArgumentSemantic.Strong)]
[set: Foundation.Export("setTrashcanTintColor:", ObjCRuntime.ArgumentSemantic.Strong)]
public virtual UIKit.UIColor TrashCanTintColor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

This defaults to the TertiaryTintColor on the theme.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4