Element Details: Input Checkbox List
 Back


Available in: Logi Info Source code name: InputCheckboxListIntroduced in: v10.2.224  

Displays a list of checkboxes.

The list comes from a DataLayer. Set the CaptionColumn attribute to a data column from the DataLayer that contains the value(s) to be displayed on the screen. Set the ValueColumn attribute to a data column that contains the value(s) to be returned in @Request token. Multiple values are returned in a comma-delimited list.

Element Group:User Input



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
Caption
UserDefined
The Caption attribute identifies the text to be displayed. For Image elements, Caption specifies the image filename.
CaptionClass
UserDefined
For Input elements, this is style sheet class that will be applied to the input element's caption. Leave this value blank unless you want the Caption to have a different class than the input element. For tables, Caption Class sets the class for the table's caption, which appears as a header above the table.
ChangeFlagElementID
UserDefined
ChangeFlagElementID helps Process Tasks know when an input value has been changed by the user. For example, a Process may only UPDATE rows when the user actually changed something, and otherwise skip the UPDATE. Set ChangeFlagElementID to the ID of an InputHidden element. Then, if the user changes this input element, the hidden element's value will become "True". You can test for this value in a Procedure.If. When using ChangeFlagElementID with an Input element that's under a DataTable, be sure to put the InputHidden element under a DataTableColumn. Process input from individual rows under a Procedure.RunDataTableRows. ChangeFlagElementID relies on the Javascript "onchange" event, so you will not be able to use your own "onchange" EventHandler with ChangeFlagElementID.
CheckAllCaption
UserDefined
Specifies a caption for "Check all" checkbox. A value of "none" hides it altogether. The default value is "Check all".
CheckboxListDropdown
True
False
Controls an InputCheckboxList element view. When set to True, then the Dropdown element will be rendered.
Class
UserDefined
Sets the Cascading Style Sheet class used by the element. When set, this class will also be used by all child elements that don't have their own class. The class should be defined in the report's style sheet file.
ColumnCount
%
Sets the number of columns. This attribute is automatically 1 for Input Checkbox Lists with Checkbox List Branch elements as children. This is limited to 100 columns.
DefaultValue
UserDefined
The default value displayed or selected when the report page is initially displayed. For the InputSelectList element, to show multiple selected values, this attribute can be over-ridden by adding a DefaultValues element with a DataLayer below that.
DropdownButtonClass
UserDefined
Sets the Cascading Style Sheet class used by the dropdown button. For example: .MyButton { /*button text*/ color: red; } .MyButton . rd-checkboxlist-icon { /* dropdown image*/ background-image: url("myImage.png"); }
DropdownNoneSelectedCaption
UserDefined
The text that appears in the InputCheckboxList when there are no items selected. The default is "Select options".
DropdownSelectedCaption
UserDefined
As items are checked, they are listed in the dropdown area. When there are too many items to be shown, the text changes to show the number of items selected. Use the "#" character to set the placeholder for the number of items. The default is "# selected". So if ten are checked, the text is "10 selected".
Height
UserDefined
The height of the element. For some elements, leave the height blank to automatically size the element to the height of the content.
HeightScale
px
%
The width scale of the element. Value can be "px" for pixels, or "%" for percentage of the available height. Leave this value blank to have the frame automatically adjust to the size of its contents.
ID
UserDefined
(Required) The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
ListCaptionsElementID
UserDefined
To return captions of selected items, create an InputHidden element, assign it an ID, then set that ID in this attribute. When the report is submitted, the selected captions are available in an @Request token with that ID.
MultiSelect
True
False
When set to True, the user may select multiple options. All the selected values may be referenced with @Request.x~, where "x" is the ID of the list element. (@Request.x~ just returns the first selected value.) Normally, each value is separated by a comma. Frequently, these values are used in SQL "IN" clauses in conjunction with the @SingleQuote token. For example: ...WHERE LastName IN(@SingleQuote.Request.x)... For the InputSelectList, the user may choose more than one selection by clicking while holding down the Ctrl and Shift keys. When using the DefaultValue attribute, you may have more than one pre-selected value. Again, these values are normally separated by a comma. For the InputSelectList the default is False. For the InputCheckboxList the default is True.
OptionCaptionColumn
UserDefined
UserDefined
(Required) Enter the name of a column from the DataLayer. Values in the column will be displayed on the screen.
OptionTooltipColumn
UserDefined
Enter the name of a column from the DataLayer. Values in the column will be displayed on the screen as a tooltip.
OptionValueColumn
UserDefined
(Required) Enter the name of a column from the DataLayer. Values in this column get sent back to the server when the page is submitted. They are available with @Request tokens.
SaveInCookie
True
False
Saves the information entered by the user in a cookie. You can use the cookie to set the default value so that previously entered data is retrieved. Hint: Set the Default Value attribute to something like "@Cookie.myInputId~". SaveInCookie does not work under DataTables and other data-repeating elements.
SaveInLocalStorage
True
False
LocalStorage stores data in the browser. The information is maintained between sessions. SaveInLocalStorage uses the browser's localStorage to preserve input values so they re-appear when a page is redisplayed. It is a way of keeping default values. Set SaveInLocalStorage="True" to preserve and restore input values. SaveInLocalStorage is over-ridden by DefaultValue attributes. Do not use SaveInLocalStorage and DefaultValue attributes together. SaveInLocalStorage does not work under DataTables and other data-repeating elements. LocalStorage requires browser support. IE7 does not support LocalStorage.
SecurityRightID
UserDefined
When entered, access to this element can be controlled with Logi security. Supply the ID of a right defined in the applications settings’ Security element. Only users that have a right in the SecurityRightID will be able to see the element. Note that when rights come from RightFromRole elements under Security/UserRights, and this element's SecurityRightID does NOT match any of the Right IDs defined in the Settings definition, then the user DOES have access. But when Right IDs are instead derived from RightsFromDataLayer or RightsFromRoles elements, and the user DOES NOT have a matching Right, then the user DOES NOT have access. You can enter multiple right IDs, separated by commas. In this case, the user sees the element if he has any one of the Rights.
Tooltip
UserDefined
Text that appears when the user hovers the pointer over the image or text.
Width
UserDefined
The width of the element.
WidthScale
px
%
The width scale of the element. Value can be "px" for pixels, or "%" for percentage of the available width.



PARENT ELEMENTS

Click element to drill down for more information.

Body
Column Cell
Data Table Column
Division
Fieldset Box
HTML Tag
Input Grid
List Item
More Info Row
More Info Row Column
Panel Content
Panel Parameters
Popup Panel
Rectangle
Report Footer
Report Header
Responsive Column
Tab Panel


CHILD ELEMENTS

Click element to drill down for more information.

Checkbox List Branch
DataLayer.Bookmarks
DataLayer.Cached
DataLayer.CSV
DataLayer.Definition List
DataLayer.Directory
DataLayer.Excel
DataLayer.Fixed Format File
DataLayer.Google App
DataLayer.Google Spreadsheet
DataLayer.JSON
DataLayer.LDAP
DataLayer.Linked
DataLayer.Mongo Find
DataLayer.Mongo Map Reduce
DataLayer.Mongo Run Command
DataLayer.Plugin
DataLayer.REST
DataLayer.Scheduler
DataLayer.SP
DataLayer.SQL
DataLayer.Static
DataLayer.Twitter
DataLayer.Web Feed
DataLayer.Web Scraper
DataLayer.Web Service
DataLayer.XML
Default Values
Event Handler
Validation.Required


 Back to top


© Copyright 2007-2019 Logi Analytics, Inc. All Rights Reserved          |          Contact DevNet          |          Site FAQs          |          Terms of Use          |          LogiAnalytics.com