UIParam Bool

Bool UI Parameter

Bool parameter allows to save and return true/false values.

this.parameters = function () {
		
    var boolUIParameter = { 
        name: "myBoolParam",
	type: "Bool", 
	displayName: "Bool Parameter",
	description: "Toggle parameters to set on/off", 
	defaultValue: true
    };

    return [boolUIParameter];
}
    
this.environments = function (parameters, info) {
    var boolParameterValue = parameters.myBoolParam; // Bool value
    DocumentModel.log(boolParameterValue);
};

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)

Bool, set the type as "Bool"

displayName

Interface display name.

description

Interface detail text

defaultValue

Input any True/False value as a default value.