Table Control

Description

The Table control displays information in a tabular format. VertiGIS Studio Reporting provides properties for the following parts of a table: Table, Column, Row, Cell.

Properties Common to Most Controls

For more information about the properties listed below, see Properties Common to Most Controls.

For more information regarding each of the property groups, see the Control Reference.

Table Properties

The following documents the properties that appear when the whole table is selected. For other table components see: Column Properties, Row Properties, and Cell Properties.

Use the following options to select the whole table:

Actions

Actions

Distribute Columns Evenly Resizes the columns equally within the bounds of the control.

Distribute Rows Evenly Resizes the rows equally within the bounds of the control.

Appearance

Text Alignment

Can be configured in the Properties or Expressions panel.

Specifies the alignment of the print item's text.

Behavior

Anchor Vertically

Sets the location of the control in relation to the parent container. When the parent container changes size, the control may move or resize to maintain its position.

The options for vertically anchoring include:

  • None: The control's size and location are not affected when the container size changes.
  • Top: The distance between the top of the control and the top of the container remains fixed when the container size changes.
  • Bottom: The distance between the bottom of the control and the bottom of the container remains fixed when the container size changes.
  • Both: The distance from the top and bottom of the control from the top and bottom of the container remains fixed when the container size changes. This means that control is resized to maintain these fixed distances.

Anchor Horizontally

Sets the location of the control in relation to the parent container. When the parent container changes size, the control may move or resize to maintain its position.

The options for horizontally anchoring include:

  • None: When the parent container changes size, the control's size and location are not affected when the container size changes.
  • Left: The distance between the left edge of the control and the left side of the container remains fixed when the container size changes.
  • Right: The distance between the right edge of the control and the right side of the container remains fixed when the container size changes.
  • Both: The distance from the left and right edges of the control from the left and right sides of the container remains fixed when the container size changes. This means that control is resized to maintain these fixed distances.

Process Hidden Cell Mode

Specifies how to distribute the space that remains after some of a row's visible cells are hidden.

The options for processing a hidden cell include:

  • Leave Empty Space: An empty space remains in a cell's location. Other cells are not affected.
  • Resize Cells Equally: All visible cells are resized to equally divide the space that the hidden cell reserved.
  • Resize Cells Proportionally: All visible cells are resized to proportionally divide the space that a hidden cell reserved. This is done based on their widths within the whole table width.
  • Stretch Previous Cell: A cell located to the left of the hidden cell is stretched to occupy the available space. If the hidden cell is the first in the row, the next cell is stretched.
  • Stretch Next Cell: A cell located to the right of the hidden cell is stretched to occupy the available space. If the hidden cell is the last in the row, the previous cell is stretched.
  • Decrease Table Width: The table width is decreased and visible cells are shifted to a hidden cell's location without changing their size.

This property effects those cells that are hidden in the following ways:

  • The cell's Visible property is set to false.
  • An expression is specified for the cell's Visible property.

Printing

Right to Left

Specifies the layout of the content within a print item.

The options include:

  • Inherit: The item inherits the printing configuration set at the parent level. This is the default.
  • Yes: The content is aligned to the right.
  • No: The content is aligned to the left.

Column Properties

The following documents the properties that appear when one or more columns are selected. For other table components see: Table Properties, Row Properties, and Cell Properties.

You can select a column using one of two ways:

Actions

VertiGIS Studio Report Designer considers cells as controls. When you select one or more columns, you are essentially selecting multiple controls (cells). As such, you will see options in the Actions panel that pertain to the selection of multiple controls. These options, while enabled, aren't necessarily helpful for the manipulation of columns or cells. Below, we have documented those options that pertain to the manipulation of cells and columns. Those options that are meant for working with multiple controls have not been documented in the table below.

Actions

Align Lefts Aligns the left sides of all selected controls. The controls will align with the position of the left side of the control that is first selected.

Align Rights Aligns the right sides of all selected controls. The controls will align with the position of the right side of the control that is first selected.

Fit Text to Bounds Resize the static text to fit the height or width of the control.

Distribute Columns Evenly Resizes the columns equally within the bounds of the control.

Distribute Columns Evenly is available only when more than one column is selected.

Distribute Rows Evenly Resizes the rows equally within the bounds of the control.

Appearance

Text Alignment

Can be configured in the Properties or Expressions panel.

Specifies the alignment of the print item's text.

Text Trimming

Type: StringTrimming

Can be configured in the Properties or Expressions panel.

Sets the trimming mode applied to text when all text cannot fit into the size of the control.

Options include:

  • None: Text is not trimmed.
  • Character: Text is trimmed to the nearest character.
  • Ellipsis Character: Text is trimmed to the nearest character and an ellipsis is inserted at the end of the trimmed line.
  • Ellipsis Path: Center is removed from trimmed lines and replaced by an ellipsis.
  • Ellipsis Word: Text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line.
  • Word: Text is trimmed to the nearest word.

This property is overridden if Word Wrap is set to True.

Behavior

Angle

Type: Single

The degree by which the text is rotated. Text is rotated counterclockwise from the vertical.

The Can Grow and Can Shrink properties are ignored when Angle is set to a non-zero value.

Allow Markup Text

Type: Boolean

Sets whether you can use HTML markup tags to format the text in the Text property.

See the following resource for what tags are supported.

Can Grow

Type: Boolean

Sets whether the control's height can grow to display the contents at runtime.

Enabled by default.

If there are other controls below the selected control, they will be moved down to prevent overlapping.

Can Shrink

Type: Boolean

Sets whether the control's height can decrease if the contents do not completely fill the control at runtime.

If there are other controls below the current control, they will be moved up to remove the unused space.

Multiline

Type: Boolean

Sets whether the control respects carriage returns entered into the Text property.

Enabled by default.

Process Duplicates Mode

Sets how print controls with duplicate records should be processed. The data type that is processed must be set in the Process Duplicates Target property.

Methods for processing duplicate data include:

  • Leave: The duplicate control is always printed.
  • Merge: The identical data values are merged into a single column.
  • Suppress: A blank space is printed in place of the duplicate data.
  • Suppress and Shrink: The control that contains duplicate data is not printed.

    • This setting has no effect on intersecting controls or in vertical bands.

If there are no controls in a band after duplicates are removed, VertiGIS Studio Reporting does not print the band.

Process Duplicates Target

Sets what data is processed by the Process Duplicates Mode property.

Options include:

  • Value: The value of the control.
  • Tag: The data in the control's Tag property.

Process Null Values

Specifies how a print item containing a null value should be processed.

Methods of processing the null values include:

  • Leave: The print item is always printed.
  • Suppress: A blank space is printed in place of the null data.
  • Suppress and Shrink: The print item that contains null data is not printed.

    • This setting has no effect on intersecting controls or in vertical bands.

If there are no controls in a band after duplicates are removed, VertiGIS Studio Printing does not print the band.

Row Span

Merges cells in a column. The value specifies the number of rows to merge the cells of. Cells selected for merging should be the same width.

Text Fit Mode

This property is not available if Can Grow, Can Shrink, or Auto Width are enabled.

Specifies how the text of a control can be resized to fit the boundaries of the control.

The options for modifying the control's text size include the following:

  • None: The text size is unchanged.
  • Grow Only: The text size can be increased to occupy the entire area of the control.
  • Shrink Only: The text size can be decreased so that it all displays in the bounds of the control.
  • Shrink and Grow: The text size can be increased or decreased to fit the bounds of the control.

Word Wrap

Type: Boolean

Determines how text is rendered when it does not completely fit into the bounds of the control. When enabled, text will start a new line once it meets the right side of the control. Otherwise, the text is displayed on a single line.

Enabled by default.

Data

 

Null Value Text

Type: String

Specifies the text shown in the control when the value of its bound data field is null.

Summary: Running

Sets the print template area that the summary function applies to.

The summary function must be configured in the Text property of the Expressions panel. You must set the Summary Running property to a value other than None for the Expression Editor to show Summary functions.

The report areas available from the drop-down list include:

  • None: No summary is calculated.

  • Group: Calculates a value for the current group.

    The control must be placed in the Group Header Band, Group Footer Band or Detail Band for the control to display the value for the current group.

  • Print Template: Calculates a value for the entire print template.

  • Page: Calculates a value for the page where the control is printed.

Summary: Ignore Null Values

Type: Boolean

Sets whether null values should be ignored when a summary is calculated. If null values are included in the calculation, they are treated as zeros.

Summary: Treat Strings As Numerics

Type: Boolean

Determines whether a summary function should treat strings as numeric values.

Text

Type: String

Can be configured in the Properties or Expressions panel.

Sets the text to appear in the print template control.

The value of the Text property can be set in a few different ways:

  • Double-click the control to start entering text.
  • Select the control and then enter text into the Text property.
  • Drag a field from the Field List onto the print template to automatically populate the Text property.

When a column is selected, entering text into the Text property enters the same text into all cells in the selected column.

Text Format String

The Text Format String Editor provides the ability to apply formatting to data. You can select one of the pre-built formats or create your own.

The Text Format String Editor cannot format values that have been manually entered into a control.

For more information, see the help regarding the Format String Editor and Format Specifiers.

Printing

Right to Left

Specifies the layout of the content within a print item.

The options include:

  • Inherit: The item inherits the printing configuration set at the parent level. This is the default.
  • Yes: The content is aligned to the right.
  • No: The content is aligned to the left.

Row Properties

The following documents the properties that appear when one or more rows are selected. For other table components see: Table Properties, Column Properties, and Cell Properties.

You can select a row using one of two ways:

Actions

Actions

Insert Row Above Adds a row above the selected row.

Insert Row Below Adds a row below the selected row.

Delete Row Deletes the selected row.

Distribute Columns Evenly Resizes the columns equally within the bounds of the control.

Distribute Rows Evenly Resizes the rows equally within the bounds of the control.

This option appears only when more than one row has been selected.

Appearance

Text Alignment

Can be configured in the Properties or Expressions panel.

Specifies the alignment of the print item's text.

Cell Properties

The following documents the properties that appear when one or more cells are selected. For other table components see: Table Properties, Row Properties, and Column Properties.

Actions

VertiGIS Studio Report Designer considers cells as controls. As such, you will see options in the Actions panel that pertain to the selection of multiple controls. These options, while enabled, aren't necessarily helpful for the manipulation of cells. Below, we have documented those options that pertain to the manipulation of cells. Those options that are meant for working with multiple controls have not been documented in the table below.

Actions

Insert Row Above Adds a row above the selected row.

Insert Row Below Adds a row below the selected row.

Delete Row Deletes the selected row.

Insert Cell Adds a cell to the left of the selected cell. The width of the cell to the right of the inserted one will be reduced in a half. Another half will be occupied by the inserted cell.

Delete Cell Deletes the selected cell. If the selected cell is on the end of the row, the adjacent cell expands to take up the space of the deleted cell. Otherwise, the cell to the right expands to take up the space of the deleted cell.

Insert Column To the Left Adds a column to the left of the selected cell.

Insert Column To the Right Adds a column to the right of the selected cell.

Delete Column Deletes the column that the selected cell is in.

Fit Text to Bounds Resize the static text to fit the height or width of the control.

Text

Type: String

Can be configured in the Properties or Expressions panel.

Sets the text to appear in the print template control.

The value of the Text property can be set in a few different ways:

  • Double-click the control to start entering text.
  • Select the control and then enter text into the Text property.
  • Drag a field from the Field List onto the print template to automatically populate the Text property.

Text Format String

The Text Format String Editor provides the ability to apply formatting to data. You can select one of the pre-built formats or create your own.

The Text Format String Editor cannot format values that have been manually entered into a control.

For more information, see the help regarding the Format String Editor and Format Specifiers.

Summary: Running

Sets the print template area that the summary function applies to.

The summary function must be configured in the Text property of the Expressions panel. You must set the Summary Running property to a value other than None for the Expression Editor to show Summary functions.

The report areas available from the drop-down list include:

  • None: No summary is calculated.

  • Group: Calculates a value for the current group.

    The control must be placed in the Group Header Band, Group Footer Band or Detail Band for the control to display the value for the current group.

  • Print Template: Calculates a value for the entire print template.

  • Page: Calculates a value for the page where the control is printed.

Summary: Ignore Null Values

Type: Boolean

Sets whether null values should be ignored when a summary is calculated. If null values are included in the calculation, they are treated as zeros.

Summary: Treat Strings as Numerics

Type: Boolean

Determines whether a summary function should treat strings as numeric values.

Can Grow

Type: Boolean

Sets whether the control's height can grow to display the contents at runtime.

Enabled by default.

If there are other controls below the selected control, they will be moved down to prevent overlapping.

Can Shrink

Type: Boolean

Sets whether the control's height can decrease if the contents do not completely fill the control at runtime.

If there are other controls below the current control, they will be moved up to remove the unused space.

Multiline

Type: Boolean

Sets whether the control respects carriage returns entered into the Text property.

Enabled by default.

Word Wrap

Type: Boolean

Determines how text is rendered when it does not completely fit into the bounds of the control. When enabled, text will start a new line once it meets the right side of the control. Otherwise, the text is displayed on a single line.

Enabled by default.

Appearance

Text Alignment

Can be configured in the Properties or Expressions panel.

Specifies the alignment of the print item's text.

Text Trimming

Type: StringTrimming

Can be configured in the Properties or Expressions panel.

Sets the trimming mode applied to text when all text cannot fit into the size of the control.

Options include:

  • None: Text is not trimmed.
  • Character: Text is trimmed to the nearest character.
  • Ellipsis Character: Text is trimmed to the nearest character and an ellipsis is inserted at the end of the trimmed line.
  • Ellipsis Path: Center is removed from trimmed lines and replaced by an ellipsis.
  • Ellipsis Word: Text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line.
  • Word: Text is trimmed to the nearest word.

This property is overridden if Word Wrap is set to True.

Behavior

Angle

Type: Single

The degree by which the text is rotated. Text is rotated counterclockwise from the vertical.

The Can Grow and Can Shrink properties are ignored when Angle is set to a non-zero value.

Allow Markup Text

Type: Boolean

Sets whether you can use HTML markup tags to format the text in the Text property.

See the following resource for what tags are supported.

Can Grow

Type: Boolean

Sets whether the control's height can grow to display the contents at runtime.

Enabled by default.

If there are other controls below the selected control, they will be moved down to prevent overlapping.

Can Shrink

Type: Boolean

Sets whether the control's height can decrease if the contents do not completely fill the control at runtime.

If there are other controls below the current control, they will be moved up to remove the unused space.

Multiline

Type: Boolean

Sets whether the control respects carriage returns entered into the Text property.

Enabled by default.

Process Duplicates Mode

Sets how print controls with duplicate records should be processed. The data type that is processed must be set in the Process Duplicates Target property.

Methods for processing duplicate data include:

  • Leave: The duplicate control is always printed.
  • Merge: The identical data values are merged into a single column.
  • Suppress: A blank space is printed in place of the duplicate data.
  • Suppress and Shrink: The control that contains duplicate data is not printed.

    • This setting has no effect on intersecting controls or in vertical bands.

If there are no controls in a band after duplicates are removed, VertiGIS Studio Reporting does not print the band.

Process Duplicates Target

Sets what data is processed by the Process Duplicates Mode property.

Options include:

  • Value: The value of the control.
  • Tag: The data in the control's Tag property.

Process Null Values

Specifies how a print item containing a null value should be processed.

Methods of processing the null values include:

  • Leave: The print item is always printed.
  • Suppress: A blank space is printed in place of the null data.
  • Suppress and Shrink: The print item that contains null data is not printed.

    • This setting has no effect on intersecting controls or in vertical bands.

If there are no controls in a band after duplicates are removed, VertiGIS Studio Printing does not print the band.

Row Span

Type: Int32

Specifies the number of rows in the table control that the cell spans.

Text Fit Mode

This property is not available if Can Grow, Can Shrink, or Auto Width are enabled.

Specifies how the text of a control can be resized to fit the boundaries of the control.

The options for modifying the control's text size include the following:

  • None: The text size is unchanged.
  • Grow Only: The text size can be increased to occupy the entire area of the control.
  • Shrink Only: The text size can be decreased so that it all displays in the bounds of the control.
  • Shrink and Grow: The text size can be increased or decreased to fit the bounds of the control.

Word Wrap

Type: Boolean

Determines how text is rendered when it does not completely fit into the bounds of the control. When enabled, text will start a new line once it meets the right side of the control. Otherwise, the text is displayed on a single line.

Enabled by default.

Data

Null Value Text

Type: String

Specifies the text shown in the control when the value of its bound data field is null.

Summary: Running

Sets the print template area that the summary function applies to.

The summary function must be configured in the Text property of the Expressions panel. You must set the Summary Running property to a value other than None for the Expression Editor to show Summary functions.

The report areas available from the drop-down list include:

  • None: No summary is calculated.

  • Group: Calculates a value for the current group.

    The control must be placed in the Group Header Band, Group Footer Band or Detail Band for the control to display the value for the current group.

  • Print Template: Calculates a value for the entire print template.

  • Page: Calculates a value for the page where the control is printed.

Summary: Ignore Null Values

Type: Boolean

Sets whether null values should be ignored when a summary is calculated. If null values are included in the calculation, they are treated as zeros.

Summary: Treat Strings As Numerics

Type: Boolean

Determines whether a summary function should treat strings as numeric values.

Text

Type: String

Can be configured in the Properties or Expressions panel.

Sets the text to appear in the print template control.

The value of the Text property can be set in a few different ways:

  • Double-click the control to start entering text.
  • Select the control and then enter text into the Text property.
  • Drag a field from the Field List onto the print template to automatically populate the Text property.

Text Format String

The Text Format String Editor provides the ability to apply formatting to data. You can select one of the pre-built formats or create your own.

The Text Format String Editor cannot format values that have been manually entered into a control.

For more information, see the help regarding the Format String Editor and Format Specifiers.

Printing

Right to Left

Specifies the layout of the content within a print item.

The options include:

  • Inherit: The item inherits the printing configuration set at the parent level. This is the default.
  • Yes: The content is aligned to the right.
  • No: The content is aligned to the left.

Related Tutorials

Refer to the following resources for additional help on implementing this control: