The input box is a sheet object that is used for entering data into QlikView variables and displaying their values.
Right-click on the input box to display the object menu. It can also be accessed from the Object menu, when the input box is the active object.
Using the Input Box
An input box consists of three columns in a multi box like layout. The first column shows a list of variables. The second column equal signs '=' and the third column the values of the variables. It can contain one or many variables, each one on a separate row.
Variables in QlikView are named entities containing a single data value, unlike fields which can (and normally do) contain multiple values. Also, whereas fields get their values from load and select statements in the script, variables get their values from let and set statements in the script, via automation calls, or by the help of input boxes in the layout.
Variables can contain numeric or alphanumeric data. If the first character of a variable value is an equal sign '=' QlikView will try to evaluate the value as a formula (QlikView expression) and then display or return the result rather than the actual formula text.
In an input box the current value of the variable is shown. By clicking on a value in the input box, the cell will turn into edit mode, so that a new value can be entered or the old one modified. If the variable contains a formula, that will now be shown rather than its result. The cell in edit mode will normally contain a ... button which opens up a full editor window to facilitate creation of advanced formulas. The function of a variable value cell in an input box could very well be compared to that of a cell in a spreadsheet.
Sometimes the input box variable value cell will contain a drop-down icon, giving fast access to recently used values or predefined values. A variable may have input constraints attached to it, barring input of all values which do not meet certain criteria. In certain cases a variable in an input box may be read-only, in which case it is impossible to enter edit mode.
The input box Object menu is opened by right-clicking the object. The menu commands are:
|Properties...||Opens the Input Box Properties page where its parameters can be set.|
Allows creating and sharing notes about the current object.
This cascade menu is only available when the Design Grid command of the View menu is activated or when the Always Show Design Menu Items under User Preferences: Design is checked. It contains four commands to set the layout layer of the sheet objects. Valid layer numbers are -128 to 127.
|Print...||Opens the Print dialog where print settings can be specified.|
|Print as PDF...||
Opens the Print dialog with the PDF-XChange 3.0 printer pre-selected. After pressing the Print button you will be prompted for a file name for the PDF output file. This command is only available if a PDF printer is available on the system.
|Send to Excel||Exports the input box values to Microsoft Excel, which is automatically launched if not already running. The exported values will appear in a new Excel worksheet. For this functionality to work Microsoft Excel 2007 or later must be installed on the computer.|
Opens a dialog where you can export the contents of the input box to a file of your choice. The file can be saved as any of the following formats: Comma Delimited, Semicolon Delimited, Tab Delimited, Hypertext (HTML), XML and Excel (xls or xlsx). The default format is *.qvo (QlikViewOutput), a tab separated file.
|Copy to Clipboard||This cascade menu contains the various copy
options for the sheet object.
Copies the data rows of the input box to the clipboard.
Copies the text value of the input box cell right-clicked upon (when invoking the Object menu) to the clipboard.
Copies an image of the sheet object to the clipboard. The image will include or exclude the sheet object caption and border depending on the settings in the User Preferences: Export page.
Copies the entire sheet object to the clipboard for pasting elsewhere in the layout or in another document opened within the current instance of QlikView.
Opens a menu with the following commands for linked objects.
|Minimize||Iconizes the object. Clicking on the icon in the object caption (if shown) produces the same result. This command is available only if minimizing is allowed in the object's Properties dialog on the Caption page.|
|Maximize||Enlarges the object to fill the sheet. Clicking on the icon in the object caption (if shown) produces the same result. This command is available only if maximizing is allowed in the object's Properties dialog on the Caption page.|
|Restore||Restores a minimized or maximized object to its previous size and location. Double-clicking the icon of a minimized object or clicking the icon in the object caption (if shown) of a maximized object produces the same result. This command is available only for minimized or maximized objects.|
|Help||Opens QlikView help.|
|Remove||Removes the sheet object from the sheet.|
The Input Box Properties : General page is opened by a right-click on an input box and choosing the Properties command in the float menu. Here it is possible to set general parameters of the input box.
The text to appear in the input box caption area. The title can be defined as an expression for dynamic update of the label text. Click the ... button to open the Edit Expression dialog for easier editing of long formulas.
|Available Variables||All available variables are listed in this column. To include the system variables, mark the Show System Variables check box. Select the items to be used/removed by clicking them. Use the Add > or the < Remove button to move them to the desired column.|
|Show System Variables||Makes the system variables show in the list of Available Variables.|
|New Variable||Opens the New Variable dialog where a custom variable may be defined.|
|Displayed Variables||Variables to be displayed in the input box are listed in this column. Initially the column is empty.|
|Promote||Moves a variable upwards in the display order.|
|Demote||Moves a variable downwards in the display order.|
An alternative name to be used as variable title in the input box, can be entered here. The label may be defined as an expression for dynamic update. Click the ... button to open the Edit Expression dialog for easier editing of long formulas.
|Alternate State||Choose one of the available states in the list. The following Alternate States are always available.
The sheets and sheet objects are always in the inherited state unless overridden by the QlikView developer. This setting is inherited from the object on the level above, a chart in a sheet gets the same settings as the sheet if inherited is chosen.
This is the state where most QlikView usage occurs and is represented by $. The QlikView document is always in the default state.
This is used for macro purposes. Every sheet object is assigned a unique ID, which for input boxes start with IB01. Linked sheet objects share the same object ID. You may edit this ID number later on.
|Variables||Shows a list of all variables in the current input box. When a variable name in the list is selected the properties of that variable can be modified.|
|Show Equal Sign||Uncheck this box if you do not want the equal sign to be displayed in the input box. This setting is general for all variables.|
|Background...||Opens the Background Settings dialog.|
|Alignment||The alignment of the variables can be set. The variables can be individually set to left, center or right aligned.|
|Row Colors||In this group individual color settings can be made for the row selected
in the Variables list to the left.
Specifies the background color of the selected row. The color can be defined as a solid color or a gradient via the Color Area dialog that opens when clicking the button.
Specifies the text color of the selected row.
Apply to all rows
By selecting this check box before clicking Apply or OK the selected colors will be applied to all rows of the input box.
The Input Box Properties: Constraints page is opened by right-clicking on an input box and choosing the Properties command in the float menu. The script variables that have been added to Displayed Variables in the input box properties are listed in the Variables list on the Constraints tab where it can be modified.
The Document Properties : Variables page is accessed from Settings: Document Properties: Variables. The list of variables may be modified by the Show System Variables option. The New... button adds a new variable to the document. Delete button removes the selected variable.
In the Settings for Selected Variable group the edit box displays the current Value of the selected variable. The value may be entered as a calculated formula. Click on the ... button to open the Edit Expression dialog.
Variables are normally not included in bookmarks, but here it is possible to check the option Include in Bookmarks.
In the Input Constraints group specify constraints against which all values entered into an input box variable by the user will be checked. If a value does not meet the constraints specified, it will be rejected and an error message may be shown. The following alternatives are available:
|No Constraints||Input values are not checked against any specified constraints.|
|Standard||Input values will be checked against one of a number of common standard constraints selected from the drop-down box. As default no constraint at all is selected, i.e. any value can be entered into the variable. Only one of the alternatives: Standard, Custom, Predefined Values Only and Read-only can be checked.|
|Custom||Input values will be checked against a user specified constraint. The
constraint is entered in the edit box and must be expressed as a QlikView
expression returning TRUE (non-zero value) if the input value is acceptable.
The input value is referenced as a dollar sign ($) in the expression.
$>0 will cause the input box to accept only positive numbers in the selected variable.
The previous value of the variable can be referenced by the variable name.
$>=abc+1 as a constraint on a variable named abc will cause the input box to accept only numeric entries with a value of the old value plus 1.
|Predefined Values Only||Input values will be checked against a list of values defined in the Predefined Values group. Only input values found in the list will be accepted.|
|Read-only||Marks the variable as read-only. No values can be entered.|
|Enable Edit Expression Dialog||Check this alternative to enable editing of the variable value in the Edit Expression dialog, which is opened from the ... button that appears when clicking on the value itself.|
|Sound on Illegal Entry||Check this alternative to have QlikView issue a sound warning when the user attempts to enter a value which falls outside of the constraints.|
Normally, if the user attempts to enter a value which falls outside of the constraints it will just be rejected, leaving the present variable value in place. By checking this alternative it is possible to specify a custom error message which will be presented to the user in case of incorrect entries. The error message is typed in the edit box. It may be defined as an expression for dynamic update. Click the ... button to open the Edit Expression dialog for easier editing of long formulas.
In the Value List group it is specified if and how to present a list of values for an input box.
|No List||No list of values previously used in the variable is maintained.|
|List _ Recent Values||A drop-down (MRU) list with the values most recently used, will be available to the user for the selected variable in the input box. The number of previous values to store can be set in the box.|
|Predefined Values in Drop-down||A drop-down list with Predefined Values will be available to the user for the selected variable in the input box.|
|Predefined Values with Scroll||A scroll control will be available to the user for the selected variable in the input box. The scrolling will be made between the Predefined Values.|
|Number Series||Check this alternative to generate a list of predefined numeric values based on a lower limit (From), an upper limit (To) and a Step value. This option can be used alone or in combination with Listed Values.|
|Listed Values||Check this alternative to specify a list of arbitrary predefined values. The values can be either numeric or alphanumeric. Alphanumeric values must be enclosed in quotes (e.g. 'abc'). Each value is separated by a semicolon ( ; ) (e.g. 'abc';45;14.3;'xyz' ). This option can be used alone or in combination with Number Series.|
|Comment||This is a commentary field where the creator of a variable can describe its purpose and function.|
The Input Box Properties : Number page is opened by a right-click on an input box and choosing the Properties command from the float menu.
This property page provides formatting settings for all variables of the input box. The number formatting can be set individually for variables by selecting one or several variables (Click, Shift-click or Ctrl-click) in the Variables text box.
Each variable has a default number format which can be set in the document properties.
It is however possible to use a separate number format for an individual sheet object. To do this, check the alternative Override Document Settings and specify a number format in the group control below. This property page applies to the active object and contains the following controls for formatting variable values:
|Mixed||Both numbers and text. Numbers shown in original format.|
|Number||Shows numeric values with the number of digits set in the Precision spinner box.|
|Integer||Shows numeric values as integers.|
|Fixed to _ Decimals||Shows numeric values as decimal values with the number of decimal digits set in the Decimals spinner box.|
|Money||Shows values in the format set in the Format Pattern edit box. An example of this format is shown in the Preview text box. The default format is the Windows Currency setting.|
|Date||Shows values that can be interpreted as dates in the format set in the Format Pattern edit box. An example of this format is shown in the Preview text box.|
|Time||Shows values that can be interpreted as time in the format set in the Format Pattern edit box. An example of this format is shown in the Preview text box.|
|Timestamp||Shows values that can be interpreted as date + time in the format set in the Format Pattern edit box. An example of this format is shown in the Preview text box.|
|Interval||Shows time as sequential time increment (e.g. format = mm shows the value as the number of minutes since calendar start ( 1899:12:30:24:00).|
The Show in Percent (%) button operates on the following formats: Number, Integer and Fixed to.
Decimal and Thousand separators can be set in the edit boxes of the Separators group.
The ISO button uses the ISO standard for the formatting of date, time and timestamp.
The System button applies the settings of the system to the formatting.
Here the Font, Font style and Size of the font to be used can be set.
The font can be set for any single object (Object Properties: Font), or all objects in a document (Apply to Objects on Document Properties: Font).
Further, the default document fonts for new objects can be set on Document Properties: Font. There are two default fonts:
- The first default font (List Boxes, Charts, etc) is used for most objects, including list boxes and charts.
- The second default font (Text Objects and Buttons) is used for buttons and text boxes, which are objects that usually need a larger font.
Finally, the default fonts for new documents can be set on User Preferences: Font.
For charts, buttons and text objects (except search objects) a font Color can also be specified. The color may Fixed or it can be dynamically Calculated from an expression. The expression must be a valid color representation, which is created using the color functions. If the result of the expression is not a valid color representation, the font color will default to black.
Additional settings are:
|Drop Shadow||If this option is checked a drop shadow will be added to the text.|
|Underline||If this option is checked the text will be underlined.|
A sample of the selected font is shown in the preview pane.
A Layout setting will apply to the current object only, if it is made
from the Object Properties
A Layout setting will apply to all objects of the specified type(s) in the document, if it is made from the Document Properties page.
Enable this setting in order to use a border around the sheet object. Specify the type of border by selecting it in the drop-down menu.
|Shadow Intensity||The Shadow Intensity drop-down menu makes it possible to set the intensity of the shadow that surrounds the sheet objects. There is also the choice of No Shadow.|
|Border Style||The following predefined border types are available:
A solid unicolored border.
Border giving the impression of depressing the sheet object from the background.
Border giving the impression of raising the sheet object from the background.
Border giving the impression of a wall around the sheet object.
|Border Width||This option is available for all border types. The width can be specified in mm, cm, inches (", inch), pixels (px, pxl, pixel), points (pt, pts, point) or docunits (du, docunit).|
|Color||Click this button to open a dialog in which an appropriate base color can be chosen from the color palette for all border types.|
|Rainbow||Creates a rainbow colored border for all border types. The rainbow will start with the selected base color on top of the sheet object.|
When Simplified is the chosen Styling Mode in Document Properties: General, there is no choice of border type, there is only the Shadow Intensity drop-down menu and the Border Width setting.
In the Rounded Corners group the general shape of the sheet object is defined. These settings allow for drawing of sheet objects ranging from perfectly circular/elliptical via super elliptical to rectangular. Rounded Corners is only available if you have selected Advanced Styling Mode in Document Properties: General.
|Rounded Corners||Checking this option makes the alternatives for rounded corner shapes possible.|
|Corners||Corners for which the check box remains unmarked will be drawn rectangular instead.|
|Squareness||A variable number between 2 and 100 where 100 defines a rectangle with perfectly square corners and 2 corresponds to a perfect ellipse (a circle for a 1:1 aspect ratio). A squareness between 2 and 5 is usually optimal for achieving rounded corners.|
|Corner Radius||This setting determines the radius of the corners in fixed distance (Fixed) or in percent of the total quadrant (Relative (%)). This setting lets you control the extent to which the corners will be affected by the underlying general shape set under Squareness. The distance can be specified in mm, cm, inches (", inch), pixels (px, pxl, pixel), points (pt, pts, point) or docunits (du, docunit).|
In the Layer group an object can be defined as residing in one of three layers:
|Bottom||A sheet object with the Bottom layer property can never obscure sheet objects in the Normal and Top layers. It can only be placed on top of other sheet objects in the Bottom layer.|
|Normal||When created, sheet objects reside in the Normal (middle) layer. A sheet object in the Normal layer can never be obscured by sheet objects in the Bottom layer and can never obscure sheet objects in the Top layer.|
|Top||A sheet object in the Top layer can never be obscured by sheet objects in the Normal and Bottom layers. Only other sheet objects in the Top layer can be placed on top of it.|
|Custom||The Top, Normal and Bottom layers correspond to internally numbered layers 1, 0 and -1 respectively. In fact all values between -128 and 127 are accepted. Choose this option to enter a value of your choice.|
Opens the Theme Maker wizard where you can create a layout theme.
Apply Theme ...
You can apply a layout theme to the object, sheet or document.
In the Show group it is possible to specify a condition under which the sheet object is displayed:
|Always||The sheet object will always be displayed.|
The sheet object will be shown or hidden depending on a conditional function which will be evaluated continuously depending on e.g. selections etc. The sheet object will only be hidden when the condition returns FALSE.
Users with Admin privileges for the document can override all show conditions by selecting Show All Sheets and Sheet Objects in Document Properties: Security. This functionality can be toggled by pressing Ctrl+Shift+S.
In the Options group, it is possible to disallow moving and resizing of the sheet object. The settings in this group are only relevant if the corresponding check boxes are enabled in Document Properties: Layout and Sheet Properties: Security.
|Allow Move/Size||If this option has been deselected it will be impossible to move or resize the sheet object.|
|Allow Copy/Clone||If this option has been deselected it will be impossible to make a copy of the sheet object.|
When the info function is in use an info icon will be displayed in the window caption whenever a field value has information associated to it. If you don't want the info icon to be displayed in the caption, you can uncheck this option.
|Size to Data||Normally the borders around all table sheet objects in QlikView will shrink when selections cause the size of the table to be less than allocated size for the sheet object. By deselecting this check box this automatic adjustment of size will be turned off leaving any surplus space blank.|
Various controls for changing the scrollbar layout are located in the Scrollbars group:
|Preserve Scroll Position||
With this setting enabled, QlikView will try to preserve the scroll position of tables and charts with a scroll bar when a selection is made in another object. The setting must be enabled in User Preferences: Objects as well.
The scroll position is not preserved when you close the document.
|Scroll Buttons||Sets the scroll button color. Select a color by clicking the button. Note that medium gray tones often render the best results for scroll bars. Either color can be defined as a solid color or a gradient via the Color Area dialog that opens when you click the appropriate button.|
Sets the scrollbar background color. Select a color by clicking the button.
|Scrollbar Width||This control affects both the width and the relative size of the scrollbar symbols.|
Sets the scroll bar style. Select a style in the drop-down control. The Classic scroll bar style corresponds to QlikView 4/5 scroll bars. The Standard scroll bar style gives a more modern look. The third style is Light, which is a thinner, lighter bar.
The Styling Mode must be set to Advanced for the scroll bar style to be visible. This setting can be found on the General tab by opening the Settings drop-down menu and selecting Document Properties.
|Apply To...||Opens the Caption and Border Properties dialog where you can set where to apply the properties that have been set on the Layout page.|
A Caption setting will apply to the current object only, if it is made
from the Object Properties
A Caption setting will apply to all objects of the specified type(s) in the document, if it is made from the Document Properties page.
On the Caption page, specify layout options that are completely different from the general layout of the object.
|Show Caption||When this option has been checked a caption will be drawn at the top of the sheet object. List boxes and other "box objects" will have the option switched on by default whereas buttons, text objects and line/arrow objects will not.|
|Title Text||In the text box you can enter a title to be shown in the caption of the sheet object. Use the Font... button to change the caption font.|
Set the colors of the caption in its different states. The settings for Active Colors and Inactive Colors can be made separately from each other.
Click the Background Color or Text Color button to open the Color Area dialog. The Background Color can be defined as a solid or a gradient color on the Color Area dialog. Text Color can be defined a Fixed or a Calculated color using color functions.
|Wrap Text||If this option is checked, the caption will be displayed in two or more rows.|
|Caption Height (Lines)||Set the number of caption lines in this edit box.|
The precise size and position of the QlikView object can be determined and adjusted by the size/position settings for the Normal or Minimized QlikView sheet object. These settings are measured in pixels:
|X-pos||Sets the horizontal position of the left side of sheet object in relation to the sheet's left edge.|
|Y-pos||Sets the vertical position of the top side of sheet object in relation to the sheet's upper edge.|
|Width||Sets the width of the QlikView sheet object.|
|Height||Sets the height of the QlikView sheet object.|
The orientation of the caption label can be altered with the Caption Alignment options:
|Horizontal||The label can be horizontally aligned: Left, Centered or Right within the caption area.|
|Vertical||The label can be vertically aligned: Top, Centered or Bottom within the caption area.|
Many of the object menu commands of the sheet objects can be configured as caption icons. Select commands to be shown as caption icons by marking the check box to the left of each command in the list.
|Allow Minimize||When this option has been checked a minimize icon will be displayed in the window caption of the sheet object, providing that the object is minimizable. Furthermore, this will make it possible to minimize the object by double-clicking the caption.|
|Auto Minimize||This option becomes available when Allow Minimize is checked. When Auto Minimize is checked for several sheet objects on the same sheet, all but one will be automatically minimized at any time. This is useful e.g. for alternately displaying several graphs in the same sheet area.|
|Allow Maximize||When this option has been checked a maximize icon will be displayed in the window caption of the sheet object, providing that the object is maximizable. Furthermore, this will make it possible to maximizing the object by double-clicking the caption. If both Allow Minimize and Allow Maximize are checked, double-clicking will effect minimizing of the object.|
Here you may enter a help text to be displayed in a pop-up window. The help text may be specified as a calculated formula. This option is not available at document level. Click the ... button to open the Edit Expression dialog for easier editing of long formulas.
Enter e.g. a description of the sheet object. A help icon will be added to the window caption of the object. When the mouse pointer is over the icon, the text will be displayed in a pop-up window.