Salesforce

Table Appearance Control Properties (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

Table Appearance Control Properties (Magic xpa 4.x)

Property

Description

Mobile Support

Set Table BG Color

Specifies whether to set the background color for each column, for each row or for the entire table.

When Column is selected, the column’s color will be according to the Color property in each of the columns.

When Row is selected, the row’s color is taken from the Row BG Color property. Since version: 3.3

When Table is selected, the Table control’s color will be according to the Color property.

Platform specific: For Android and iOS devices, only the Table option is supported.

This property is not available in Web Client tasks.

BG Color

The color of the control taken from the Application Color repository.

When the Set Table Color property is set to Column, this color will be used for the remaining table area after the last column. Since version: 3.1

When the Set Table Color property is set to Row, this color will be used for the remaining table area after the last populated row. Since version: 3.3

Platform specific:

  • On Android and iOS devices, when a system color is used, a white color will be used as the background of the control.

  • On Android, using a transparent color in a Table control or in any control attached to it is not recommended since it will slow down the performance.

This property is not available in Web Client tasks.

Android and iOS

Alternating BG Color

The color of an alternating row for a table. The default value is zero (0). Magic xpa accepts zero as a valid value. This property does not support a dynamic value used in an expression. The Alternating BG Color property is disabled when the Set Table Color property is set By Column.

In runtime, the row background switches from the table color to the alternating color from one record to another. In the order of appearance, odd records display the table color and even records display the alternate color. When records are added or deleted, the background color of the affected records change depending whether they have become even or odd. When the table is not full, the table color and alternate color are displayed for the remaining rows.

Platform specific:

  • On Android devices, using an Alternate color is not recommended since it will slow down the performance.

  • On Android and iOS devices, when a system color is used, the alternate lines will appear white.

See also How Do I Show a Table Control with Alternating Colors?

This property is not available in Web Client tasks.

Android and iOS

Row BG Color

Defines the row color. This property is enabled when the Set Table BG Color property is set to Row.

Since version: 3.3

This property is not available in Web Client tasks.

Title BG Color

Defines the background color of the Table control’s title.

If the setting is defined as 0 (default), the background color will be grey.

Note:

  • This setting does not affect the table’s borders or separators, which will have the Windows colors.

  • This property does not affect the Table control’s title foreground color. The foreground color is taken from the column's Color property

Since version: 3.1 (Android and iOS support – Since version: 3.0)

This property is not available in Web Client tasks.

Android and iOS

Divider Color

Defines the color of the column dividers and line dividers. The dividers will appear using the color's Foreground value.

For the column divider, this property affects the color of both the divider on the column title and the divider in the lines area.

If the column divider is not shown, this property affects the line color of the column divider in the title.

If the line divider is not shown, this property does not affect the line divider.

This property does not affect the border color of the table. To change the table's border color, use the Border Color property.

Since version: 3.1

This property is not available in Web Client tasks.

Tooltip

Specifies whether a Tooltip is associated with this control. A number specifies the number of the Tooltip Help in the Help list.

You can enter an expression for a Tooltip so that the Tooltip is dynamic. You can create the expression in Unicode format.

Web Style

Defines whether the Web Client Table will be generated as Repeatable Items or Grid.

This property has three options:

  • HTML Table

  • Material Design Grid

  • Repeatable Items

This property is available in Web Client tasks only.

Since version: 4.0

Visible

Specifies whether the control will be visible to the user.

Android and iOS

Border

Specifies whether the control will have a border.

Online support: Since version: 2.0

Android and iOS support: Since version: 2.2a

This property is not available in Web Client tasks.

Android and iOS

Scroll Bar

Specifies whether the Table control has a scroll bar.

In Web Client tasks, the Scroll Bar property is enabled when the Web Style property is set to either Repeatable Items or HTML Table.

Scroll Bar Thumb

Specifies whether the location of the scroll bar thumb will be set incrementally according to the records fetched or according to the total number of records.

The available options are:

  • Incremental - The scroll bar thumb decreses in size as records are loaded into the table.

  • Absolute – The total number of records in the range will be calculated in advance and the thumb will appear in the proper place, that is, the scroll bar thumb location will be relative to the total number of records (even if only partial number of records were fetched from the database).

This property is enabled when the Scroll Bar property is set to True.

The Absolute scroll bar thumb is not supported for Local, ISAM and Space databases and is not supported when a Direct SQL, a range expression or a range on a variable from a link is defined in the task.

If the Preload View property is set to False and the value of this property is Absolute, then:

  • In order to get the number of records in the range, an additional count statement will be sent to the database. This might reduce the performance.

  • When Locate is used in the task, in order to know the position of the located record compared to the number of records in the range, an additional count statement will be sent to the database.

If the Preload View property is set to True, all of the records are loaded into the table, so the behavior will always be as Absolute. In this scenario, there will not be additional access to the database.

Since version: 3.3

In Online, the Scroll Here option enables you to jump directly to the clicked position when Preload View task property is set to False and Scroll Bar Thumb is set to Absolute (Since version: 4.6).

In RIA, the Scroll Here option enables you to jump directly to the clicked position when Scroll Bar Thumb is set to Absolute. The Scroll Here functionality is supported for Preload View also (Since version: 4.7).

This property is not available in Web Client tasks.

Line Divider

Specifies whether the table displays a divider between its rows.

Android and iOS support: Since version: 2.2a

See also How Do I Hide or Show the Table Control Dividers?

This property is not available in Web Client tasks.

Android and iOS

Row Highlight Style

The style by which the table highlights its current row. The available options are:

None – The current row will not be highlighted.

Frame – The current row is highlighted by a rectangular box surrounding the row. The color of the rectangle frame color is the foreground color defined in the Highlight Color property. When the Line Divider = False, the rectangle frame is displayed.

Background – The current row is highlighted by a background color specified in the Highlight Color property.

BG & Controls – The current row is highlighted by a background color just like the Background option. This mode also modifies the color of all controls in the current row to display highlighted color.

Android and iOS support: Since version: 2.3

This property is not available in Web Client tasks.

Android and iOS

Row Highlight Color

The highlight color according to the Row Highlight Style property. This property is disabled when the Row Highlight Style property is set to None.

When this property is set to zero (0), the operating system’s default color is used.

This property is not available in Web Client tasks.

Android and iOS

Inactive Row Highlight Color

The row highlight color of the Table control when the task runs in a subform and the task is not in focus.

When this property is set to 0 (default), the row will remain highlighted with the same color as the Row Highlight Color property

This property is disabled when the Row Highlight Style property is set to None.

The row highlight color will not be changed when:

  • The focus moves to another application.

  • The focus moves to a parallel program.

  • The focus moves back to the caller task in an orphan row.

Since version: 3.2b

This property is not available in Web Client tasks.

Title Height

The title height of a Table control. You can also set this property by clicking and dragging the lower border of the title bar in the Form Designer.

It is applicable when 'Absolute Position' is checked on Web Generation settings.

Enabled when Web Style is set to Mat Grid.

Disabled when Web Style is set to Repeatable Items.

Android and iOS

Row Height

The row height of a Table control. You can also set this property by clicking and dragging the lower edge of the first row of the table.

It is applicable when 'Absolute Position' is checked on Web Generation settings.

Enabled when Web Style is set to Mat Grid.

Disabled when Web Style is set to Repeatable Items.

Android and iOS

Bottom Position Interval

Specifies how the bottom position of the Table control will be displayed. The options are:

Row Height – The bottom position displays only full rows in the Table control.

None (default) – Partial rows are displayed and the bottom position matches the full height of the table. As you increase the size of the Table control, the table increases pixel by pixel.

This property is available in Online tasks only.

Columns

The number of columns in a Table control. The number of columns can only be changed from the form layout.

Column Divider

Specifies whether the table displays a divider between its columns.

See also How Do I Hide or Show the Table Control Dividers?

This property is not available in Web Client tasks.

Allow Column Resize

Specifies whether to allow the end user to change the size of each column by dragging the adjacent column divider. A column can be resized in two ways:

  • Clicking on a column divider and dragging it to a different location – This action modifies the width of the columns on both sides of the divider.

  • Clicking on a column divider, pressing the Shift key and dragging it to a different location – This action modifies the width of the column positioned on the left side of the column divider (in RTL projects it will be for the column on right) and the table width will be affected accordingly.

Resizing the column by its right divider will increase the size of the column and push the remaining columns to the right. The remaining columns will maintain their size, so increasing the size of the column will increase the size of the entire table. Though the table will be the same size on the form, fewer columns will be displayed. When the table is resized so that the table columns cannot be displayed together, a horizontal scroll bar will appear for the table.

This property is not available in Web Client tasks.

Allow Column Reorder

Specifies whether the end user can re-order the columns at runtime. When set to Yes, the end user can change the order of the columns by dragging a column by its header by pressing the left mouse button and dragging the column along the table title. When releasing the mouse button, the dragged column is located at the new location, moving the remaining columns to the right.

This property is not available in Web Client tasks.

Fill Width

Specifies whether the columns will be spread over the width of the entire table. This lets you automatically resize the other columns if a column gets hidden or visible or if a vertical scroll bar appears.

This property does not change the width of the table.

If this property is set to True, then:

  • When the form is loaded, if the table has a blank area, the placement will be done and the columns will occupy the entire width of the table (except for the vertical scrollbar area).

  • When a column gets hidden or visible, the rest of the columns will be resized (according to the column’s placement) on the entire table width.

  • If the table has a horizontal scrollbar and you hide a column then:

    • If after hiding the column there is still a horizontal scrollbar, no resize will occur.

    • If after hiding the column there is empty space in the table, the placement will take place.

  • When a column becomes visible then:

    • If the table has a horizontal scroll bar, the column will be added without affecting other columns.

    • If the table does not have a horizontal scroll bar, the rest of the columns will be shortened (according to the placement values) and the new column will be added so that all the columns will occupy the table width.

Note: In version 1.9, for non-Windows tables with Keep Width=Yes, only the nearest column was resized. In Magic xpa 3.1 and above, all of the columns take part in the placement mechanism.

Since version: 3.1

This property is not available in Web Client tasks.

Multi Marking

Specifies whether to allow the end user to multi-mark various rows displayed in the table, perform user defined logic on all the marked rows, and use the Magic xpa internal Delete operation on all the marked rows.

Note: When the Cache Strategy is set to None, it is not possible to multi-mark records.

This property is available in Online tasks only.

Multi Column Display

Specifies whether or not controls can exceed their column.

False means that the controls in the table will be cut at the end of the column (as in Magic xpa 3.0).

True means that the controls in the table can be shown on multiple columns (as in uniPaaS 1.9).

Since version: 3.1a

This property is not available in Web Client tasks.

Show Ellipsis

Specifies whether an ellipsis will be shown in the column title if the title text is larger than the column’s width.

Since version: 3.2b

This property is not available in Web Client tasks.

Number of Frozen Columns

Defines the number of columns to be frozen. The valid values for this property are between 0 to (Total number of columns - 2). If the value specified is greater than this then a checker warning is displayed.

This property is available in Online and RC tasks.

This property is not supported for Right to Left Table.

Since version: 4.6

Frozen Columns Divider Color

Demarcates the end of the frozen column(s) with a chosen color.

The frozen column divider line appears dark-grey colored by default.

This property is available in Online and RC tasks.

This property is not supported for Right to Left Table.

Since version: 4.6

Allow Freezing Columns

Defines whether the end user will be able to freeze/unfreeze columns at runtime.

If True, new context menu options i.e. Freeze and Un-Freeze will be shown when end user clicks on the Table Control's header.

On selecting Freeze, all columns prior to the selected column (including the selected column itself) will freeze.

On selecting Un-Freeze, all columns will be un-frozen.

This property is available in Online and RC tasks.

This property is not supported for Right to Left Table.

Since version: 4.6

Moving the Last Frozen Column in a Table

When the last frozen column is relocated to non-frozen area, all the columns up till its new location from the left are frozen. In other words, if it is moved towards right, the total number of frozen columns increases, and decreases if it is moved towards left. That means when a last frozen column is moved, it still remains the last frozen column.

Reference
Attachment 
Attachment