Plegma API  v2
Yodiwo.API.Plegma.ConfigDescription Class Reference

Describes restrictions and gives information of a configuration parameter. More...

Public Attributes

string DefaultValue
 The default value (can be null) More...
 
string Description
 Human readable description (can be null) More...
 
string Label
 Human readable label (can be null or empty) More...
 
string Name
 Name of the configuration parameter (must neither be null nor empty) More...
 
bool Required
 Specifies whether the parameter is required More...
 
string Type
 The data type of the parameter (can be null) More...
 
double Minimum
 Minimum value More...
 
double Maximum
 Maximum value More...
 
double Stepsize
 Change step size More...
 
bool ReadOnly
 Specifies whether the parameter is read only More...
 

Detailed Description

Describes restrictions and gives information of a configuration parameter.

Member Data Documentation

string Yodiwo.API.Plegma.ConfigDescription.DefaultValue

The default value (can be null)

string Yodiwo.API.Plegma.ConfigDescription.Description

Human readable description (can be null)

string Yodiwo.API.Plegma.ConfigDescription.Label

Human readable label (can be null or empty)

double Yodiwo.API.Plegma.ConfigDescription.Maximum

Maximum value

double Yodiwo.API.Plegma.ConfigDescription.Minimum

Minimum value

string Yodiwo.API.Plegma.ConfigDescription.Name

Name of the configuration parameter (must neither be null nor empty)

bool Yodiwo.API.Plegma.ConfigDescription.ReadOnly

Specifies whether the parameter is read only

bool Yodiwo.API.Plegma.ConfigDescription.Required

Specifies whether the parameter is required

double Yodiwo.API.Plegma.ConfigDescription.Stepsize

Change step size

string Yodiwo.API.Plegma.ConfigDescription.Type

The data type of the parameter (can be null)


The documentation for this class was generated from the following file: