Class ConstantValueSource<T>

Definition

Namespace: StardewUI.Framework.Sources
Assembly: StardewUI.dll

Value source with a constant value, generally used to hold the literal (text) value of an attribute.

public class ConstantValueSource<T> : 
    StardewUI.Framework.Sources.IValueSource<T>, 
    StardewUI.Framework.Sources.IValueSource

Type Parameters

T

Inheritance
Object ⇦ ConstantValueSource<T>

Implements
IValueSource<T>, IValueSource

Members

Constructors

Name	Description
ConstantValueSource<T>(T)	Value source with a constant value, generally used to hold the literal (text) value of an attribute.

Properties

Name	Description
CanRead	Whether or not the source can be read from, i.e. if an attempt to get the Value should succeed.
CanWrite	Whether or not the source can be written back to, i.e. if an attempt to set the Value should succeed.
DisplayName	Descriptive name for the property, used primarily for debug views and log/exception messages.
Value
ValueType	The compile-time type of the value tracked by this source; the type parameter for IValueSource<T>.

Methods

Name	Description
Update(Boolean)	Checks if the value needs updating, and if so, updates Value to the latest.

Details

Constructors

ConstantValueSource<T>(T)

Value source with a constant value, generally used to hold the literal (text) value of an attribute.

public ConstantValueSource<T>(T value);

Parameters

value   T
The attribute value.

---

Properties

CanRead

Whether or not the source can be read from, i.e. if an attempt to get the Value should succeed.

public bool CanRead { get; }

Property Value

Boolean

---

CanWrite

Whether or not the source can be written back to, i.e. if an attempt to set the Value should succeed.

public bool CanWrite { get; }

Property Value

Boolean

---

DisplayName

Descriptive name for the property, used primarily for debug views and log/exception messages.

public string DisplayName { get; }

Property Value

string

---

Value

public T Value { get; set; }

Property Value

T

---

ValueType

The compile-time type of the value tracked by this source; the type parameter for IValueSource<T>.

public System.Type ValueType { get; }

Property Value

Type

---

Methods

Update(bool)

Checks if the value needs updating, and if so, updates Value to the latest.

public bool Update(bool force);

Parameters

force   Boolean
If true, forces the source to update its value even if it isn't considered dirty. This should never be used in a regular binding, but can be useful in sources that are intended for occasional or one-shot use such as event handler arguments.

Returns

Boolean

Remarks

As implemented on ConstantValueSource<T>, always returns false as there can never be any change that requires an update.

---