Struct Money
Money is an immutable struct type that encapsulates an amount of money and a currency.
Implements
System.IComparable
System.IComparable<
Money>
System.IFormattable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
Assembly: Mediachase.Commerce.dll
Version: 13.30.0
public struct Money : IComparable, IComparable<Money>, IEquatable<Money>, IFormattable
Constructors
Initializes a new instance of the Money struct.
Declaration
public Money(decimal amount, Currency currency)
Parameters
Type |
Name |
Description |
System.Decimal |
amount |
The amount.
|
Currency |
currency |
The currency.
|
Properties
Gets the amount of money.
Declaration
public decimal Amount { get; }
Property Value
Type |
Description |
System.Decimal |
The amount of money.
|
Declaration
public Currency Currency { get; }
Property Value
Gets or sets the function for getting default currency.
Declaration
[Obsolete("This type is no longer used. Will remain at least until Aug 2020")]
public static Func<Currency> DefaultCurrencyFunction { get; set; }
Property Value
Type |
Description |
System.Func<Currency> |
The default currency function.
|
Methods
Declaration
public Money Add(Money m)
Parameters
Type |
Name |
Description |
Money |
m |
|
Returns
Declaration
Returns
Declaration
public int CompareTo(Money other)
Parameters
Type |
Name |
Description |
Money |
other |
|
Returns
Type |
Description |
System.Int32 |
|
Creates the money with fallback to default currency if the currency is empty.
Declaration
public static Money CreateMoneyWithDefaultCurrencyFallback(decimal amount, Currency currency)
Parameters
Type |
Name |
Description |
System.Decimal |
amount |
The amount.
|
Currency |
currency |
The currency.
|
Returns
Type |
Description |
Money |
A Money struct.
|
Declaration
public Money Divide(decimal d)
Parameters
Type |
Name |
Description |
System.Decimal |
d |
|
Returns
Declaration
public bool Equals(Money other)
Parameters
Type |
Name |
Description |
Money |
other |
|
Returns
Type |
Description |
System.Boolean |
|
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)
Declaration
Returns
Declaration
public override int GetHashCode()
Returns
Type |
Description |
System.Int32 |
|
Overrides
System.ValueType.GetHashCode()
Declaration
public Money Multiply(decimal d)
Parameters
Type |
Name |
Description |
System.Decimal |
d |
|
Returns
Declaration
Returns
Declaration
Returns
Type |
Description |
Money |
Rounded amount following the standard currency decimal digits format.
|
Declaration
public Money Subtract(Money m)
Parameters
Type |
Name |
Description |
Money |
m |
|
Returns
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Overrides
System.ValueType.ToString()
Declaration
public string ToString(IFormatProvider formatProvider)
Parameters
Type |
Name |
Description |
System.IFormatProvider |
formatProvider |
|
Returns
Type |
Description |
System.String |
|
Declaration
public string ToString(string format)
Parameters
Type |
Name |
Description |
System.String |
format |
|
Returns
Type |
Description |
System.String |
|
Declaration
public string ToString(string format, IFormatProvider formatProvider)
Parameters
Type |
Name |
Description |
System.String |
format |
|
System.IFormatProvider |
formatProvider |
|
Returns
Type |
Description |
System.String |
|
Declaration
Returns
Operators
Declaration
public static Money operator +(Money m1, Money m2)
Parameters
Returns
Declaration
public static Money operator /(Money m, decimal d)
Parameters
Type |
Name |
Description |
Money |
m |
|
System.Decimal |
d |
|
Returns
Declaration
public static bool operator ==(Money m1, Money m2)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static explicit operator Money(decimal amount)
Parameters
Type |
Name |
Description |
System.Decimal |
amount |
|
Returns
Declaration
public static bool operator>(Money m1, Money m2)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static bool operator >=(Money m1, Money m2)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static implicit operator decimal (Money value)
Parameters
Type |
Name |
Description |
Money |
value |
|
Returns
Type |
Description |
System.Decimal |
|
Declaration
public static bool operator !=(Money m1, Money m2)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static bool operator <(Money m1, Money m2)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static bool operator <=(Money m1, Money m2)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Declaration
public static Money operator *(Money m, decimal d)
Parameters
Type |
Name |
Description |
Money |
m |
|
System.Decimal |
d |
|
Returns
Declaration
public static Money operator -(Money m1, Money m2)
Parameters
Returns
Declaration
public static Money operator -(Money m)
Parameters
Type |
Name |
Description |
Money |
m |
|
Returns
Declaration
public static Money operator +(Money m)
Parameters
Type |
Name |
Description |
Money |
m |
|
Returns
Explicit Interface Implementations
Declaration
int IComparable.CompareTo(object obj)
Parameters
Type |
Name |
Description |
System.Object |
obj |
|
Returns
Type |
Description |
System.Int32 |
|
Implements
System.IComparable
System.IComparable<T>
System.IEquatable<T>
System.IFormattable
Extension Methods