Show / Hide Table of Contents

Struct Amount

Represents monetary amount with currency

Implements
System.IEquatable<Amount>
System.IComparable<Amount>
IJSONWritable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NFX.Financial
Assembly: NFX.dll
Syntax
[Serializable]
public struct Amount : IEquatable<Amount>, IComparable<Amount>, IJSONWritable

Constructors

Amount(String, Decimal)

Declaration
public Amount(string currencyISO, decimal value)
Parameters
Type Name Description
System.String currencyISO
System.Decimal value

Properties

CurrencyISO

Declaration
public string CurrencyISO { get; }
Property Value
Type Description
System.String

IsEmpty

Declaration
public bool IsEmpty { get; }
Property Value
Type Description
System.Boolean

Value

Declaration
public decimal Value { get; }
Property Value
Type Description
System.Decimal

Methods

CompareTo(Amount)

Declaration
public int CompareTo(Amount other)
Parameters
Type Name Description
Amount other
Returns
Type Description
System.Int32

Equals(Amount)

Declaration
public bool Equals(Amount other)
Parameters
Type Name Description
Amount other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.ValueType.GetHashCode()

IsSameCurrencyAs(Amount)

Perfoms case-insensitive currency equality comparison

Declaration
public bool IsSameCurrencyAs(Amount other)
Parameters
Type Name Description
Amount other
Returns
Type Description
System.Boolean

Parse(String)

Declaration
public static Amount Parse(string val)
Parameters
Type Name Description
System.String val
Returns
Type Description
Amount

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.ValueType.ToString()

TryParse(String, out Amount)

Declaration
public static bool TryParse(string val, out Amount result)
Parameters
Type Name Description
System.String val
Amount result
Returns
Type Description
System.Boolean

WriteAsJSON(TextWriter, Int32, JSONWritingOptions)

Declaration
public void WriteAsJSON(TextWriter wri, int nestingLevel, JSONWritingOptions options = null)
Parameters
Type Name Description
System.IO.TextWriter wri
System.Int32 nestingLevel
JSONWritingOptions options

Operators

Addition(Amount, Amount)

Declaration
public static Amount operator +(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
Amount

Division(Amount, Decimal)

Declaration
public static Amount operator /(Amount left, decimal right)
Parameters
Type Name Description
Amount left
System.Decimal right
Returns
Type Description
Amount

Division(Amount, Double)

Declaration
public static Amount operator /(Amount left, double right)
Parameters
Type Name Description
Amount left
System.Double right
Returns
Type Description
Amount

Division(Amount, Int32)

Declaration
public static Amount operator /(Amount left, int right)
Parameters
Type Name Description
Amount left
System.Int32 right
Returns
Type Description
Amount

Equality(Amount, Amount)

Declaration
public static bool operator ==(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
System.Boolean

GreaterThan(Amount, Amount)

Declaration
public static bool operator>(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
System.Boolean

GreaterThanOrEqual(Amount, Amount)

Declaration
public static bool operator >=(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
System.Boolean

Inequality(Amount, Amount)

Declaration
public static bool operator !=(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
System.Boolean

LessThan(Amount, Amount)

Declaration
public static bool operator <(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
System.Boolean

LessThanOrEqual(Amount, Amount)

Declaration
public static bool operator <=(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
System.Boolean

Multiply(Amount, Decimal)

Declaration
public static Amount operator *(Amount left, decimal right)
Parameters
Type Name Description
Amount left
System.Decimal right
Returns
Type Description
Amount

Multiply(Amount, Double)

Declaration
public static Amount operator *(Amount left, double right)
Parameters
Type Name Description
Amount left
System.Double right
Returns
Type Description
Amount

Multiply(Amount, Int32)

Declaration
public static Amount operator *(Amount left, int right)
Parameters
Type Name Description
Amount left
System.Int32 right
Returns
Type Description
Amount

Multiply(Decimal, Amount)

Declaration
public static Amount operator *(decimal left, Amount right)
Parameters
Type Name Description
System.Decimal left
Amount right
Returns
Type Description
Amount

Multiply(Double, Amount)

Declaration
public static Amount operator *(double left, Amount right)
Parameters
Type Name Description
System.Double left
Amount right
Returns
Type Description
Amount

Multiply(Int32, Amount)

Declaration
public static Amount operator *(int left, Amount right)
Parameters
Type Name Description
System.Int32 left
Amount right
Returns
Type Description
Amount

Subtraction(Amount, Amount)

Declaration
public static Amount operator -(Amount left, Amount right)
Parameters
Type Name Description
Amount left
Amount right
Returns
Type Description
Amount

Implements

System.IEquatable<T>
System.IComparable<T>
IJSONWritable

Extension Methods

ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX