SetFieldPropertyByRole Method
What it Does
Set all the fields of a given role (e.g. "1own") to a property setting (e.g. read only, hidden, required, etc.)
Parameters
Parameter | Type | Description |
|---|---|---|
| sender | FieldPropertiesInBulkByRole | Wrapper class of properties to be set up by role |
FieldPropertiesInBulkByRole object
Parameter | Type | Description |
|---|---|---|
| RoleName | String | The role to be used. All fields containing this role in the name will have the properties set up. E.g. "1own" will cover fields "1own.FName", "1own.MName", "1own.LName", "1own.Addr123", etc. |
| FieldVisibility | QFD.FieldVisibility | Sets the visibility of the field. Values:
|
| FieldReadOnly | QFD.FieldReadOnly | Sets the read-only level of the field. Values:
|
| FieldRequired | QFD.FieldRequired | Sets the required level of the field. Values:
|
| FieldMaskFlag | Boolean | If true, the field will be masked (password field) |
| FieldFormat | String | Sets the format to be applied to the value of the field |
| FieldCalcOverride | Boolean | If true, calculations are not enabled for the field. Usually used with calculated fields, like FullName or Addr123 |
| HiddenField | Boolean | If true, the field will be a hidden input (input type = "hidden") |
| FieldBackgroundColor | String | Sets the background color of the field. E.g "#CCC", or "#AABBCC" |
| MaxCharLength | String | Sets the maximum character length that may be entered into a field. For example, if MaxCharLength = "5", then users may not type a value into a given field that is more than 5 characters long–the value will cut off after the 5th character. However, this field may still be prefilled with data that is longer than 5 characters (maximum length only takes effect when values are manually typed onto the form by users). |
Sample Code
Dim objQFE As New QuikFormsEngine
Dim fieldProperties As New FieldPropertiesInBulkByRole() With {.RoleName = "2own", .FieldBackgroundColor = "#CCC"}
objQFE.SetFieldPropertyByRole(fieldProperties)
Dim fieldProperties2 As New FieldPropertiesInBulkByRole() With {.RoleName = "1rep", .FieldCalcOverride = True}
objQFE.SetFieldPropertyByRole(fieldProperties2)
Method overloads
Even though we strongly suggest using the method described above, the QuikFormsEngine includes old overloads for legacy implementations. The overloads are listed below and the idea is that the field properties are passed in as parameters instead of within a wrapper class.
Public Sub SetFieldPropertyByRole(FieldRole As String, FieldReadOnly As FieldReadOnly, FieldVisibility As FieldVisibility, FieldRequired As FieldRequired, FieldFormat As String, FieldMaskFlag As Boolean, FieldCalcOverride As Boolean, HiddenField As Boolean, FieldBackgroundColor As String) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldReadOnly As FieldReadOnly) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldVisibility As FieldVisibility) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldRequired As FieldRequired) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldFormat As String) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldFormat As String, FieldBackgroundColor As String) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldMaskFlag As Boolean) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldMaskFlag As Boolean, FieldCalcOverride As Boolean) Public Sub SetFieldPropertyByRole(FieldRole As String, FieldMaskFlag As Boolean, FieldCalcOverride As Boolean, FieldHiddenField As Boolean)
For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK