C# Class _3PA.MainFeatures.UserCommunication

Mostrar archivo Open project: jcaillon/3P Class Usage Examples

Public Methods

Method Description
CloseUniqueNotif ( string id ) : void

Closes the notification represented by the given id

ForceClose ( ) : void

Close all the notifications

Init ( ) : void

init an empty form, this gives us a Form to hook onto if we want to do stuff on the UI thread from a back groundthread, use : BeginInvoke()

Input ( object &data, string htmlContent, MessageImg imageType, string title, string subTitle, List buttonsList = null, Action clickHandler = null ) : int

Allows to ask information to the user, returns an integer (-1 if closed, or from 0 to x = buttons.count - 1), buttonsList default to { "Ok", "Cancel" }

Message ( object &data, string htmlContent, MessageImg imageType, string title, string subTitle, List buttonsList = null, bool waitResponse = true, Action clickHandler = null, int minWidth = 450 ) : int
Message ( string htmlContent, MessageImg imageType, string title, string subTitle, List buttonsList = null, bool waitResponse = true, Action clickHandler = null ) : int

Displays a messagebox like window, REMARK : DON'T WAIT FOR AN ANSWER IF YOU CALL IT FROM A THREAD!!!!!!!, new List string { "Ok", "Cancel" }, returns an integer (-1 if closed, or from 0 to x = buttons.count - 1), buttonsList default to { "Ok", "Cancel" }

Notify ( string html, MessageImg imageType, string title, string subTitle, Action clickHandler, int duration, int width = 450 ) : void
Notify ( string html, MessageImg imageType, string title, string subTitle, int duration, int width = 450 ) : void
Notify ( string html, int duration = 10, int width = 450 ) : void
NotifyUnique ( string id, string htmlContent, MessageImg imageType, string title, string subTitle, Action clickHandler, int duration, int width = 450 ) : void

Displays a notification on the bottom right of the screen

Method Details

CloseUniqueNotif() public static method

Closes the notification represented by the given id
public static CloseUniqueNotif ( string id ) : void
id string
return void

ForceClose() public static method

Close all the notifications
public static ForceClose ( ) : void
return void

Init() public static method

init an empty form, this gives us a Form to hook onto if we want to do stuff on the UI thread from a back groundthread, use : BeginInvoke()
public static Init ( ) : void
return void

Input() public static method

Allows to ask information to the user, returns an integer (-1 if closed, or from 0 to x = buttons.count - 1), buttonsList default to { "Ok", "Cancel" }
public static Input ( object &data, string htmlContent, MessageImg imageType, string title, string subTitle, List buttonsList = null, Action clickHandler = null ) : int
data object
htmlContent string
imageType MessageImg
title string
subTitle string
buttonsList List
clickHandler Action
return int

Message() public static method

public static Message ( object &data, string htmlContent, MessageImg imageType, string title, string subTitle, List buttonsList = null, bool waitResponse = true, Action clickHandler = null, int minWidth = 450 ) : int
data object
htmlContent string
imageType MessageImg
title string
subTitle string
buttonsList List
waitResponse bool
clickHandler Action
minWidth int
return int

Message() public static method

Displays a messagebox like window, REMARK : DON'T WAIT FOR AN ANSWER IF YOU CALL IT FROM A THREAD!!!!!!!, new List string { "Ok", "Cancel" }, returns an integer (-1 if closed, or from 0 to x = buttons.count - 1), buttonsList default to { "Ok", "Cancel" }
public static Message ( string htmlContent, MessageImg imageType, string title, string subTitle, List buttonsList = null, bool waitResponse = true, Action clickHandler = null ) : int
htmlContent string
imageType MessageImg
title string
subTitle string
buttonsList List
waitResponse bool
clickHandler Action
return int

Notify() public static method

public static Notify ( string html, MessageImg imageType, string title, string subTitle, Action clickHandler, int duration, int width = 450 ) : void
html string
imageType MessageImg
title string
subTitle string
clickHandler Action
duration int
width int
return void

Notify() public static method

public static Notify ( string html, MessageImg imageType, string title, string subTitle, int duration, int width = 450 ) : void
html string
imageType MessageImg
title string
subTitle string
duration int
width int
return void

Notify() public static method

public static Notify ( string html, int duration = 10, int width = 450 ) : void
html string
duration int
width int
return void

NotifyUnique() public static method

Displays a notification on the bottom right of the screen
public static NotifyUnique ( string id, string htmlContent, MessageImg imageType, string title, string subTitle, Action clickHandler, int duration, int width = 450 ) : void
id string
htmlContent string
imageType MessageImg
title string
subTitle string
clickHandler Action
duration int
width int
return void