Skip to main content

getProperties()

returns an object with the available configuration attributes of the control

getProperties(): ISimpleVaultProps;

Returns:

An object with the available attributes of the control and their values.

Example

var form = new dhx.Form("form_container", {    rows: [        {            type: "simpleVault",            name:"simplevault",            label: "i am simpleVault",            labelWidth: "120px",            labelPosition: "left",            disabled: false,            required: false        }    ]});
form.getItem("simplevault").getProperties();// -> the returned object{    errorMessage: "",    fieldName: "simplevault",    height: "content",    helpMessage: "Help information",    hiddenLabel: false,    label: "Simple Vault",    labelPosition: "left",    labelWidth: 140,    padding: 0,    params: undefined,    preMessage: "",    required: true,    singleRequest: false,    successMessage: "",    target: "https://docs.dhtmlx.com/suite/backend/upload",    width: "content",}

The returned object of the SimpleVault control can contain the following configuration attributes:

width(string|number|"content") the width of a control
height(string|number|"content") the height of a control
padding(string|number) sets padding between a cell and a border of the SimpleVault control
required(boolean) defines whether a control is required
label(string) specifies a label for a control
labelWidth(string|number) sets the width of the label of a control
hiddenLabel(boolean) invisible label that will be used to identify the input on the server side
labelPosition(string) defines the position of a label: "left"|"top"
helpMessage(string) adds a help message to a control
preMessage(string) a message that contains instructions for interacting with the control
successMessage(string) a message that appears in case of successful validation of the control value
errorMessage(string) a message that appears in case of error during validation of the control value
fieldName(string) the name of the file field in the form data that is sent to the server
params(object) extra parameters for sending an XMLHttpRequest
singleRequest(boolean) defines whether files are sent in one request
target(string) mandatory, sets an URL to the server-side script that will process file upload

Change log:

added in v7.0