Class FormulaFunctionsWithViewModel<T>
The context supplied while executing a formula that has a custom context item, and a view that it operates against
This context is mainly used against formulas that configure and work against a view itself, such as ones that
can specify if a view is visible dynamically, or more.
Inheritance
FormulaFunctionsWithViewModel<T>
Inherited Members
StandardFunctions.IsIn(object, object, object, object, object, object, object, object, object, object, object)
StandardFunctions.SelectCase(object, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>)
StandardFunctions.SelectCase(object, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>)
StandardFunctions.SelectCase(object, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>)
StandardFunctions.SelectCase(object, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>)
StandardFunctions.SelectCase(object, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>)
StandardFunctions.SelectCase(object, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>, Func<Task<object>>)
Assembly: LemonEdge.ClientCore.dll
public class FormulaFunctionsWithViewModel<T> : FormulaFunctionsWithContext<T>, IFormulaFunctionsWithViewModel<T>, IFormulaFunctionsWithViewModel, IFormulaFunctionsWithContext<T>, IFormulaFunctionsWithContext, IFormulaFunctions
Type Parameters
Name |
Description |
T |
The context supplied while executing a formula that has a custom context item, and a view that it operates against This context is mainly used against formulas that configure and work against a view itself, such as ones that can specify if a view is visible dynamically, or more. |
Constructors
FormulaFunctionsWithViewModel(IEntityRetriever, IReadOnlyCache, UserInfo, T, IModelLayoutCommon, IFormulaFunctionsServiceContext)
Declaration
public FormulaFunctionsWithViewModel(IEntityRetriever retriever, IReadOnlyCache cache, UserInfo user, T item, IModelLayoutCommon host, IFormulaFunctionsServiceContext services)
Parameters
Properties
Declaration
public IModelLayoutCommon Host { get; }
Property Value
Declaration
public bool IgnoreEvents { get; set; }
Property Value
Declaration
public IEntityUpdaterUI MyDataUI { get; }
Property Value
Declaration
public IRootController RootController { get; }
Property Value
Methods
CreateFormulaContext(Type)
Declaration
protected override FormulaFunctions CreateFormulaContext(Type ofType)
Parameters
Type |
Name |
Description |
Type |
ofType |
|
Returns
Overrides
Declaration
[FormulaFunction(Name = "DisplayError", Type = "UI", Description = "Displays the specified exception to the user.", Params = "1. The exception to display.", ParamCount = 1, IsAsync = true)]
public Task DisplayError(Exception ex)
Parameters
Returns
Declaration
[FormulaFunction(Name = "DisplayInformationMessage", Type = "UI", Description = "Displays ok message.", Params = "1. The title of the message.\r\n2. The message", ParamCount = 2, IsAsync = true)]
public Task DisplayInformationMessage(string title, string msg)
Parameters
Returns
Declaration
[FormulaFunction(Name = "DisplayYesNoCancelQuestion", Type = "UI", Description = "Displays a question to the user with a yes/no/cancel option. Returns null if cancel is selected, and true if yes is selected.", Params = "1. The title for the message box.\r\n2. The question the user is prompted with.", ParamCount = 2, IsAsync = true)]
public Task<bool?> DisplayYesNoCancelQuestion(string title, string question)
Parameters
Returns
Declaration
[FormulaFunction(Name = "DisplayYesNoQuestion", Type = "UI", Description = "Displays a question to the user with a yes/no option. Returns true if yes is selected.", Params = "1. The title for the message box.\r\n2. The question the user is prompted with.", ParamCount = 2, IsAsync = true)]
public Task<bool> DisplayYesNoQuestion(string title, string question)
Parameters
Returns
Declaration
[FormulaFunction(Name = "OpenItem", Type = "UI", Description = "Opens the specified item as a seperate tab in the app.", Params = "1. The item to open.", ParamCount = 1, IsAsync = true)]
public Task OpenItem(IBaseEntity item)
Parameters
Returns
Declaration
[FormulaFunction(Name = "OpenItemFromID", Type = "UI", Description = "Opens the specified item as a seperate tab in the app.", Params = "1. The type of item to open.\r\n2. The id of the item to open", ParamCount = 2, IsAsync = true)]
public Task OpenItemFromID(Type itemType, Guid itemID)
Parameters
Type |
Name |
Description |
Type |
itemType |
|
Guid |
itemID |
|
Returns
Allow override in ui, but don't do anything in services
Declaration
[FormulaFunction(Name = "SetBusy", Type = "UI", Description = "Displays a busy spinner with the specified description.", Params = "1. The description to display while showing the busy spinner.", ParamCount = 1, IsAsync = false)]
public override void SetBusy(string label)
Parameters
Type |
Name |
Description |
string |
label |
|
Overrides
Allow override in ui, but don't do anything in services
Declaration
[FormulaFunction(Name = "StopBusy", Type = "UI", Description = "Stops showing any previously displayed busy spinner.", Params = "", ParamCount = 0, IsAsync = false)]
public override void StopBusy()
Overrides
Implements
Extension Methods