OverheadSheetListbox Class

Stores the information that is specific to a LIST BOX sheet in the Overhead workbook. It has only meaning if the sheet in the Sheetinfo is of type NativeSheetType.List_Box.
Public Class OverheadSheetListbox
This language is not supported or no code example is available.
public class OverheadSheetListbox
This language is not supported or no code example is available.
Name Description
Public property BreakdownByDiscreteValues Gets the discrete values from BreakdownByField used to filter and breakdown the list.
Public property BreakdownByField Gets the mnemonic of a field with discrete values that is used to breakdown or filter the list.
Public property ChildSheetBreakdownValue Gets the breakdown discrete value to which this sheet belongs, if this is an automatically created additional child sheet of the main list sheet that is broken down.
Public property SheetInfo Gets the info about the overhead sheet to which this list-box data belongs.
Public property ShowMultipleSheets Gets a value indicating whether to show multiple sheets, one for each value in BreakdownByDiscreteValues.
Top
Methods
 
Name Description
Public method Equals(Object) Determines whether the specified object is equal to the current object. (inherited from Object).
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object).
Public method GetHashCode Serves as the default hash function. (inherited from Object).
Public method GetType Gets the Type of the current instance. (inherited from Object).
Protected method MemberwiseClone Creates a shallow copy of the current Object. (inherited from Object).
Public method ToString Returns a string that represents the current object. (inherited from Object).
Top
Remarks
 

Multi-dimensional breakdown of the list

In addition to the list items and the ordinary field, you can breakdown numerical values according an extra key hidden in the B3 cell.

If a list is broken down to multiple sheets, there exist multiple sheets in the overhead that have the same mnemonic in the OverheadSheetInfo.Name. To uniquely distinguish them, use the ChildSheetBreakdownValue property. For example, let's have a list with mnemonic LIST1. Then we have another list with mnemonic LIST2. The LIST2 has three items: VAL1, VAL2 and VAL3. The LIST1 is broken down by the LIST2, and it has selected all three values. The "Show multiple sheets" option is selected. The OverheadSheetListbox for the LIST1 contains the following data:

BreakdownByField = "LIST2" 
BreakdownByDiscreteValues = "VAL1,VAL2,VAL3" 
ShowMultipleSheets = true

There are four sheets created in the overhead. They are named: LIST1, LIST1_VAL1, LIST1_VAL2 and LIST1_VAL3. These names may be localized, you cannot rely on them. All four sheets have the same mnemonic in the OverheadSheetInfo.Name = "LIST1". The difference is in the ChildSheetBreakdownValue property. The main list sheet has always an empty string. The child sheets have the following values: "VAL1", "VAL2" and "VAL3".

Qdv.UserApi.OverheadSheetListbox
Version
 
Available since QDV 7.23.1099.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition