Formatted Grid component for Axiom forms

The data source for the grid. You must have defined the data source within the file using the appropriate tags in order to select it for the grid.

NOTE: In the Form Control Sheet, the selected data source is written as SheetName!DataSourceName. The sheet name is the sheet where the selected data source is located.

If a data source is already specified and you want to locate it within the file, click the Show location button to the right of the drop-down list. This will move your cursor to the associated data source tag in the file.

Specifies the loading behavior of the component:

• Inline (default): The component properties and data are both loaded when the form is loaded. This behavior causes the overall form load to take longer, because the component data must be loaded before any of the form can display on the web page. However, once the form does load, the component is fully rendered.

• Asynchronous: When the form is loaded, the component "shell" is loaded and rendered on the web page without the underlying data from the data source. This behavior speeds up the initial load of the form, because it does not have to wait for the component data to load. Once the form is rendered, a second pass is performed to load the component data. A loading spinner displays within the component "placeholder" until the data has finished loading.

NOTE: Asynchronous loading cannot be used with embedded forms. If the Formatted Grid component will be used inside an embedded form, it must use Inline loading.

The currently selected row in the grid. This setting is optional and should only be used if you want users to be able to select a row in the grid to impact the Axiom form in some way. The data source must have a [RowID] tag in order to use this feature.

This setting serves two purposes:

• It defines the initially selected row in the grid, if you want the grid to start with a particular row selected. You can leave this blank to specify that no row is selected, or enter a row ID from the RowID column in the data source.
• When a user views the form and selects a row in the grid, the row ID of the user's selection is submitted back to the source file and placed in this cell on the Form Control Sheet. Formulas can reference this cell in order to dynamically change the form based on the currently selected row in the grid.

For more information, see Selected row.

NOTES:  

• This setting supports indirect cell references. You can enter a cell reference in brackets, such as [Info!B3]. This causes the selected row ID to be read from and written to the specified cell reference instead of directly within the Selected Row ID cell.

• This setting supports use of the FormState tag and the SharedVariables tag, so that the selected row ID is stored in memory instead of written to the file, and therefore can be shared with other files. Form state can be used to share values between a form dialog and an active client spreadsheet, in the Desktop Client. Shared variables can be used to share values between multiple forms that are open in a shared form instance (embedded forms).

Specifies whether the Axiom form automatically updates when a user changes the state of the grid.

By default this is enabled, which means that the form automatically updates in response to user activity such as:

• Changing the selected row (if using RowID)
• Editing an unlocked cell in the grid

• Interacting with a special formatted grid feature, such as a drop-down list or a check box

If this setting is disabled, then edits made to the grid will not trigger an update. The changes will be submitted back to the source file when another component triggers an update, such as a Button component.

Specifies whether a special lightweight auto-submit behavior applies to input cells in the grid. If enabled, the following items are affected: simple unlocked cells and TextArea tags.

This option is intended for cases where users are inputting numbers into the grid, and you want to update total formulas and other calculations that reference these inputs, but without submitting all grid values or triggering a full form update.

When enabled, the following behavior applies:

• When a user edits an unlocked cell or a text box, only that new value is submitted back to the form source document on the server.
• The source document is calculated so that any formulas referencing the changed cell are updated. No data refresh occurs, just a calculation.
• If any of the following cell types in the grid have modified values after the calculation, the form web page is updated to display these new values: regular locked or unlocked cells, cells with Format tags, and cells with TextArea tags.

No other form values are submitted, and no other form components are updated. The regular form update process does not occur.

This option can be enabled by itself or in conjunction with Auto Submit. This option overrides auto-submit behavior for the affected cells, but all other cells can continue to use the regular auto-submit behavior or not as desired.

Specifies whether a save-to-database occurs when a form update is triggered by this component.

• If disabled (default), then changing this component does not trigger a save-to-database.

• If enabled, then a save-to-database will occur as part of the form update process when this component triggers an update. The save occurs after editable values have been submitted to the source file and after data has been refreshed in the source file. A save-to-database process must be enabled and configured within the source file. For more information, see Saving data from an Axiom form.

This setting only applies if Auto Submit is enabled for the component. If you are not using the auto-submit behavior but you do want to save data to the database from the Axiom form, then you should instead enable Save on Submit for the Button component that you are using to trigger the update process.

The title text for the component. This text displays in the title bar for the component within the Axiom form, if the title bar is enabled.

If the title bar is disabled, then this text does not display at all in the form. It is assumed that if you are not using the title bar, then you have defined title text in the grid itself.

NOTE: The font type / size / weight / style of the title text are dependent on the style or skin and cannot be changed.

Specifies whether the title bar is visible. By default this option is enabled, which means that the component will display in a bordered box with a title bar across the top. The defined title text displays within the bar. The formatting of the title bar and its border are determined by the skin specified for the form.

If disabled, then the title bar and its border will not display on the component.

Specifies whether the component automatically collapses in height if the configured component height is greater than the content to be shown in the component.

You should leave this option disabled if you want the component height to always be the same, no matter how much content is available to display. If the content exceeds the component height, the component will have a vertical scroll bar. If the content does not fill the component, then there will be blank space between the final row of content and the bottom edge of the component.

If you enable this option, then when the content does not fill the component, the component will auto-shrink to fit the content instead of maintaining its configured height. The behavior if the content exceeds the component height is the same (vertical scroll bar).

Specifies whether the height of the grid should extend to show all rows of the data source. By default this is disabled. If the rows included in the data source exceed the height of the grid component on the form canvas, then a vertical scroll bar will be present on the grid, allowing users to scroll to view all rows.

If this option is enabled, then the height of the grid will automatically extend downward to include all rows. If the rows exceed the size of the form window, then the user can scroll the window to view all rows. For more information on the impact of using extended height, see Setting row sizes for Formatted Grids.

This option is primarily intended for use when printing to PDF. If you define any PDF Settings, then it is automatically applied along with those settings. For more information, see Configuring a Formatted Grid component for printing to PDF.

Defines settings to apply to the grid when generating a PDF of the form. Click the [...] button to open the PDF Settings dialog and complete the settings. You can define the number of rows to show per page and configure header rows to repeat. For more information on these settings, see Configuring a Formatted Grid component for printing to PDF.

The name of the component. This is for identification in the file; this name does not display on the Axiom form canvas.

The name of the component identifies the corresponding settings for the component on the Form Control Sheet. The component names are also useful if you have multiple types of the same component within an Axiom form, so that you can tell which component you are currently editing.

Component names must be unique within a file and must start with a letter. Names can only contain letters, numbers, and underscores. Names are validated when the file is saved; an invalid name will prevent the save.

NOTE: Spaces are not allowed in component names and will be automatically removed by Axiom Software. For example, if you enter "My Component" as the component name, it will be automatically adjusted to "MyComponent".

Specifies whether the component is visible on the Axiom form (On/Off). By default this is set to On.

This setting can be used to dynamically show or hide the component using a formula. Keep in mind that if you have multiple components that you need to dynamically show or hide based on the same condition, then it is preferable to place those components on a dedicated layer and then show or hide the entire layer instead of the individual components.

NOTE: This setting is only available on the Form Control Sheet; it cannot be set in the Form Assistant or in the Form Designer.

The layer that the component belongs to on the Axiom form canvas. In the Form Assistant and the Form Designer, this displays as the layer name (for example: Layer 1). In the Form Control Sheet, this is recorded as the layer ID (for example: 1).

If the canvas only has one layer, then the component is automatically assigned to that layer and cannot be changed. If the canvas has multiple layers, you can assign the component to any layer using the drop-down list. By default, the component will be assigned to whichever layer is selected in the Layers box when you initially drag the component onto the canvas. For more information on layers, see Using multiple layers on the canvas.

If desired, you can jump to the applicable layer settings on the Form Control Sheet by clicking the binoculars icon next to the drop-down list.

Optional. The styles used to determine the formatting of the component. You can assign one or more styles.

Click the Select component styles button [...] to open the Choose Style dialog. Using this dialog, you can select one or more styles to apply to the component. The available styles depend on the component type and the skin assigned to the form. For more information, see Using component styles.

Some components have several styles that are specifically designed for that component type, while other components may only have the "generic" styles that are available to all components. When using a generic style, keep in mind that they may not be useful for all components. You can view a description of each style and view the effective formatting applied by the selected styles within the Choose Style dialog.

The reference location determines how the x-position and y-position of a component are evaluated. By default the reference location is UpperLeft.

NOTE: This setting is not exposed in the advanced component settings. It can be changed on the canvas by double-clicking the corner selection handles of a component, or you can edit the setting on the Form Control Sheet directly.

The x-position determines the component's position along the horizontal axis, and the y-position determines the component's position along the vertical axis. Both are evaluated relative to the reference location. Positions can be set in pixels (default) or percentages.

The order in which the component is rendered in the layer. A component with a larger order number will display above a component with a smaller order number.

For components that support tab navigation (tabbing to the next editable component), the rendering order also determines the tabbing order.

NOTE: On the Form Control Sheet, this setting is labeled as Z-Index.