PropertyEventMethodIndex
WebSquare.uiplugin.aliasDataList - 5.0_4.4547B.20211124.201933

Allows to refer to the DataList in the main (or parent) page when the scope feature is used.

Type

uiplugin

Property Summary

id
aliasDataList ID
scope
DataList ID in the main (or parent) page being referred to. (Only the parent page can be referred to. Referring to sibling pages are to be supported.)
studioSrc
A property dedicated to the WebSquare5 Studio to get the information of the parent page.
userData1
User-defined property
userData2
User-defined property
userData3
User-defined property

Event Summary

Method Summary

getObj( )
Returns the dataList object that the aliasDataList is currently referring to.
setScope( scope )
Dynamically sets the scope. Dynamically changes the dataList currently being referred to.

Property Detail

id
aliasDataList ID Allocated as a global object.
scope
DataList ID in the main (or parent) page being referred to. (Only the parent page can be referred to. Referring to sibling pages are to be supported.)
ID of the DataList to refer to in a form of a relative path or absolute path.
Remains empty when the linked DataList is not found or the referred object type is not dataList. (Example) (1) Refers to the dataList1_main1 in the highest page. (Relative path) scope="../../dataList_main1" (2) Refers to the dataList1_main2 in the highest page. (Absolute path) scope="/dataList_main2"/ (3) Refers to the dataList1_wframe1 in the higher page (Relative path) scope="../dataList_wframe1" (4) Refers to dataList1 in wframe1. (Absolute path) scope="/wframe1/dataList1_wframe1"/
studioSrc
A property dedicated to the WebSquare5 Studio to get the information of the parent page.
userData1
User-defined property. Use getUserData("userData3") to get the data. // Example getUserData("userData1");
userData2
User-defined property. Use getUserData("userData2") to get the data. // Example getUserData("userData2");
userData3
User-defined property. Use getUserData("userData3") to get the data. // Example getUserData("userData3");

Event Detail

Method Detail

getObj( )
Returns the dataList object that the aliasDataList is currently referring to.
Return
typedescription
ObjectDataList object being referred to in the current scope.
Sample
// Return the object specified in the scope. var parentDataList = aliasDataList1.getObj();
setScope( scope )
Dynamically sets the scope. Dynamically changes the dataList currently being referred to.
The aliasDataList and the bound components are initialized.
Parameter
nametyperequireddescription
scopeStringYPath of the dataList to refer to.
Sample
// Dynamically change the DataList to be referred to. aliasDataList1.setScope("/dataList1");