Interface INamedProperty

Some property object that can have a unique name and a value of one of standard types: string, double, integer or boolean. The property can be complex or array type also. It means that it can contain nested properties.

Namespace: DotnetPostprocessing.SDK

Assembly: DotnetPostprocessing.SDK.dll

Syntax

public interface INamedProperty

Properties

Arr

Returns a reference to a nested array type property by its unique name. You can use the compound name of the property, separating the individual parts with a point, to obtain a reference to the property of the second and subsequent nesting levels. For example: Arr["Project.Operations"]. The case of characters does not matter.

Declaration

IArrayNamedPropertyIndexer Arr { get; }

Property Value

Type	Description
IArrayNamedPropertyIndexer

Bol

Returns a boolean value of the nested property by its unique name. You can use the compound name of the property, separating the individual parts with a point, to obtain the property value
of the second and subsequent nesting levels. For example: Bol["Project.Operations"]. The case of characters does not matter.

Declaration

IBooleanNamedPropertyIndexer Bol { get; }

Property Value

Type	Description
IBooleanNamedPropertyIndexer

Flt

Returns a double value of the nested property by its unique name. You can use the compound name of the property, separating the individual parts with a point, to obtain the property value
of the second and subsequent nesting levels. For example: Flt["Project.Operations"]. The case of characters does not matter.

Declaration

IFloatNamedPropertyIndexer Flt { get; }

Property Value

Type	Description
IFloatNamedPropertyIndexer

Int

Returns an integer value of the nested property by its unique name. You can use the compound name of the property, separating the individual parts with a point, to obtain the property value
of the second and subsequent nesting levels. For example: Int["Project.Operations"]. The case of characters does not matter.

Declaration

IIntegerNamedPropertyIndexer Int { get; }

Property Value

Type	Description
IIntegerNamedPropertyIndexer

Name

Unique property name.

Declaration

string Name { get; }

Property Value

Type	Description
string

Parent

Returns the parent property fot this one.

Declaration

INamedProperty Parent { get; }

Property Value

Type	Description
INamedProperty

Ptr

Returns a reference to a nested property by its unique name. You can use the compound name of the property, separating the individual parts with a point, to obtain a reference to the property of the second and subsequent nesting levels. For example: Ptr["StartPoint.X"]. The case of characters does not matter.

Declaration

INamedPropertyIndexer Ptr { get; }

Property Value

Type	Description
INamedPropertyIndexer

SimpleType

Describe the type of a value which can be contained inside the property (boolean, integer or floating number, textual string or just an explicitly enumerated limited list of possible values).

Declaration

NamedParamType SimpleType { get; }

Property Value

Type	Description
NamedParamType

Str

Returns a string value of the nested property by its unique name. You can use the compound name of the property, separating the individual parts with a point, to obtain the property value
of the second and subsequent nesting levels. For example: Str["Project.Operations"]. The case of characters does not matter.

Declaration

IStringNamedPropertyIndexer Str { get; }

Property Value

Type	Description
IStringNamedPropertyIndexer

ValueAsBoolean

Returns the value of this property as a boolean - "true" or "false".

Declaration

bool ValueAsBoolean { get; set; }

Property Value

Type	Description
bool

ValueAsDouble

Returns the value of this property as a floating number with double tolerance.

Declaration

double ValueAsDouble { get; set; }

Property Value

Type	Description
double

ValueAsInteger

Returns the value of this property as an integer number.

Declaration

int ValueAsInteger { get; set; }

Property Value

Type	Description
int

ValueAsString

Returns the value of this property as a textual string.

Declaration

string ValueAsString { get; set; }

Property Value

Type	Description
string

Methods

FindChild(string)

Finds a nested property by it's given unique name. The case of characters does not matter.

Declaration

INamedProperty FindChild(string Name)

Parameters

Type	Name	Description
string	Name	The name of a nested property that you want to obtain.

Returns

Type	Description
INamedProperty	Returns the nested property with the given name. If there is no nested property with the given name then it returns "null".

GetNextChild(INamedProperty?)

Returns the child property that is next in the list immediately after the specified one. You can pass ChildParam=null to get the first child property.

Declaration

INamedProperty GetNextChild(INamedProperty? ChildParam)

Parameters

Type	Name	Description
INamedProperty	ChildParam	The reference to a child property. The child property immediately following this one in the list will be returned. It this parameter is null then the first child property will be returned.

Returns

Type	Description
INamedProperty	Returns the reference to the next child property. If there is no next child property then "null" will be returned.