OverheadSheetListbox.BreakdownByField Property

Gets the mnemonic of a field with discrete values that is used to breakdown or filter the list.
Public ReadOnly Property BreakdownByField() As String
This language is not supported or no code example is available.
public string BreakdownByField {get;}
This language is not supported or no code example is available.

Property Value

string

The mnemonic of the breakdown/filter field. An empty string if the list has no extra breakdown/filter.

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".

Version
 
Available since QDV 7.23.1099.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition