Collapsed (Property)

find out or define the status (collapsed or expanded) that will be used when rows are added into a TreeView Table control.
This property has no immediate effect but it is taken into account by TableAdd, TableAddLine, TableAddChild, TableInsert, TableInsertLine, TableInsertChild, ...
The expanded status is the default status.
find out or modify the collapsed/expanded status for:
- the breaks of Table controls.
- the breaks of Looper controls.
- a Drawer control.
- Versions 17 and later
  a Ribbon control.
  New in version 17
  a Ribbon control.
  a Ribbon control.
- Versions 21 and later
  a Navigation Bar control.
  New in version 21
  a Navigation Bar control.
  a Navigation Bar control.
- Versions 21 and later
  a Pivot Table control in a report.
  New in version 21
  a Pivot Table control in a report.
  a Pivot Table control in a report.

Versions 20 and later

This property is now available for breaks in Table controls.

This property is now available fo breaks in Browser Looper controls.

New in version 20

This property is now available for breaks in Table controls.

This property is now available fo breaks in Browser Looper controls.

This property is now available for breaks in Table controls.

This property is now available fo breaks in Browser Looper controls.

Versions 22 and later

This property is now available for Table controls in iPhone/iPad applications.

New in version 22

This property is now available for Table controls in iPhone/iPad applications.

Versions 27 and later

This property is now available for TreeView Table controls in Android applications.

This property is now available for TreeView Table controls in iPhone/iPad applications.

New in version 27

This property is now available for TreeView Table controls in Android applications.

This property is now available for TreeView Table controls in iPhone/iPad applications.

This property is now available for TreeView Table controls in Android applications.

This property is now available for TreeView Table controls in iPhone/iPad applications.

Example

// Define the collapsed status for the next addition in the TreeView Table control
TVT_Recipe.Collapsed = True
// Insert a leaf ("Pancakes") at position 2 below the "Desserts" node
TableInsertChild(TVT_Recipe, "Desserts", 2, "Pancakes")

// -- Click code of a Button control etc
// This code is used to collapse or expand the Table control break
// for the current row according to its status

TABLE_NestedBreaks.BreakHeader3.Collapsed = ...
NOT TABLE_NestedBreaks.BreakHeader3.Collapsed

Versions 17 and later

// -- Click code of a Button control etc
// This code is used to collapse or expand the Looper control break
// for the row according to its status

LOOP_NestedBreaks.BRK_BreakHeader1.Collapsed = ...
NOT LOOP_NestedBreaks.BRK_BreakHeader1.Collapsed

New in version 17

Syntax

Identifying the Collapsed/Expanded state used when adding a new element in a control or the Collapsed/Expanded state of a control Hide the details

<Result> = <Control used>.Collapsed

<Result>: Boolean

TreeView Table control and breaks in Table controls
True if the Collapsed status is used for the next addition,
False otherwise.
Drawer control
True if the Drawer control is collapsed,
False otherwise.
Versions 17 and later
Break in Looper control
True if the break is collapsed,
False otherwise.
New in version 17
Break in Looper control
True if the break is collapsed,
False otherwise.
Break in Looper control
True if the break is collapsed,
False otherwise.
Ribbon control
True if the Ribbon control is collapsed. In this case, only the captions of the panes are displayed (like for a standard menu).
False otherwise.
Versions 21 and later
Navigation Bar control
True if the central pane of the Navigation Bar control is collapsed.
False otherwise.
New in version 21
Navigation Bar control
True if the central pane of the Navigation Bar control is collapsed.
False otherwise.
Navigation Bar control
True if the central pane of the Navigation Bar control is collapsed.
False otherwise.

<Control used>: Control name

Name of the control to be used.

Changing the Collapsed/Expanded state used when adding a new element or the Collapsed/Expanded state of a control Hide the details

<Control used>.Collapsed = <Collapsed/Expanded>

<Control used>: Control name

Name of the control to be used.

<Collapsed/Expanded>: Boolean

TreeView Table control and breaks in Table controls
True if the collapsed status must be used for the next addition,
False otherwise.
Drawer control
True to collapse a Drawer control,
False to expand it.
Versions 17 and later
Break in Looper control
True to collapse the break,
False to expand it.
New in version 17
Break in Looper control
True to collapse the break,
False to expand it.
Break in Looper control
True to collapse the break,
False to expand it.
Ribbon control
True to collapse the ribbon.
False to expand it.
Versions 21 and later
Navigation Bar control
True to collapse the central pane in the Navigation Bar control.
False to expand it.
New in version 21
Navigation Bar control
True to collapse the central pane in the Navigation Bar control.
False to expand it.
Navigation Bar control
True to collapse the central pane in the Navigation Bar control.
False to expand it.

Versions 21 and later

Finding out the display status of a Pivot Table control in a report Hide the details

<Result> = <Pivot Table control>.Collapsed

<Result>: Integer constant

Display status of the rows and columns found in a Pivot Table control in a report:
pvtAllCollapsed The Pivot Table control found in the report displays the first level of the source control found in the window.
pvtAllExpanded The Pivot Table control found in the report displays the entire data of the source control found in the window: all the rows and columns are expanded.
pvtLikeTheControl The Pivot Table control found in the report is identical to the source control found in the window: the expanded or collapsed rows are respected.

<Pivot Table control>: Control name

Name of the Pivot Table control to be used. This control is found in a report.

New in version 21

Finding out the display status of a Pivot Table control in a report Hide the details

<Result> = <Pivot Table control>.Collapsed

<Result>: Integer constant

Display status of the rows and columns found in a Pivot Table control in a report:
pvtAllCollapsed The Pivot Table control found in the report displays the first level of the source control found in the window.
pvtAllExpanded The Pivot Table control found in the report displays the entire data of the source control found in the window: all the rows and columns are expanded.
pvtLikeTheControl The Pivot Table control found in the report is identical to the source control found in the window: the expanded or collapsed rows are respected.

<Pivot Table control>: Control name

Name of the Pivot Table control to be used. This control is found in a report.

Finding out the display status of a Pivot Table control in a report Hide the details

<Result> = <Pivot Table control>.Collapsed

<Result>: Integer constant

Display status of the rows and columns found in a Pivot Table control in a report:
pvtAllCollapsed The Pivot Table control found in the report displays the first level of the source control found in the window.
pvtAllExpanded The Pivot Table control found in the report displays the entire data of the source control found in the window: all the rows and columns are expanded.
pvtLikeTheControl The Pivot Table control found in the report is identical to the source control found in the window: the expanded or collapsed rows are respected.

<Pivot Table control>: Control name

Name of the Pivot Table control to be used. This control is found in a report.

Versions 21 and later

Modifying the display status of a Pivot Table control in a report Hide the details

<Pivot Table control>.Collapsed = <Display status>

<Pivot Table control>: Control name

Name of the Pivot Table control to be used. This control is found in a report.

<Display status>: Integer constant

Display status of the rows and columns found in a Pivot Table control in a report:
pvtAllCollapsed The Pivot Table control found in the report displays the first level of the source control found in the window.
pvtAllExpanded The Pivot Table control found in the report displays the entire data of the source control found in the window: all the rows and columns are expanded.
pvtLikeTheControl The Pivot Table control found in the report is identical to the source control found in the window: the expanded or collapsed rows are respected.

New in version 21

Modifying the display status of a Pivot Table control in a report Hide the details

<Pivot Table control>.Collapsed = <Display status>

<Pivot Table control>: Control name

Name of the Pivot Table control to be used. This control is found in a report.

<Display status>: Integer constant

Display status of the rows and columns found in a Pivot Table control in a report:
pvtAllCollapsed The Pivot Table control found in the report displays the first level of the source control found in the window.
pvtAllExpanded The Pivot Table control found in the report displays the entire data of the source control found in the window: all the rows and columns are expanded.
pvtLikeTheControl The Pivot Table control found in the report is identical to the source control found in the window: the expanded or collapsed rows are respected.

Modifying the display status of a Pivot Table control in a report Hide the details

<Pivot Table control>.Collapsed = <Display status>

<Pivot Table control>: Control name

Name of the Pivot Table control to be used. This control is found in a report.

<Display status>: Integer constant

Display status of the rows and columns found in a Pivot Table control in a report:
pvtAllCollapsed The Pivot Table control found in the report displays the first level of the source control found in the window.
pvtAllExpanded The Pivot Table control found in the report displays the entire data of the source control found in the window: all the rows and columns are expanded.
pvtLikeTheControl The Pivot Table control found in the report is identical to the source control found in the window: the expanded or collapsed rows are respected.