Class EbicsParameter

Holds an EBICS Parameter element.

Inheritance
System.Object
EbicsElement
EbicsParameter
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Subsembly.EBICS
Assembly: Subsembly.EBICS.Core.dll
Syntax
public class EbicsParameter : EbicsElement, IEbicsJsonConverter
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()

Declaration
public EbicsParameter()

EbicsParameter(String, Object)

Declaration
public EbicsParameter(string sName, object aValue)
Parameters
Type Name Description
System.String sName
System.Object aValue

Properties

Name

Name of parameter.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.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.

Declaration
public EbicsParameters Parent { get; }
Property Value
Type Description
EbicsParameters

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

Type

XML type of the value of this parameter.

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

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

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

Value

Value of this parameter.

Declaration
public object Value { get; set; }
Property Value
Type Description
System.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.

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

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

Methods

BuildXml(XmlDocument, EbicsVersion)

Declaration
public override XmlElement BuildXml(XmlDocument xmlDocument, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument
EbicsVersion nVersion
Returns
Type Description
System.Xml.XmlElement
Overrides

CreateParameter(JsonObject)

Declaration
public static EbicsParameter CreateParameter(JsonObject jsonObject)
Parameters
Type Name Description
JsonObject jsonObject
Returns
Type Description
EbicsParameter

FromJson(JsonObject)

Declaration
public void FromJson(JsonObject jsonObject)
Parameters
Type Name Description
JsonObject jsonObject

ParseXml(XmlElement, EbicsVersion)

Declaration
public override void ParseXml(XmlElement xmlElement, EbicsVersion nVersion)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement
EbicsVersion nVersion
Overrides

ToJson(JsonObject)

Declaration
public JsonObject ToJson(JsonObject jsonObject)
Parameters
Type Name Description
JsonObject jsonObject
Returns
Type Description
JsonObject

Implements

Extension Methods