Search Results for

    Show / Hide Table of Contents

    Class Value

    A base value type for config data abstract representations, to be serialized with an IConfigProvider. If a Value is null, then that represents just that: a null in whatever serialization is being used. Also contains factory functions for all derived types.

    Inheritance
    Object
    Value
    Boolean
    FloatingPoint
    Integer
    List
    Map
    Text
    Namespace: IPA.Config.Data
    Assembly: IPA.Loader.dll
    Syntax
    public abstract class Value : object

    Methods

    | Improve this Doc View Source

    Bool(Boolean)

    Creates a new Boolean wrapping a .

    Declaration
    public static Boolean Bool(bool val)
    Parameters
    Type Name Description
    Boolean val

    the value to wrap

    Returns
    Type Description
    Boolean

    a Boolean wrapping val

    See Also
    From(Boolean)
    | Improve this Doc View Source

    Float(Decimal)

    Creates a new FloatingPoint wrapping a .

    Declaration
    public static FloatingPoint Float(decimal val)
    Parameters
    Type Name Description
    Decimal val

    the value to wrap

    Returns
    Type Description
    FloatingPoint

    a FloatingPoint wrapping val

    See Also
    From(Decimal)
    | Improve this Doc View Source

    From(IDictionary<String, Value>)

    Creates a new Map holding the content of an of to Value.

    Declaration
    public static Map From(IDictionary<string, Value> vals)
    Parameters
    Type Name Description
    IDictionary<String, Value> vals

    the dictionary of Values to initialize the Map wtih

    Returns
    Type Description
    Map

    a Map containing the content of vals

    See Also
    Map()
    | Improve this Doc View Source

    From(Boolean)

    Creates a new Value wrapping a .

    Declaration
    public static Boolean From(bool val)
    Parameters
    Type Name Description
    Boolean val

    the value to wrap

    Returns
    Type Description
    Boolean

    a Boolean wrapping val

    See Also
    Bool(Boolean)
    | Improve this Doc View Source

    From(Decimal)

    Creates a new Value wrapping a .

    Declaration
    public static FloatingPoint From(decimal val)
    Parameters
    Type Name Description
    Decimal val

    the value to wrap

    Returns
    Type Description
    FloatingPoint

    a FloatingPoint wrapping val

    See Also
    Float(Decimal)
    | Improve this Doc View Source

    From(Int64)

    Creates a new Value wrapping a .

    Declaration
    public static Integer From(long val)
    Parameters
    Type Name Description
    Int64 val

    the value to wrap

    Returns
    Type Description
    Integer

    a Integer wrapping val

    See Also
    Integer(Int64)
    | Improve this Doc View Source

    From(Nullable<IEnumerable<Value>>)

    Creates a new List holding the content of an of Value.

    Declaration
    public static List From(IEnumerable<Value>? vals)
    Parameters
    Type Name Description
    Nullable<IEnumerable<Value>> vals

    the Values to initialize the List with

    Returns
    Type Description
    List

    a List containing the content of vals

    See Also
    List()
    | Improve this Doc View Source

    From(Nullable<IEnumerable<KeyValuePair<String, Value>>>)

    Creates a new Map holding the content of an of of to Value.

    Declaration
    public static Map From(IEnumerable<KeyValuePair<string, Value>>? vals)
    Parameters
    Type Name Description
    Nullable<IEnumerable<KeyValuePair<String, Value>>> vals

    the enumerable of of name to Value

    Returns
    Type Description
    Map

    a Map containing the content of vals

    See Also
    Map()
    From(IDictionary<String, Value>)
    | Improve this Doc View Source

    From(Nullable<String>)

    Creates a new Value representing a .

    Declaration
    public static Text From(string? val)
    Parameters
    Type Name Description
    Nullable<String> val

    the value to wrap

    Returns
    Type Description
    Text

    a Text wrapping val

    | Improve this Doc View Source

    Integer(Int64)

    Creates a new Integer wrapping a .

    Declaration
    public static Integer Integer(long val)
    Parameters
    Type Name Description
    Int64 val

    the value to wrap

    Returns
    Type Description
    Integer

    a Integer wrapping val

    See Also
    From(Int64)
    | Improve this Doc View Source

    List()

    Creates an empty List().

    Declaration
    public static List List()
    Returns
    Type Description
    List

    an empty List()

    | Improve this Doc View Source

    Map()

    Creates an empty Map().

    Declaration
    public static Map Map()
    Returns
    Type Description
    Map

    an empty Map()

    See Also
    From(IDictionary<String, Value>)
    | Improve this Doc View Source

    Null()

    Creates a Null Value.

    Declaration
    public static Value Null()
    Returns
    Type Description
    Value null
    | Improve this Doc View Source

    Text(Nullable<String>)

    Creates a new Text object wrapping a .

    Declaration
    public static Text Text(string? val)
    Parameters
    Type Name Description
    Nullable<String> val

    the value to wrap

    Returns
    Type Description
    Text

    a Text wrapping val

    | Improve this Doc View Source

    ToString()

    Converts this Value into a human-readable format.

    Declaration
    public abstract override string ToString()
    Returns
    Type Description
    String

    a human-readable string containing the value provided

    Extension Methods

    ReflectionUtil.SetField<T, U>(T, String, U)
    ReflectionUtil.GetField<U, T>(T, String)
    ReflectionUtil.SetProperty<T, U>(T, String, U)
    ReflectionUtil.GetProperty<U, T>(T, String)
    ReflectionUtil.InvokeMethod<U, T>(T, String, Object[])
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX