Class EbicsParameter

Namespace
Subsembly.EBICS
Assembly
Subsembly.EBICS.Core.dll

Holds an EBICS Parameter element.

public class EbicsParameter : EbicsElement, IEbicsJsonConverter
Inheritance
EbicsParameter
Implements
Inherited Members
Extension Methods

Remarks

An EbicsParameter can be added to a EbicsParameters collection. However, each EbicsParameter instance can only be added to at most one EbicsParameters collection.

Constructors

EbicsParameter()

public EbicsParameter()

EbicsParameter(string, object)

public EbicsParameter(string sName, object aValue)

Parameters

sName string
aValue object

Properties

Name

Name of parameter.

public string Name { get; set; }

Property Value

string

The name must be a valid XML token. If it is null or an empty string, then this EbicsParameter instance cannot be converted to XML by BuildXml(XmlDocument, EbicsVersion).

Parent

The EbicsParameters collection that this EbicsParameter was added to.

public EbicsParameters Parent { get; }

Property Value

EbicsParameters

If this EbicsParameter was not added to an EbicsParameters collection, then this is null.

Type

XML type of the value of this parameter.

public string Type { get; }

Property Value

string

One of "string", "int", or "boolean".

Remarks

The value null will be indicated as type "string".

Value

Value of this parameter.

public object Value { get; set; }

Property Value

object

By default the parameter value has the type string, however, other value types are possible. Currently implemented is supported for the .NET native types String, Int32, and Boolean. The value null is considered to mean an empty string.

ValueString

The Value of this parameter converted to an XML string.

public string ValueString { get; }

Property Value

string

If the Value is null, then this property will return an empty string.

Methods

BuildXml(XmlDocument, EbicsVersion)

public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)

Parameters

xmlDocument XmlDocument
nVersion EbicsVersion

Returns

XmlElement

CreateParameter(JsonObject)

public static EbicsParameter CreateParameter(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

EbicsParameter

FromJson(JsonObject)

public void FromJson(JsonObject jsonObject)

Parameters

jsonObject JsonObject

ParseXml(XmlElement, EbicsVersion)

public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)

Parameters

xmlElement XmlElement
nVersion EbicsVersion

ToJson(JsonObject)

public JsonObject ToJson(JsonObject jsonObject)

Parameters

jsonObject JsonObject

Returns

JsonObject