RateBox  3.0
PaperPlaneTools.Alert Class Reference

Cross-platform alert dialog. Support title, message, 3 buttons More...

Public Types

enum  ButtonType { ButtonType.Positive = 0, ButtonType.Negative = 1, ButtonType.Neutral = 2 }
 

Public Member Functions

 Alert (string title=null, string message=null)
 Initializes a new instance of the PaperPlaneTools.Alert class. More...
 
Alert SetTitle (string title)
 Sets the PaperPlaneTools.Alert.Title. More...
 
Alert SetMessage (string title)
 Sets the PaperPlaneTools.Alert.Message. More...
 
Alert SetPositiveButton (string title, Action handler=null)
 Sets PaperPlaneTools.Alert.PositiveButton. More...
 
Alert SetNegativeButton (string title, Action handler=null)
 Sets PaperPlaneTools.Alert.NegativeButton. More...
 
Alert SetNeutralButton (string title, Action handler=null)
 Sets PaperPlaneTools.Alert.NeutralButton. More...
 
Alert AddOptions (Object opt)
 Adds option to PaperPlaneTools.Alert.Options. More...
 
Alert SetOptions (List< Object > options)
 Set PaperPlaneTools.Alert.Options. More...
 
Alert SetOnDismiss (Action handler)
 Set PaperPlaneTools.Alert.OnDismiss. More...
 
Alert SetAdapter (IAlertPlatformAdapter adaper)
 Set PaperPlaneTools.Alert.Adapter. More...
 
void Show ()
 Add dialog to display queue. More...
 
void Dismiss ()
 Alert can be dismissed while it is presented. Normally you don't call Dismiss function. However, in some cases this function can be useful. For example, Alert that dismissed authomatically after few seconds can be done with help of this function More...
 

Properties

string Title [get]
 Alert title More...
 
string Message [get]
 Alert message More...
 
AlertButton PositiveButton [get]
 Positive button. More...
 
AlertButton NegativeButton [get]
 Negative button. More...
 
AlertButton NeutralButton [get]
 Neutral button. More...
 
List< System.Object > Options [get]
 Platform dependent options that are used by alert adapters. For example, PaperPlaneTools.AlertIOSOptions or PaperPlaneTools.AlertAndroidOptions help clarify behavior of native alerts More...
 
Action OnDismiss [get]
 Dismiss callback is called everytime the dialog is dismissed. More...
 
IAlertPlatformAdapter Adapter [get]
 Allow customize how PaperPlaneTools.Alert is shown. More...
 

Detailed Description

Cross-platform alert dialog. Support title, message, 3 buttons

Member Enumeration Documentation

§ ButtonType

Enumerator
Positive 
Negative 
Neutral 

Constructor & Destructor Documentation

§ Alert()

PaperPlaneTools.Alert.Alert ( string  title = null,
string  message = null 
)

Initializes a new instance of the PaperPlaneTools.Alert class.

Parameters
titleTitle
messageMessage

Member Function Documentation

§ AddOptions()

Alert PaperPlaneTools.Alert.AddOptions ( Object  opt)

§ Dismiss()

void PaperPlaneTools.Alert.Dismiss ( )

Alert can be dismissed while it is presented. Normally you don't call Dismiss function. However, in some cases this function can be useful. For example, Alert that dismissed authomatically after few seconds can be done with help of this function

§ SetAdapter()

Alert PaperPlaneTools.Alert.SetAdapter ( IAlertPlatformAdapter  adaper)

§ SetMessage()

Alert PaperPlaneTools.Alert.SetMessage ( string  title)

§ SetNegativeButton()

Alert PaperPlaneTools.Alert.SetNegativeButton ( string  title,
Action  handler = null 
)

§ SetNeutralButton()

Alert PaperPlaneTools.Alert.SetNeutralButton ( string  title,
Action  handler = null 
)

§ SetOnDismiss()

Alert PaperPlaneTools.Alert.SetOnDismiss ( Action  handler)

§ SetOptions()

Alert PaperPlaneTools.Alert.SetOptions ( List< Object >  options)

§ SetPositiveButton()

Alert PaperPlaneTools.Alert.SetPositiveButton ( string  title,
Action  handler = null 
)

§ SetTitle()

Alert PaperPlaneTools.Alert.SetTitle ( string  title)

§ Show()

void PaperPlaneTools.Alert.Show ( )

Add dialog to display queue.

Property Documentation

§ Adapter

IAlertPlatformAdapter PaperPlaneTools.Alert.Adapter
get

Allow customize how PaperPlaneTools.Alert is shown.

§ Message

string PaperPlaneTools.Alert.Message
get

Alert message

§ NegativeButton

AlertButton PaperPlaneTools.Alert.NegativeButton
get

Negative button.

§ NeutralButton

AlertButton PaperPlaneTools.Alert.NeutralButton
get

Neutral button.

§ OnDismiss

Action PaperPlaneTools.Alert.OnDismiss
get

Dismiss callback is called everytime the dialog is dismissed.

§ Options

List<System.Object> PaperPlaneTools.Alert.Options
get

Platform dependent options that are used by alert adapters. For example, PaperPlaneTools.AlertIOSOptions or PaperPlaneTools.AlertAndroidOptions help clarify behavior of native alerts

§ PositiveButton

AlertButton PaperPlaneTools.Alert.PositiveButton
get

Positive button.

§ Title

string PaperPlaneTools.Alert.Title
get

Alert title


The documentation for this class was generated from the following file: