Class ActionValue

Action value

Inheritance

object

ActionValue

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: PayrollEngine.Client.Scripting.Function

Assembly: PayrollEngine.Client.Scripting.dll

Syntax

public sealed class ActionValue

Constructors

ActionValue(object)

Value constructor

Declaration

public ActionValue(object value)

Parameters

Type	Name	Description
object	value	Action value

Fields

Null

Empty instance

Declaration

public static readonly ActionValue Null

Field Value

Type	Description
ActionValue

Properties

AsBool

Action value as boolean

Declaration

public bool AsBool { get; }

Property Value

Type	Description
bool

AsDateTime

Action value as date

Declaration

public DateTime AsDateTime { get; }

Property Value

Type	Description
DateTime

AsDecimal

Action value as decimal

Declaration

public decimal AsDecimal { get; }

Property Value

Type	Description
decimal

AsInt

Action value as integer

Declaration

public int AsInt { get; }

Property Value

Type	Description
int

AsString

Action value as string

Declaration

public string AsString { get; }

Property Value

Type	Description
string

AsTimeSpan

Action value as timespan

Declaration

public TimeSpan AsTimeSpan { get; }

Property Value

Type	Description
TimeSpan

Day

Get day from date value

Declaration

public int Day { get; }

Property Value

Type	Description
int

Days

Get day from timespan value

Declaration

public int Days { get; }

Property Value

Type	Description
int

HasValue

Test for action value

Declaration

public bool HasValue { get; }

Property Value

Type	Description
bool

IsBool

Test for action bool value

Declaration

public bool IsBool { get; }

Property Value

Type	Description
bool

IsDateTime

Test for action date value

Declaration

public bool IsDateTime { get; }

Property Value

Type	Description
bool

IsDecimal

Test for decimal value

Declaration

public bool IsDecimal { get; }

Property Value

Type	Description
bool

IsInt

Test for integer value

Declaration

public bool IsInt { get; }

Property Value

Type	Description
bool

IsNull

Test for action null value

Declaration

public bool IsNull { get; }

Property Value

Type	Description
bool

IsNumeric

Test for numeric value (int or decimal)

Declaration

public bool IsNumeric { get; }

Property Value

Type	Description
bool

IsString

Test for action string value

Declaration

public bool IsString { get; }

Property Value

Type	Description
bool

IsTimeSpan

Test for action timespan value

Declaration

public bool IsTimeSpan { get; }

Property Value

Type	Description
bool

Month

Get month from date value

Declaration

public int Month { get; }

Property Value

Type	Description
int

Value

Action primitive value

Declaration

public object Value { get; }

Property Value

Type	Description
object

ValueType

Get the action value type

Declaration

public ActionValueType ValueType { get; }

Property Value

Type	Description
ActionValueType

Year

Get year from date value

Declaration

public int Year { get; }

Property Value

Type	Description
int

Methods

Abs()

Returns the absolute value of a specified number

Declaration

public ActionValue Abs()

Returns

Type	Description
ActionValue

Add(TimeSpan)

Add timespan to date value

Declaration

public DateTime Add(TimeSpan timeSpan)

Parameters

Type	Name	Description
TimeSpan	timeSpan

Returns

Type	Description
DateTime

AddDays(int)

Add days to date value

Declaration

public DateTime AddDays(int days)

Parameters

Type	Name	Description
int	days

Returns

Type	Description
DateTime

AddMonths(int)

Add months to date value

Declaration

public DateTime AddMonths(int months)

Parameters

Type	Name	Description
int	months

Returns

Type	Description
DateTime

AddYears(int)

Add years to date value

Declaration

public DateTime AddYears(int years)

Parameters

Type	Name	Description
int	years

Returns

Type	Description
DateTime

Equals(object)

Determines whether the specified object is equal to this instance

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object

Returns

Type	Description
bool	True if the specified object is equal to this instance

Overrides

object.Equals(object)

From(object)

Create action value from value

Declaration

public static ActionValue From(object value)

Parameters

Type	Name	Description
object	value	Source value

Returns

Type	Description
ActionValue

GetHashCode()

Returns a hash code for this instance

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table

Overrides

object.GetHashCode()

Power(decimal)

Returns a specified number raised to the specified power

Declaration

public ActionValue Power(decimal power)

Parameters

Type	Name	Description
decimal	power	Number that specifies a power

Returns

Type	Description
ActionValue

Round(int, MidpointRounding)

Returns the integral digits of the specified decimal, using a step size

Declaration

public ActionValue Round(int decimals = 0, MidpointRounding mode = MidpointRounding.ToEven)

Parameters

Type	Name	Description
int	decimals	The number of significant decimal places (precision) in the return value
MidpointRounding	mode	A value that specifies how to round d if it is midway between two other numbers

Returns

Type	Description
ActionValue

RoundDown(decimal)

Rounds a decimal value down

Declaration

public ActionValue RoundDown(decimal stepSize)

Parameters

Type	Name	Description
decimal	stepSize	The round step size

Returns

Type	Description
ActionValue	The down-rounded value

RoundUp(decimal)

Rounds a decimal value up

Declaration

public ActionValue RoundUp(decimal stepSize = 1)

Parameters

Type	Name	Description
decimal	stepSize	The round step size

Returns

Type	Description
ActionValue	The up-rounded value

Sqrt()

Returns the square root of a specified number

Declaration

public ActionValue Sqrt()

Returns

Type	Description
ActionValue

Subtract(TimeSpan)

Subtract timespan to date value

Declaration

public DateTime Subtract(TimeSpan timeSpan)

Parameters

Type	Name	Description
TimeSpan	timeSpan

Returns

Type	Description
DateTime

ToPrimitive(object)

Unwrap action value to its primitive value

Declaration

public static object ToPrimitive(object value)

Parameters

Type	Name	Description
object	value	The value, possibly an ActionValue wrapper

Returns

Type	Description
object	The unwrapped primitive value

ToString()

Returns a string that represents this instance

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance

Overrides

object.ToString()

Truncate(int)

Returns the integral digits of the specified decimal, using a step size

Declaration

public ActionValue Truncate(int stepSize = 1)

Parameters

Type	Name	Description
int	stepSize	The step size used to truncate

Returns

Type	Description
ActionValue

TryToBool(out bool)

Convert acton value to bool

Declaration

public bool TryToBool(out bool value)

Parameters

Type	Name	Description
bool	value	Source value

Returns

Type	Description
bool

TryToDateTime(out DateTime)

Convert acton value to datetime

Declaration

public bool TryToDateTime(out DateTime value)

Parameters

Type	Name	Description
DateTime	value	Source value

Returns

Type	Description
bool

TryToDecimal(out decimal)

Convert acton value to decimal

Declaration

public bool TryToDecimal(out decimal value)

Parameters

Type	Name	Description
decimal	value	Source value

Returns

Type	Description
bool

TryToInt(out int)

Convert acton value to int

Declaration

public bool TryToInt(out int value)

Parameters

Type	Name	Description
int	value	Source value

Returns

Type	Description
bool

TryToTimeSpan(out TimeSpan)

Convert acton value to timespan

Declaration

public bool TryToTimeSpan(out TimeSpan value)

Parameters

Type	Name	Description
TimeSpan	value	Source value

Returns

Type	Description
bool

Operators

operator +(ActionValue, ActionValue)

Addition of two action values (decimal, int, string, TimeSpan, DateTime+TimeSpan)

Declaration

public static ActionValue operator +(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

Remarks

Treats undefined values as zero

operator &(ActionValue, ActionValue)

Test if two action values are true (bool)

Declaration

public static ActionValue operator &(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

operator |(ActionValue, ActionValue)

Test if any action value is true (bool)

Declaration

public static ActionValue operator |(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

operator /(ActionValue, ActionValue)

Division of two action values

Declaration

public static ActionValue operator /(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

Remarks

Null/>on undefined left, treat undefined right as one

operator ==(ActionValue, ActionValue)

Compare two action values for equality

Declaration

public static bool operator ==(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
bool

operator false(ActionValue)

Test if action value is false

Declaration

public static bool operator false(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
bool

operator >(ActionValue, ActionValue)

Compare if an action value is greater than another action value

Declaration

public static ActionValue operator >(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

operator >=(ActionValue, ActionValue)

Compare if an action value is greater or equals than another action value

Declaration

public static ActionValue operator >=(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

implicit operator bool(ActionValue)

Convert action value to bool

Declaration

public static implicit operator bool(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
bool

implicit operator DateTime(ActionValue)

Convert action value to DateTime

Declaration

public static implicit operator DateTime(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
DateTime

implicit operator decimal(ActionValue)

Convert action value to decimal

Declaration

public static implicit operator decimal(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
decimal

implicit operator int(ActionValue)

Convert action value to int/>

Declaration

public static implicit operator int(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
int

implicit operator bool?(ActionValue)

Convert action value to nullable bool

Declaration

public static implicit operator bool?(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
bool?

implicit operator DateTime?(ActionValue)

Convert action value to nullable DateTime

Declaration

public static implicit operator DateTime?(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
DateTime?

implicit operator decimal?(ActionValue)

Convert action value to nullable decimal

Declaration

public static implicit operator decimal?(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
decimal?

implicit operator int?(ActionValue)

Convert action value to nullable int

Declaration

public static implicit operator int?(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
int?

implicit operator TimeSpan?(ActionValue)

Convert action value to nullable TimeSpan

Declaration

public static implicit operator TimeSpan?(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
TimeSpan?

implicit operator string(ActionValue)

Convert action value to string/>

Declaration

public static implicit operator string(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
string

implicit operator TimeSpan(ActionValue)

Convert action value to TimeSpan

Declaration

public static implicit operator TimeSpan(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
TimeSpan

implicit operator ActionValue(bool)

Implicit bool conversion

Declaration

public static implicit operator ActionValue(bool value)

Parameters

Type	Name	Description
bool	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(DateTime)

Implicit datetime conversion

Declaration

public static implicit operator ActionValue(DateTime value)

Parameters

Type	Name	Description
DateTime	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(decimal)

Implicit decimal conversion

Declaration

public static implicit operator ActionValue(decimal value)

Parameters

Type	Name	Description
decimal	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(double)

Implicit double conversion

Declaration

public static implicit operator ActionValue(double value)

Parameters

Type	Name	Description
double	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(int)

Implicit int conversion

Declaration

public static implicit operator ActionValue(int value)

Parameters

Type	Name	Description
int	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(long)

Implicit long conversion

Declaration

public static implicit operator ActionValue(long value)

Parameters

Type	Name	Description
long	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(float)

Implicit float conversion

Declaration

public static implicit operator ActionValue(float value)

Parameters

Type	Name	Description
float	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(string)

Implicit string conversion

Declaration

public static implicit operator ActionValue(string value)

Parameters

Type	Name	Description
string	value

Returns

Type	Description
ActionValue

implicit operator ActionValue(TimeSpan)

Implicit timespan conversion

Declaration

public static implicit operator ActionValue(TimeSpan value)

Parameters

Type	Name	Description
TimeSpan	value

Returns

Type	Description
ActionValue

operator !=(ActionValue, ActionValue)

Compare two action values for difference

Declaration

public static bool operator !=(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
bool

operator <(ActionValue, ActionValue)

Compare if an action value is less than another action value

Declaration

public static ActionValue operator <(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

operator <=(ActionValue, ActionValue)

Compare if an action value is less or equals than another action value

Declaration

public static ActionValue operator <=(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

operator !(ActionValue)

Logical negation of an action value (bool)

Declaration

public static ActionValue operator !(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
ActionValue

operator %(ActionValue, ActionValue)

Remainder of two action values

Declaration

public static ActionValue operator %(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

Remarks

Null/>on undefined left, treat undefined right as one

operator *(ActionValue, ActionValue)

Multiplication of two action values

Declaration

public static ActionValue operator *(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

Remarks

Treats undefined values as one

operator -(ActionValue, ActionValue)

Subtraction of two action values

Declaration

public static ActionValue operator -(ActionValue left, ActionValue right)

Parameters

Type	Name	Description
ActionValue	left
ActionValue	right

Returns

Type	Description
ActionValue

Remarks

Treats undefined values as zero

operator true(ActionValue)

Test if action value is true

Declaration

public static bool operator true(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
bool

operator -(ActionValue)

Unary minus of an action value

Declaration

public static ActionValue operator -(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
ActionValue

operator +(ActionValue)

Unary plus of an action value

Declaration

public static ActionValue operator +(ActionValue value)

Parameters

Type	Name	Description
ActionValue	value

Returns

Type	Description
ActionValue

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)