![]() |
OTX-Runtime for DotNet
|
|
Base of ScreenParameters. More...
Properties | |
string | DataType [get] |
Gets the data type of the parameter as a string. More... | |
object | InitValue [get] |
Gets initial value. More... | |
int | MappingIndex [get] |
Gets mapping index. More... | |
string | MappingName [get] |
Gets mapping name. More... | |
string | Name [get] |
Gets name. More... | |
string | Specification [get] |
Gets specification. More... | |
Base of ScreenParameters.
|
get |
Gets the data type of the parameter as a string.
Returns the parameter’s data type as a string, supporting simple types like Integer
, String
or ByteField
, as well as more complex data types such as List<String>
, Map<String, Integer>
, or nested types like Map<Integer
, List<Integer>>.
DataType | Property value as String |
---|---|
String | "String" |
Integer | "Integer" |
Float | "Float" |
Boolean | "Boolean" |
ByteField | "ByteField" |
Map | "Map<Integer, String>, Map<String, List<Integer>>" (Example) |
List | "List<Integer>, List<Map<String, List<Integer>>" (Example) |
Enumeration | "OtxPackage.Document.Color" (Example) |
Structure | "OtxPackage.Document.MyStructure<Integer, String>" (Example for simple structure)"OtxPackage.Document.MyPersonStructure<StructureElement<Name, String>, StructureElement<Age, Integer>, StructureElement<Family, List<Person>>>" (Example for structure containing a List<Structure> ) |
Notes: A Structure has a data type formatted as follows:
"StructureSignatureName<Datatype1, DataType2, ...>"
. However, when the Structure contains a List of Structure or a Map of Structure, each structure element has a special syntax:StructureElement<ElementName, DataType>
, e.g."StructureSignatureName<StructureElement<ElementName1, DataType1>, StructureElement<ElementName2, DataType2>, ...>"
.
|
get |
Gets initial value.
|
get |
Gets mapping index.
If a mapping is related to a list element, the function will return the relate index.
If no mapping a list element, this function will return -1.
|
get |
Gets mapping name.
If a valid mapping exists for this Parameter, this function will return the related mapping name. The value can be used to make the application independent from different OTX projects which should be use the same system resource.
If no valid mapping exists, this function will return NULL. If there are more than one mapping name related to this Parameter, they will be concatenated with ", ". If a mapping is related to a list element, the mapping name contains the index of the list element in format "MyMappingList[0]".
The mapping name is the full qualified name of the element inside the external application which is mapped to this Parameter. It contains all namespace elements separated by dots (".").
|
get |
Gets name.
|
get |
Gets specification.