Class CaseChangeFunction

Base class for case change functions that operate on a case being entered or modified.

Inheritance

object

Function

PayrollFunction

CaseFunction

CaseChangeFunction

CaseBuildFunction

CaseValidateFunction

Implements

IDisposable

Inherited Members

CaseFunction.GetCaseAttribute(string)

CaseFunction.GetCaseAttribute<T>(string, T)

CaseFunction.CaseName

CaseFunction.CaseType

PayrollFunction.StringType

PayrollFunction.IntType

PayrollFunction.NumericType

PayrollFunction.DecimalType

PayrollFunction.DateType

PayrollFunction.TimeSpanType

PayrollFunction.BooleanType

PayrollFunction.HasFieldValue(string)

PayrollFunction.GetFieldValue(string)

PayrollFunction.HasLookupValue(string, ActionValue, string)

PayrollFunction.HasLookupValue(string, ActionValue, ActionValue, string)

PayrollFunction.GetLookupValue(string, ActionValue, string)

PayrollFunction.GetLookupValue(string, ActionValue, ActionValue, string)

PayrollFunction.ApplyRangeLookupValue(string, decimal, string)

PayrollFunction.Min(params ActionValue[])

PayrollFunction.Min(ActionValue, ActionValue)

PayrollFunction.Max(params ActionValue[])

PayrollFunction.Max(ActionValue, ActionValue)

PayrollFunction.Within(ActionValue, ActionValue, ActionValue)

PayrollFunction.Range(ActionValue, ActionValue, ActionValue)

PayrollFunction.Concat(params ActionValue[])

PayrollFunction.Contains(ActionValue, params ActionValue[])

PayrollFunction.GetTimeSpan(ActionValue, ActionValue)

PayrollFunction.SameYear(ActionValue, ActionValue)

PayrollFunction.SameMonth(ActionValue, ActionValue)

PayrollFunction.SameDay(ActionValue, ActionValue)

PayrollFunction.YearDiff(ActionValue, ActionValue)

PayrollFunction.Age(ActionValue, ActionValue)

PayrollFunction.IsNull(ActionValue)

PayrollFunction.IsNotNull(ActionValue)

PayrollFunction.IfNull(ActionValue, ActionValue)

PayrollFunction.IIf(bool, ActionValue, ActionValue)

PayrollFunction.SetNamespace(string, string)

PayrollFunction.Log(string, LogLevel)

PayrollFunction.GetCalendarPeriod(DateTime?, int)

PayrollFunction.GetCalendarDayCount(string)

PayrollFunction.GetEmployeeAttribute(string)

PayrollFunction.GetEmployeeAttribute<T>(string, T)

PayrollFunction.GetCycle(int)

PayrollFunction.GetCycle(DateTime, int)

PayrollFunction.GetPeriods(int, int)

PayrollFunction.GetCyclePeriods()

PayrollFunction.GetPastCyclePeriods(bool)

PayrollFunction.GetFutureCyclePeriods(bool)

PayrollFunction.IsFirstCycleDay(DateTime)

PayrollFunction.IsLastCycleDay(DateTime)

PayrollFunction.PastPeriod()

PayrollFunction.FuturePeriod()

PayrollFunction.GetPeriod(int)

PayrollFunction.GetPeriod(DateTime, int)

PayrollFunction.GetPeriodOffset(DateTime)

PayrollFunction.IsFirstPeriodDay(DateTime)

PayrollFunction.IsLastPeriodDay(DateTime)

PayrollFunction.GetCaseValueType(string)

PayrollFunction.HasCaseFieldAttribute(string, string)

PayrollFunction.GetCaseFieldAttribute(string, string)

PayrollFunction.GetCaseFieldAttribute<T>(string, string, T)

PayrollFunction.HasCaseValueAttribute(string, string)

PayrollFunction.GetCaseValueAttribute(string, string)

PayrollFunction.GetCaseValueAttribute<T>(string, string, T)

PayrollFunction.TestAvailableCaseValues(IEnumerable<string>)

PayrollFunction.TestAvailableCaseValues(DatePeriod, IEnumerable<string>)

PayrollFunction.GetFirstAvailableCaseValue(IEnumerable<string>)

PayrollFunction.GetFirstAvailableCaseValue(DatePeriod, IEnumerable<string>)

PayrollFunction.GetFirstUnavailableCaseValue(IEnumerable<string>)

PayrollFunction.GetFirstUnavailableCaseValue(DatePeriod, IEnumerable<string>)

PayrollFunction.CaseFieldSlot(string, string)

PayrollFunction.GetPeriodCaseValue<T>(DatePeriod, string, string)

PayrollFunction.GetPeriodCaseValue(DatePeriod, string, string)

PayrollFunction.GetPeriodCaseValues(DatePeriod, params string[])

PayrollFunction.GetPeriodCaseValues(int, params string[])

PayrollFunction.GetPeriodCaseValue<T>(int, string, string)

PayrollFunction.GetPeriodCaseValue(int, string, string)

PayrollFunction.GetCaseValue<T>(string, string)

PayrollFunction.GetCaseValue(string, string)

PayrollFunction.GetPeriodCaseValue(int, int, string, string)

PayrollFunction.GetMultiPeriodCaseValues(int, int, params string[])

PayrollFunction.GetRawCaseValue(string, DateTime)

PayrollFunction.GetRawCaseValues(IList<string>, DateTime)

PayrollFunction.GetRawCaseValue<T>(string, DateTime)

PayrollFunction.GetPeriodRawCaseValues(string, DatePeriod)

PayrollFunction.GetPeriodRawCaseValues(string)

PayrollFunction.GetPeriodRawCaseValues(string, int)

PayrollFunction.GetRawCaseValues(string, DateTime?, DateTime?)

PayrollFunction.GetCaseObjectValues<T>(bool, bool)

PayrollFunction.GetCaseObject<T>(List<CasePayrollValue>, DateTime)

PayrollFunction.GetRawCaseObject<T>(DateTime, bool)

PayrollFunction.GetPeriodRawCaseObjects<T>(List<DateTime>, bool)

PayrollFunction.GetCaseValues(params string[])

PayrollFunction.GetCaseValueTags(string)

PayrollFunction.GetCaseValueTags(string, DateTime)

PayrollFunction.GetCaseValueSlots(string)

PayrollFunction.GetSlotValues(string)

PayrollFunction.GetSlotValues<T>(string)

PayrollFunction.GetSlotByValue(string, string, string)

PayrollFunction.HasLookup(string)

PayrollFunction.GetLookup<T>(string, string, string)

PayrollFunction.GetLookup<T>(string, object[], string)

PayrollFunction.GetObjectLookup<T>(string, string, string, string)

PayrollFunction.GetLookupRanges(string, decimal?)

PayrollFunction.GetLookupThresholdRange(string, decimal)

PayrollFunction.GetLookupProgressiveRanges(string, decimal)

PayrollFunction.GetRangeLookup<T>(string, decimal, string, string)

PayrollFunction.GetRangeObjectLookup<T>(string, decimal, string, string, string)

PayrollFunction.ApplyRangeValue(string, decimal, string)

PayrollFunction.GetAttributeIssue(string, params object[])

PayrollFunction.None

PayrollFunction.Null

PayrollFunction.PayrollId

PayrollFunction.Namespace

PayrollFunction.HasNamespace

PayrollFunction.DivisionId

PayrollFunction.PayrollCulture

PayrollFunction.EmployeeId

PayrollFunction.EmployeeIdentifier

PayrollFunction.CycleStart

PayrollFunction.CycleStartYear

PayrollFunction.CycleStartMonth

PayrollFunction.CycleStartDay

PayrollFunction.CycleEnd

PayrollFunction.CycleEndYear

PayrollFunction.CycleEndMonth

PayrollFunction.CycleEndDay

PayrollFunction.CycleDuration

PayrollFunction.Cycle

PayrollFunction.CycleDays

PayrollFunction.PreviousCycle

PayrollFunction.NextCycle

PayrollFunction.EvaluationDate

PayrollFunction.EvaluationPeriod

PayrollFunction.Periods

PayrollFunction.PeriodStart

PayrollFunction.PeriodStartYear

PayrollFunction.PeriodStartMonth

PayrollFunction.PeriodStartDay

PayrollFunction.PeriodEnd

PayrollFunction.PeriodEndYear

PayrollFunction.PeriodEndMonth

PayrollFunction.PeriodEndDay

PayrollFunction.PeriodDuration

PayrollFunction.Period

PayrollFunction.PeriodDays

PayrollFunction.PreviousPeriod

PayrollFunction.NextPeriod

PayrollFunction.FirstCyclePeriod

PayrollFunction.LastCyclePeriod

PayrollFunction.CycleStartOffset

PayrollFunction.CycleEndOffset

PayrollFunction.PastCyclePeriods

PayrollFunction.FutureCyclePeriods

PayrollFunction.PeriodsInCycle

PayrollFunction.CaseValue

PayrollFunction.CaseValueTags

Function.GetTenantAttribute(string)

Function.GetTenantAttribute<T>(string, T)

Function.GetUserAttribute(string)

Function.GetUserAttribute<T>(string, T)

Function.GetDerivedCulture(int, int)

Function.GetDerivedCalendar(int, int)

Function.GetCalendarDayCount(DateTime, DateTime, string)

Function.GetCalendarDayCount(string, DateTime, DateTime, string)

Function.IsCalendarWorkDay(string, DateTime?)

Function.IsCalendarWorkDay(DateTime?)

Function.GetPreviousWorkDay(string, DateTime?)

Function.GetPreviousWorkDays(string, DateTime?, int)

Function.GetNextWorkDay(string, DateTime?)

Function.GetNextWorkDays(string, DateTime?, int)

Function.GetCalendarPeriod(DateTime?, int, int, int)

Function.GetCalendarPeriod(string, DateTime?, int, string)

Function.LogVerbose(string, string, string)

Function.LogDebug(string, string, string)

Function.LogInformation(string, string, string)

Function.LogWarning(string, string, string)

Function.LogError(string, string, string)

Function.LogError(Exception, string, string)

Function.LogFatal(string, string, string)

Function.LogFatal(Exception, string, string)

Function.Log(LogLevel, string, string, string)

Function.AddTask(string, string, DateTime, string, Dictionary<string, object>)

Function.InvokeWebhook<T>(string, object)

Function.GetSourceFileName(string)

Function.ChangeValueType<T>(object, T, IFormatProvider)

Function.Dispose()

Function.Runtime

Function.TenantId

Function.TenantIdentifier

Function.UserId

Function.UserIdentifier

Function.UserCulture

Function.UserType

Function.SelfServiceUser

Function.AdminUser

Function.SourceFileName

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: PayrollEngine.Client.Scripting.Function

Assembly: PayrollEngine.Client.Scripting.dll

Syntax

public abstract class CaseChangeFunction : CaseFunction, IDisposable

Remarks

Extends CaseFunction with full read/write access to all case field data: start dates (Start), end dates (End), field values (Value), payroll values (PayrollValue), field availability, initialization, and case attributes.

Also provides access to case change metadata: reason (GetReason()), forecast (GetForecast()), and cancellation date (CancellationDate).

Two concrete functions inherit from this class:

• CaseBuildFunction — populates case fields before the input form is displayed.
• CaseValidateFunction — validates field values when the user submits the form.

Constructors

CaseChangeFunction(object)

Initializes a new instance with the function runtime

Declaration

protected CaseChangeFunction(object runtime)

Parameters

Type	Name	Description
object	runtime	The runtime

CaseChangeFunction(string)

New function instance without runtime (scripting development)

Declaration

protected CaseChangeFunction(string sourceFileName)

Parameters

Type	Name	Description
string	sourceFileName	The name of the source file

Remarks

Use GetSourceFileName(string) in your constructor for the source file name

Properties

Cancellation

Tests whether this case change is a cancellation

Declaration

[ActionProperty("Test for canceled case", null)]
public bool Cancellation { get; }

Property Value

Type	Description
bool

CancellationDate

Gets the cancellation date of this case change, or null if not cancelled

Declaration

[ActionProperty("Case cancellation date", null)]
public DateTime? CancellationDate { get; }

Property Value

Type	Description
DateTime?

End

Get or set end date of the case value by the case field name

Declaration

public ScriptDictionary<string, DateTime?> End { get; }

Property Value

Type	Description
ScriptDictionary<string, DateTime?>

FieldNames

Gets the names of all case fields in the current case change

Declaration

public List<string> FieldNames { get; }

Property Value

Type	Description
List<string>

PayrollValue

Get or set case value by the case field name

Declaration

public ScriptDictionary<string, PayrollValue> PayrollValue { get; }

Property Value

Type	Description
ScriptDictionary<string, PayrollValue>

Start

Get or set start date of the case field

Declaration

public ScriptDictionary<string, DateTime?> Start { get; }

Property Value

Type	Description
ScriptDictionary<string, DateTime?>

Value

Get or set case field value by the case field name

Declaration

public ScriptDictionary<string, object> Value { get; }

Property Value

Type	Description
ScriptDictionary<string, object>

Methods

AddCaseValueTag(string, string)

Adds a tag to a case field value

Declaration

public bool AddCaseValueTag(string caseFieldName, string tag)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	tag	The tag to add

Returns

Type	Description
bool	true if the tag was added; false if it was already present

CaseAvailable()

Tests whether the current case is available for input

Declaration

public bool CaseAvailable()

Returns

Type	Description
bool	true if the case is available

CaseAvailable(string)

Tests whether a named case is available for input

Declaration

public bool CaseAvailable(string caseName)

Parameters

Type	Name	Description
string	caseName	The PascalCase case name

Returns

Type	Description
bool	true if the case is available

FieldAvailable(string)

Tests whether a case field is currently available (visible) in the form

Declaration

public bool FieldAvailable(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool	true if the field is visible

FieldAvailable(string, bool)

Controls whether a case field is available (visible) in the form

Declaration

public void FieldAvailable(string caseFieldName, bool available)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
bool	available	true to show the field; false to hide it

GetChangeCaseObject<T>()

Reads the current case change into a typed object

Declaration

public T GetChangeCaseObject<T>() where T : class, ICaseObject, new()

Returns

Type	Description
T	A new instance of T populated from the current case field values

Type Parameters

Name	Description
T	A class implementing ICaseObject with a parameterless constructor

GetEnd(string)

Get the end date of a case field

Declaration

public DateTime? GetEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field

Returns

Type	Description
DateTime?

GetForecast()

Get the case change forecast

Declaration

public string GetForecast()

Returns

Type	Description
string

GetPeriod(string)

Returns the value period of a case field as a DatePeriod

Declaration

public DatePeriod GetPeriod(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
DatePeriod

GetReason()

Get the case change reason

Declaration

public string GetReason()

Returns

Type	Description
string

GetStart(string)

Get the start date of a case field

Declaration

public DateTime? GetStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field

Returns

Type	Description
DateTime?

GetValue(string)

Get the value of a case field

Declaration

public object GetValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field

Returns

Type	Description
object

GetValue(string, object)

Get the value of a case field with a default value

Declaration

public object GetValue(string caseFieldName, object defaultValue)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
object	defaultValue	The case field default value

Returns

Type	Description
object

GetValueSlots(string)

Returns all slot values for a case field, keyed by their payroll value

Declaration

public Dictionary<CasePayrollValue, string> GetValueSlots(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
Dictionary<CasePayrollValue, string>	Dictionary mapping each slot's CasePayrollValue to its slot name

GetValueSlots<T>(string)

Returns all slot values for a case field as a typed dictionary

Declaration

public Dictionary<T, string> GetValueSlots<T>(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

Returns

Type	Description
Dictionary<T, string>	Dictionary mapping the typed slot value to its slot name

Type Parameters

Name	Description
T	The value type to cast each slot value to

GetValueType(string)

Returns the ValueType of a case field's value

Declaration

public ValueType GetValueType(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
ValueType

GetValue<T>(string)

Get the typed value of a case field

Declaration

public T GetValue<T>(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetValue<T>(string, T)

Get the typed value of a case field with a default value

Declaration

public T GetValue<T>(string caseFieldName, T defaultValue)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
T	defaultValue	The case field default value

Returns

Type	Description
T

Type Parameters

Name	Description
T

HasEnd(string)

Test if a case field end is defined

Declaration

public bool HasEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field

Returns

Type	Description
bool

HasField(string)

Tests whether a named case field exists in the current case change

Declaration

public bool HasField(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool	true if the field is present

HasFields()

Tests whether the case change contains at least one field

Declaration

public bool HasFields()

Returns

Type	Description
bool

HasStart(string)

Test if a case field start is defined

Declaration

public bool HasStart(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field

Returns

Type	Description
bool

HasValue(string)

Test if a case field value is defined

Declaration

public bool HasValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field

Returns

Type	Description
bool

HiddenField(string)

Hide all field inputs

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("HiddenField", "Hide all field inputs", new string[] { "FieldInput", "Field" })]
public void HiddenField(string field)

Parameters

Type	Name	Description
string	field	The case field name

HideCaseField(string)

Hide the case field

Declaration

public void HideCaseField(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

InitEnd(string, DateTime?)

Sets the end date of a case field only if no end date is currently set

Declaration

public void InitEnd(string caseFieldName, DateTime? end)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
DateTime?	end	The case field end date

Remarks

Use SetEnd(string, DateTime?) to overwrite unconditionally.

InitField(string, object, DateTime?, DateTime?)

Sets value, start date, and end date of a case field only if not already set

Declaration

public void InitField(string caseFieldName, object value, DateTime? start = null, DateTime? end = null)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
object	value	The case field value
DateTime?	start	The case field start date
DateTime?	end	The case field end date

Remarks

Each component is applied individually — a component already present is not overwritten. Use SetField(string, object, DateTime?, DateTime?) to overwrite all components unconditionally.

InitStart(string, DateTime?)

Sets the start date of a case field only if no start date is currently set

Declaration

public void InitStart(string caseFieldName, DateTime? start)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
DateTime?	start	The case field start date

Remarks

Use SetStart(string, DateTime?) to overwrite unconditionally.

InitValue(string, PayrollValue)

Sets the payroll value of a case field only if no value is currently set

Declaration

public void InitValue(string caseFieldName, PayrollValue value)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
PayrollValue	value	The case field payroll value

Remarks

Use SetValue(string, object) to overwrite unconditionally.

InitValue(string, object)

Sets the value of a case field only if no value is currently set

Declaration

public void InitValue(string caseFieldName, object value)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
object	value	The case field value

Remarks

Use SetValue(string, object) to overwrite unconditionally.

IsFieldComplete(string)

Tests whether a case field has all three components set: start date, end date, and value

Declaration

public bool IsFieldComplete(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool	true if start, end, and value are all present

IsFieldEmpty(string)

Tests whether a case field has none of its components set (no start, no end, no value)

Declaration

public bool IsFieldEmpty(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool	true if start, end, and value are all absent

MandatoryEnd(string)

Tests whether an end date is mandatory for the given case field

Declaration

public bool MandatoryEnd(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool	true if an end date must be provided

MandatoryValue(string)

Tests whether a value is mandatory for the given case field

Declaration

public bool MandatoryValue(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name

Returns

Type	Description
bool	true if a value must be provided

RemoveCaseAttribute(string)

Removes an attribute from the current case

Declaration

public bool RemoveCaseAttribute(string attributeName)

Parameters

Type	Name	Description
string	attributeName	The name of the case attribute

Returns

Type	Description
bool	true if the attribute existed and was removed

RemoveCaseAttribute(string, string)

Removes an attribute from a named case

Declaration

public bool RemoveCaseAttribute(string caseName, string attributeName)

Parameters

Type	Name	Description
string	caseName	The PascalCase case name
string	attributeName	The name of the case attribute

Returns

Type	Description
bool	true if the attribute existed and was removed

RemoveCaseFieldAttribute(string, string)

Removes an attribute from a case field

Declaration

public bool RemoveCaseFieldAttribute(string caseFieldName, string attributeName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	attributeName	The attribute name

Returns

Type	Description
bool	true if the attribute existed and was removed

RemoveCaseValueAttribute(string, string)

Removes an attribute from a case value

Declaration

public bool RemoveCaseValueAttribute(string caseFieldName, string attributeName)

Parameters

Type	Name	Description
string	caseFieldName	The case field name
string	attributeName	The attribute name

Returns

Type	Description
bool	true if the attribute existed and was removed

RemoveCaseValueTag(string, string)

Removes a tag from a case field value

Declaration

public bool RemoveCaseValueTag(string caseFieldName, string tag)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	tag	The tag to remove

Returns

Type	Description
bool	true if the tag was removed; false if it was not present

SetCaseAttribute(string, object)

Set case attribute value

Declaration

public void SetCaseAttribute(string attributeName, object value)

Parameters

Type	Name	Description
string	attributeName	The name of the case attribute
object	value	The value of the case attribute

SetCaseAttribute(string, string, object)

Set case attribute value

Declaration

public void SetCaseAttribute(string caseName, string attributeName, object value)

Parameters

Type	Name	Description
string	caseName	The name of the case
string	attributeName	The name of the case attribute
object	value	The value of the case attribute

SetCaseFieldAttribute(string, string, object)

Set case field attribute value

Declaration

public void SetCaseFieldAttribute(string caseFieldName, string attributeName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	attributeName	The name of the case field attribute
object	value	The value of the case field attribute (null = remove attribute)

SetCaseValueAttribute(string, string, object)

Set case value attribute value

Declaration

public void SetCaseValueAttribute(string caseFieldName, string attributeName, object value)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field
string	attributeName	The name of the case field attribute
object	value	The value of the case value attribute (null = remove attribute)

SetChangeCaseObject<T>(T)

Writes the properties of a typed object back into the current case field values

Declaration

public void SetChangeCaseObject<T>(T data) where T : class, ICaseObject, new()

Parameters

Type	Name	Description
T	data	The object whose property values are written to the case fields

Type Parameters

Name	Description
T	A class implementing ICaseObject with a parameterless constructor

SetEnd(string, DateTime?)

Set the end date of a case field

Declaration

public void SetEnd(string caseFieldName, DateTime? end)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
DateTime?	end	The case field end date

SetField(string, object, DateTime?, DateTime?)

Set the case field value, start and end

Declaration

public void SetField(string caseFieldName, object value, DateTime? start = null, DateTime? end = null)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
object	value	The case field value
DateTime?	start	The case field start date
DateTime?	end	The case field end date

SetFieldAttachmentExtensions(string, string)

Set field attachments file extensions

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("extensions", "The file extensions", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldAttachmentExtensions", "Set field attachments file extensions", new string[] { "FieldInput", "Field" })]
public void SetFieldAttachmentExtensions(string field, string extensions)

Parameters

Type	Name	Description
string	field	The target field
string	extensions	The file extensions

SetFieldAttachmentMandatory(string)

Set field mandatory file attachments

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldAttachmentMandatory", "Set field mandatory file attachments", new string[] { "FieldInput", "Field" })]
public void SetFieldAttachmentMandatory(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldAttachmentNone(string)

Set field without file attachments

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldAttachmentNone", "Set field without file attachments", new string[] { "FieldInput", "Field" })]
public void SetFieldAttachmentNone(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldAttachmentOptional(string)

Set field optional file attachments

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldAttachmentOptional", "Set field optional file attachments", new string[] { "FieldInput", "Field" })]
public void SetFieldAttachmentOptional(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldCheck(string)

Set field boolean as checkbox

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldCheck", "Set field boolean as checkbox", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldCheck(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldCulture(string, string)

Set field value culture

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("culture", "The culture (https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c)", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldCulture", "Set field value culture", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldCulture(string field, string culture)

Parameters

Type	Name	Description
string	field	The target field
string	culture	The culture

Remarks

see https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c

SetFieldEndFormat(string, string)

Set field end format

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("format", "The format (https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndFormat", "Set field end format", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndFormat(string field, string format)

Parameters

Type	Name	Description
string	field	The target field
string	format	The format string

Remarks

see https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c

SetFieldEndHelp(string, string)

Set field end help

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("help", "The field end help", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndHelp", "Set field end help", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndHelp(string field, string help)

Parameters

Type	Name	Description
string	field	The target field
string	help	The field end help

SetFieldEndLabel(string, string)

Set field end label

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("label", "The field end label", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndLabel", "Set field end label", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndLabel(string field, string label)

Parameters

Type	Name	Description
string	field	The target field
string	label	The field end label

SetFieldEndPickerOpenDay(string)

Set field end day date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndPickerOpenDay", "Set field end day date picker", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndPickerOpenDay(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldEndPickerOpenMonth(string)

Set field end month date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndPickerOpenMonth", "Set field end month date picker", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndPickerOpenMonth(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldEndPickerOpenYear(string)

Set field end year date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndPickerOpenYear", "Set field end year date picker", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndPickerOpenYear(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldEndPickerTypeDateTime(string)

Set field end time picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndPickerTypeDateTime", "Set field end time picker", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndPickerTypeDateTime(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldEndReadOnly(string)

Set field end read only

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndReadOnly", "Set field end read only", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndReadOnly(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldEndRequired(string)

Set field end required

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldEndRequired", "Set field end required", new string[] { "FieldInput", "FieldEnd" })]
public void SetFieldEndRequired(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldFormat(string, string)

Set field value format

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("format", "The value format (https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldFormat", "Set field value format", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldFormat(string field, string format)

Parameters

Type	Name	Description
string	field	The target field
string	format	The text format

Remarks

see https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

SetFieldLineCount(string, int)

Set field text line count

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("count", "The line count", new string[] { "Int" }, null, null)]
[CaseBuildAction("SetFieldLineCount", "Set field text line count", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldLineCount(string field, int count)

Parameters

Type	Name	Description
string	field	The target field
int	count	The line count

SetFieldMaxLength(string, int)

Set field maximum text length

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("length", "The length", new string[] { "Int" }, null, null)]
[CaseBuildAction("SetFieldMaxLength", "Set field maximum text length", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldMaxLength(string field, int length)

Parameters

Type	Name	Description
string	field	The target field
int	length	The maximum length

SetFieldMaxValue(string, object)

Set field maximum value

Declaration

[ActionParameter("field", "The target field", new string[] { "Num" }, null, null)]
[ActionParameter("max", "The maximum value", null, null, null)]
[CaseBuildAction("SetFieldMaxValue", "Set field maximum value", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldMaxValue(string field, object max)

Parameters

Type	Name	Description
string	field	The target field
object	max	The maximum value

SetFieldMinValue(string, object)

Set field minimum value

Declaration

[ActionParameter("field", "The target field", new string[] { "Num" }, null, null)]
[ActionParameter("min", "The minimum value", null, null, null)]
[CaseBuildAction("SetFieldMinValue", "Set field minimum value", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldMinValue(string field, object min)

Parameters

Type	Name	Description
string	field	The target field
object	min	The minimum value

SetFieldStartFormat(string, string)

Set field start format

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("format", "The format (https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartFormat", "Set field start format", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartFormat(string field, string format)

Parameters

Type	Name	Description
string	field	The target field
string	format	The format string

Remarks

see https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

SetFieldStartHelp(string, string)

Set field start help

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("help", "The field start help", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartHelp", "Set field start help", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartHelp(string field, string help)

Parameters

Type	Name	Description
string	field	The target field
string	help	The field start help

SetFieldStartLabel(string, string)

Set field start label

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("label", "The field start label", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartLabel", "Set field start label", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartLabel(string field, string label)

Parameters

Type	Name	Description
string	field	The target field
string	label	The field start label

SetFieldStartPickerOpenDay(string)

Set field start day date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartPickerOpenDay", "Set field start day date picker", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartPickerOpenDay(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldStartPickerOpenMonth(string)

Set field start month date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartPickerOpenMonth", "Set field start month date picker", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartPickerOpenMonth(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldStartPickerOpenYear(string)

Set field start year date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartPickerOpenYear", "Set field start year date picker", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartPickerOpenYear(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldStartPickerTypeDateTime(string)

Set field start picker date time

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartPickerTypeDateTime", "Set field start picker date time", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartPickerTypeDateTime(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldStartReadOnly(string)

Set field start read only

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartReadOnly", "Set field start read only", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartReadOnly(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldStartRequired(string)

Set field start required

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldStartRequired", "Set field start required", new string[] { "FieldInput", "FieldStart" })]
public void SetFieldStartRequired(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldStepSize(string, int)

Set field numeric step size

Declaration

[ActionParameter("field", "The target field", new string[] { "Int" }, null, null)]
[ActionParameter("size", "The step size", null, null, null)]
[CaseBuildAction("SetFieldStepSize", "Set field numeric step size", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldStepSize(string field, int size)

Parameters

Type	Name	Description
string	field	The target field
int	size	The step size

SetFieldValueAdornment(string, string)

Set field value adornment

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("adornment", "The adornment text", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValueAdornment", "Set field value adornment", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValueAdornment(string field, string adornment)

Parameters

Type	Name	Description
string	field	The target field
string	adornment	The adornment text

SetFieldValueHelp(string, string)

Set field value help

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("help", "The help text", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValueHelp", "Set field value help", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValueHelp(string field, string help)

Parameters

Type	Name	Description
string	field	The target field
string	help	The adornment text

SetFieldValueLabel(string, string)

Set field value label

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("label", "The label text", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValueLabel", "Set field value label", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValueLabel(string field, string label)

Parameters

Type	Name	Description
string	field	The target field
string	label	The label text

SetFieldValueMask(string, string)

Set field value mask

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[ActionParameter("mask", "The value mask (https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.maskedtextbox.mask)", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValueMask", "Set field value mask", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValueMask(string field, string mask)

Parameters

Type	Name	Description
string	field	The target field
string	mask	The text mask

Remarks

see https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.maskedtextbox.mask

SetFieldValuePickerOpenDay(string)

Set field value day date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValuePickerOpenDay", "Set field value day date picker", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValuePickerOpenDay(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldValuePickerOpenMonth(string)

Set field value month date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValuePickerOpenMonth", "Set field value month date picker", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValuePickerOpenMonth(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldValuePickerOpenYear(string)

Set field value year date picker

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValuePickerOpenYear", "Set field value year date picker", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValuePickerOpenYear(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldValueReadOnly(string)

Set field value read only

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValueReadOnly", "Set field value read only", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValueReadOnly(string field)

Parameters

Type	Name	Description
string	field	The target field

SetFieldValueRequired(string)

Set field value required

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("SetFieldValueRequired", "Set field value required", new string[] { "FieldInput", "FieldValue" })]
public void SetFieldValueRequired(string field)

Parameters

Type	Name	Description
string	field	The target field

SetForecast(string)

Set the case change forecast

Declaration

public void SetForecast(string forecast)

Parameters

Type	Name	Description
string	forecast

SetReason(string)

Set the case change reason

Declaration

public void SetReason(string reason)

Parameters

Type	Name	Description
string	reason

SetStart(string, DateTime?)

Set the start date of a case field

Declaration

public void SetStart(string caseFieldName, DateTime? start)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
DateTime?	start	The case field start date

SetValue(string, PayrollValue)

Set the value of a case field

Declaration

public void SetValue(string caseFieldName, PayrollValue value)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
PayrollValue	value	The case field value

SetValue(string, object)

Set the value of a case field

Declaration

public void SetValue(string caseFieldName, object value)

Parameters

Type	Name	Description
string	caseFieldName	Name of the case field
object	value	The case field value

ShowCaseField(string)

Show the case field

Declaration

public void ShowCaseField(string caseFieldName)

Parameters

Type	Name	Description
string	caseFieldName	The name of the case field

ShowFieldDescription(string)

Show field description

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("ShowFieldDescription", "Show field description", new string[] { "FieldInput", "Field" })]
public void ShowFieldDescription(string field)

Parameters

Type	Name	Description
string	field	The target field

UpdateEnd(DateTime?)

Sets the end date on all case fields that have a value or a mandatory end date

Declaration

public void UpdateEnd(DateTime? end)

Parameters

Type	Name	Description
DateTime?	end	The end date to apply

UpdateStart(DateTime?)

Sets the start date on all case fields that have a value or a mandatory end date

Declaration

public void UpdateStart(DateTime? start)

Parameters

Type	Name	Description
DateTime?	start	The start date to apply

VisibleField(string)

Show all field inputs

Declaration

[ActionParameter("field", "The target field", new string[] { "String" }, null, null)]
[CaseBuildAction("VisibleField", "Show all field inputs", new string[] { "FieldInput", "Field" })]
public void VisibleField(string field)

Parameters

Type	Name	Description
string	field	The case field name

Implements

IDisposable

Extension Methods

ConsoleExtensions.WriteProperties(object, bool)

ValueTypeExtensions.GetValueType(object)

ObjectInfo.GetPropertyValue(object, string)

ObjectInfo.GetPropertyValue<T>(object, string, T)

ObjectInfo.ResolvePropertyValue(object, string)

ObjectInfo.SetPropertyValue(object, string, object)