wscontrols
Configuration of Controls in Worksheet
{
"cid":"string", // Control ID
"wsid":"string", // Worksheet ID
"name":"string", // Name
"type":"int", // Control type. Refer to enumeration
"attribute":"int", // Attribute. 1: Title
"enumdef":"int", // Subtype. Refer to the enumeration
"enumdef2":"int", // Subtype. Refer to the enumeration
"dtsrc":"string", // Source data. Refer to the description
"sourcecid":"string", // Source control ID
"unit":"string", // Unit
"opts":[{
"Key":"string", // Unique key value
"Value":"string", // Text value
"IsDeleted":"bool", // Deleted or not
"Index":"int", // Sorting
"Color":"string", // Color value
}], // Option (Positioning information)
"noticeitem":"int", // Notification item (control of members). 0: no notification, 1: add notification
"userpermission":"int", // Permissions (control of members). 0: entry only, 1: member, 2: owner
"showcids":["string"], // ID list of fields displayed in the associated worksheet
"unique":"bool", // Unique value verification
"covercid":"string", // ID of cover control (single row association)
"defmen":["string"], // Default account ids, all in array, creator: user-self
"desc":"string", // Field description
"strdefault":"string", // General string field. Refer to description
"fieldpermission":"string", // Null or "111", the 1st digit represents whether can view; the 2nd digit represents whether can edit (read-only); the 3rd digit represents whether can add; 1: can, 0: cannot,
"adset":[{
"key":"string", // Configuration key. Refer to the following description
"value":"string" // Value. Refer to the following description
}], // Advanced settings (dictionary<string,string> for configuring transfers)
"alias":"string", // Alias (for API)
}
Contol Type (type)
| Control | Enum value | Description |
|---|---|---|
| Text | 1 | Text (Deprecated) |
| TextArea | 2 | Text |
| MobilePhone | 3 | Telephone |
| Landline | 4 | Landline |
| 5 | ||
| Number | 6 | Numeric |
| Certificates | 7 | ID Number |
| Amount | 8 | Amount |
| Radio | 9 | Choice |
| CheckBox | 10 | Choices |
| Select | 11 | Dropdown |
| Attachment | 14 | File |
| Date | 15 | Date |
| DateTime | 16 | Time |
| District | 19/23/24 | Region/City |
| Relation | 21 | Free Link |
| SplitLine | 22 | Line |
| BigAmount | 25 | Uppercase |
| UserSelect | 26 | Members |
| DepartmentSelect | 27 | Department |
| Score | 28 | Level |
| RelationWorksheet | 29 | Relationship |
| RelationWSColumn | 30 | Foreign |
| WSFormula | 31 | Formula |
| FormulaString | 32 | Concat |
| Increase | 33 | Autonumber |
| DetailTable | 34 | Subform |
| Cascade | 35 | Cascading |
| CheckRadio | 36 | Check items |
| Summary | 37 | Rollup |
| FormulaDate | 38 | Formula (date) |
| ScanCode | 39 | Scan Code |
| Location | 40 | Positioning |
| RichText | 41 | Rich Text |
| Signature | 42 | Signature |
| OCR | 43 | OCR |
| Role | 44 | Application Role |
| Embed | 45 | Embedded |
| Time | 46 | Time |
| Code | 47 | Barcode |
| OrgRole | 48 | O-roles |
| Btn | 49 | Query Button |
| Search | 50 | API Query |
DataSource Description(dtsrc)
| Control | Value Description |
|---|---|
| BigAmount | Referenced Field ID |
| RelationWorksheet | Associated Worksheet ID |
| RelationWSColumn | Associated Control ID |
| FormulaDate | Formula ID or End Date Field ID |
| Select/CheckBox/Radio | Option Set ID |
| Embed | URL or ID of Embedded Object |
| Code | Referenced Field ID |
EnumDefault Description(enumdef)
| Control/Value | 0 | 1 | 2 | 3 | 4 | 5 |
|---|---|---|---|---|---|---|
| TextArea | Default single line is multi-line | Multi-line | Single line | |||
| MobilePhone | International numbers | Non-International | ||||
| UserSelect | Single | Multiple | ||||
| DepartmentSelect | Single | Multiple | ||||
| Score | 1-5 star | 1-10 level | ||||
| RelationWorksheet | Relationship | Subform | ||||
| Increase | Original number | Number of digits in format | ||||
| Summary | Refer to enumeration | |||||
| FormulaDate | Duration | Add/subtract a date | Time between a date and today | |||
| Attachment | New ones in front | Old ones in front | ||||
| Location | Not show map | Show map | ||||
| Number | Show thousandths | Not show thousandths | ||||
| Select/CheckBox/Radio | Enable score | |||||
| OCR | General Recognition | ID Card | Invoice Recognition | |||
| Embed | iframe | Chart | ||||
| Code | Barcode | QR code |
EnumDefault2 Description (enumdef2)
| Control | Value Description |
|---|---|
| TextArea | 0: No format validation, 1: Format validation |
| Increase | Display digits |
| RelationWorksheet | Single digit for creation permission, ten digits for association permission. 1 for disable. 0: All allowed, 1: Disable addition, 10: Disable association, 11: Disable addition and association. |
| Summary | Enumeration value for the summary result. Refer to the control type |
| Radio/Select | 0 or null: Not enabled, 1:Enable Colorful |
| FormulaDate | 1: Ignore year of end date |
| Attachment | 0: No restriction, 1: Take photo, 2: Take video, 3: Take photo or video |
| Location | Positioning range. 0: No restriction, 1: Current location |
| Select/CheckBox/Radio | 1: Enable Colorful |
| UserSelect | 0: No restriction on the selection range, 1: Restriction on the selection range |
| Code | QR code data source. 1: Internal link, 2: External link, 3: Field value |
StrDefault Description (strdefault)
| Control | Value Description |
|---|---|
| TextArea | The 1st digit indicates whether to disable album; the 2nd digit indicates whether to enable code scanning. "11": cannot select album, and enable code scanning |
| FormulaDate | Null or 0: start at 0:00, end at 0:00; 1: start at 0:00, end at 24:00 |
| RelationWorksheet | The 1st digit indicates whether to verify view and permission; the 2nd digit indicates whether to disable album; the 3rd digit indicates whether to allow only scan code to associate. "111": Verify permissions, disable albums, and scan code only |
| Attachment | The 1st digit indicates whether to disable album; the 2nd digit indicates whether to allow only mobile input. "11": cannot select album, and can only input on mobile |
| ScanCode | The 1st digit indicates whether to disable album; the 2nd digit indicates whether to allow only inputting on mobile. "11": can not select album, and can only input on mobile |
| Increase | increase New auto-numbering |
| RelationWSColumn | Null or 00: Redundant values, 10: Show only |
| Location | Null or 0: Locate position on map, 1: Get the current latitude and longitude (APP) |
AdvancedSetting Description (adset)
| key | Value Description (string) | Control-Default |
|---|---|---|
| filters | Associate filters | Relationship/Rollup |
| defsource | [{"rcid":"Control ID in associated worksheet","cid":"Control ID","staticValue":"string"}] | |
| hasdef | Whether or not the field has a default value when it is hidden. 1: Yes, 0: No | |
| getinput | Get value before filling form. 1: In advance, 0: Not in advance | |
| getsave | Submit form directly after getting. 1: Submit directly, 0: Not submit directly | |
| direction | Options arrangement | Selection |
| dismanual | Manual input. Null or 0: Allow, 1: Disable | |
| scantype | Code type. Null or 0, 1: only barcode, 2: only QR code | |
| distance | Distance, 100/200/500, in meters | Positioning |
| checkrange | Null or 0: No verification, 1: Verification | |
| min | Minimum | |
| max | Maximum | |
| summaryresult | Summary result. Null or 0: Value, 1: Percentage | Rollup |
| showtype | Display type. 1: Card, 2: List, 3: Dropdown box (tiled), 4: Dropdown tree, Null: Single-Card, Multiple-List | Relationship |
| showtype | Display type. 5:Year, 4:Year-Month, 3:Year-Month-Day, 2:Year-Month-Day-Hour, 1:Year-Month-Day-Hour-Minute, 6:Year-Month-Day-Hour-Minute-Second | Date |
| showtype | Display type. Null or 0: Checkbox, 1: Switch, 2: Yes/No | Check items |
| showtype | Display type. Null or 0: Value, 1: Percentage, 2: Progress | Numeric |
| showtype | Display type. 0: Dropdown, 1: Tile, 2: Progress | Choice |
| showformat | Format of display. Null or 0: ISO, 1: China, 2: US, 3: EU | Date |
| allowlink | Allow to view records. Null or 0: Not allow, 1: Allow | Relationship/Embedded |
| allpath | Show full path. Null or 0: Show last level, 1: Show full path | Cascading |
| anylevel | Allow to select any level. Null or 0: Select any level, 1: Select the last level | Cascading |
| hide | Hide or not. 1: Hide, Null or 0: Not hide | |
| ddset | Configure the drop-down box to display the cover. 1: Configure, Null or 0: Not configure | Relationship |
| dateformulatype | Calculation method. 1: Target date minus date of today, 2: Date of today minus target date | Formula |
| hideneg | Not show negative values. 1: Not show | Formula |
| increase | Autonumber configuration | Autonumber |
| showxy | Show latitude and longitude. 1: Show, Null or 0: Not show | Positioning |
| allowweek | Allowed combinations of days 1234567 of the week | Date |
| allowtime | Allowed interval 2:30-12:45 middle-split | Date |
| timeinterval | Preset interval to N minutes | Date |
| checktype | Type of multi-select box. 0 or null: Tile, 1: Dropdown | Selection |
| allowadd | Allow new options. 0: Not allowed, 1: Allowed | Selection-0/Subform-1 |
| allowcancel | Allow cancelling. 0: Not allowed, 1: Allowed | Relationship /Subform-1 |
| allowedit | Allow editing. 0: not allowed, 1: allowed | Sunform-1 |
| userrange | Users allowed to be selected | Members |
| regex | Regular expression {type="quick type on the left",regex="string",err="string"} | Text |
| ocrmap | OCR field mapping [{type="",name="",cid="",subId=""}] | OCR |
| allowcountries | Countries allowed to be selected [{iso2="cn",name="China",dialCode:"+86"}] | Telephone |
| commcountries | Frequently selected countries [{iso2="cn",name="China",dialCode:"+86"}] | Telephone |
| defaultarea | Default area code | Telephone |
| suffix | Formula suffix | Numeric type |
| prefix | Formula prefix | Numeric type |
| searchcontrol | Associate search fields | Relationship |
| searchtype | 0 or null: Fuzzy match, 1: Exact search | Relationship |
| clicksearch | 0 or null: Show directly, 1: Show data after search | Relationship |
| searchfilters | [{controlId:"string",filterType:int}] | Relationship |
| sorts | [{controlId:"string",isAsc:bool (false: Descending, true: Ascending)}] | Relationship/Sunform |
| weekday | Weekday 1234567 | Date formula |
| batchcids | [""]Bulk add fields | Subform |
| dynamicsrc | Default value for worksheet query [] | |
| defaultfunc | Default value of function | |
| defaulttype | Type of default value. Null or 0: Base default, 1: Function 2: Worksheet query | |
| nullzero | When the formula is empty, calculated as 0. Null or 0: Not as 0, 1: As 0 | Formula |
| usertype | User type. 1: Internal member, 2: External portal | Members-selection |
| watermark | Add watermark ["user","time","address","xy"] | File |
| maxcount | Maximum number | File |
| filetype | File type {type:int,values:[""]} | File |
| compress | Upload compressed attachments. Null or 0: Not compressed, 1: Compressed | File |
| width | Width | |
| height | Height | |
| allowsingle | Allow single addition | Subform |
| numshow | Null or 0: Normal display, 1: Show percentage, 2: Show progress | Numeric type |
| thousandth | Null or 0: Show thousandths, 1: Not show thousandths | Numeric type |
| itemicon | Icon style | Level |
| itemcolor | Color {type:int(1: Fixed, 2: Dynamic), color:"#000",colors:[{key:"1",value:"#000"}]} | Level/Numeric |
| itemnames | Custom text [{key:"1",value:"general"}] | Level/Check items/Numeric |
| showvalue | Show results. 0 or null: Not show, 1: Show | Level |
| numinterval | Interval | Numeric |
| showinput | Show input box | 0: Not show, 1: Show |
| faultrate | Error tolerance | Barcode |
| analysislink | Parse link. 1: Parse, Null or 0: Not parse | Text/Concat |