String UI Parameter

String parameter allows to save and return string value.

this.parameters = function () {
		
    var stringUIParameter = { 
        name: "myStringParam",
	type: "String", 
	displayName: "String Parameter",
	description: "Input any text here.", 
	defaultValue: "My Default Value"
    };

    return [stringUIParameter];
}
    
this.environments = function (parameters, info) {
    var stringParameterValue = parameters.myStringParam; // String value
    DocumentModel.log(stringParameterValue);
};

All UI parameters are Javascript Objects.

name (*Required)

Name property identifies the parameter name and also returns the value in functions that receives the parameters input. Access the value using the parameters.name property.

type (*Required)

String, set the type as "String"

displayName

Interface display name.

description

Interface detail text

defaultValue

Input any String value as a default value.