UIParam Text

Text UI Parameter

Text parameter allows to save and return long text value.

this.parameters = function () {
		
    var textUIParameter = { 
        name: "myTextParam",
	type: "Text", 
	displayName: "Text Parameter",
	description: "Input any longer text here.", 
	defaultValue: "My Default Value"
    };

    return [textUIParameter];
}
    
this.environments = function (parameters, info) {
    var textParameterValue = parameters.myTextParam; // String value
    DocumentModel.log(textParameterValue);
};

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)

Text, set the type as "Text"

displayName

Interface display name.

description

Interface detail text

defaultValue

Input any String value as a default value.