Class DatasetShortcutFormulaContext
Inheritance
DatasetShortcutFormulaContext
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.API.dll
Syntax
public class DatasetShortcutFormulaContext : FormulaFunctionsWithContext<IDatasetShortcut>, IFormulaFunctionsWithContext<IDatasetShortcut>, IFormulaFunctionsWithContext, IFormulaFunctions
Constructors
DatasetShortcutFormulaContext(IEntityRetriever, IReadOnlyCache, UserInfo, IDatasetShortcut, IFormulaFunctionsServiceContext)
Declaration
public DatasetShortcutFormulaContext(IEntityRetriever retriever, IReadOnlyCache cache, UserInfo user, IDatasetShortcut item, IFormulaFunctionsServiceContext services)
Parameters
Properties
CurrentMultiColumnName
Declaration
public string CurrentMultiColumnName { get; set; }
Property Value
CurrentParamDefaultFormulaOrColumnCalc
Declaration
public string CurrentParamDefaultFormulaOrColumnCalc { get; set; }
Property Value
DataSetProcessor
Declaration
public IDataSetProcessor DataSetProcessor { get; set; }
Property Value
SelectedColumns
Declaration
public IEnumerable<string> SelectedColumns { get; set; }
Property Value
Methods
AreAnyColumnsSelected(params string[])
Declaration
[FormulaFunction(Name = "AreAnyColumnsSelected", Type = "DatasetShortcut", Description = "Returns true if any of the specified column names have been selected by the user.", Params = "1. The name of the column to check for.\r\n2. Additional column names to check for....", ParamCount = 2, IsAsync = false)]
public bool AreAnyColumnsSelected(params string[] columnNames)
Parameters
| Type |
Name |
Description |
| string[] |
columnNames |
|
Returns
GetCurrentMultiColumnNameWithoutPrePostFixes(string, string)
Declaration
[FormulaFunction(Name = "GetCurrentMultiColumnNameWithoutPrePostFixes", Type = "DatasetShortcut", Description = "Returns the current CurrentMultiColumnName but with the specified pre and post fix removed.", Params = "1. A prefix to remove from the name.\r\n2. The current CurrentMultiColumnName (which is the current name returned from New Column Name if it returns multiple names).\r\n3. A postfix to remove from the name", ParamCount = 3, IsAsync = false)]
public string GetCurrentMultiColumnNameWithoutPrePostFixes(string preFix, string postFix)
Parameters
Returns
GetMultiSelectResults(string)
Declaration
[FormulaFunction(Name = "GetMultiSelectResults", Type = "DatasetShortcut", Description = "Returns a list of (id, name) for all possible selected values from a custom parameter that allows multiple selections.", Params = "1. The name of the custom parameter that is a multi select control.", ParamCount = 1, IsAsync = false)]
public List<(Guid, string)> GetMultiSelectResults(string paramName)
Parameters
| Type |
Name |
Description |
| string |
paramName |
|
Returns
GetNewNames(string, List<(Guid, string)>, string)
Declaration
[FormulaFunction(Name = "GetNewNames", Type = "DatasetShortcut", Description = "Returns a list of names formed of the specified prefix and postfix for each name in a list of multiple names. The list is of the form (id, name) so it can come straight from GetMultiSelectResults function.", Params = "1. A prefix to apply to every returned name.\r\n2. A list of (id, name) every name to return a new name for.\r\n3. A postfix to apply to every returned name", ParamCount = 3, IsAsync = false)]
public string[] GetNewNames(string preFix, List<(Guid, string)> multipleNames, string postFix)
Parameters
Returns
Init()
Declaration
Returns
IsColumnSelected(string)
Declaration
[FormulaFunction(Name = "IsColumnSelected", Type = "DatasetShortcut", Description = "Returns true if the specified column name has been selected by the user.", Params = "1. The name of the column to check for.", ParamCount = 1, IsAsync = false)]
public bool IsColumnSelected(string columnName)
Parameters
| Type |
Name |
Description |
| string |
columnName |
|
Returns
Test3()
Declaration
public Task<string> Test3()
Returns
Test4()
Declaration
Returns
Implements
Extension Methods