OverheadSheetColumn Class
| Name | Description | |
|---|---|---|
|
BreakdownByDiscreteValues | Gets the discrete values from BreakdownByField used to filter and distribute the values from the BreakdownMainField. |
|
BreakdownByField | Gets the mnemonic of a field with discrete values that is used to filter and distribute the values from the BreakdownMainField. |
|
BreakdownMainField | Gets the mnemonic of a minute field whose values are to be shown or distributed. |
|
FactorReceivingField | Gets the mnemonic of a minute field that receives the factor. |
|
FreeFieldDefaultValue | Gets the default value of the free field. |
|
FreeFieldTotalMode | Gets the value specifying what's in total of the free field. |
|
Header1 | Gets the header 1 of the column. |
|
Header2 | Gets the header 2 of the column. |
|
Header3 | Gets the header 3 of the column. |
|
Kind | Gets the kind of the column. |
|
MacroColumnDisplayNA | Gets the value specifying how to display #N/A values in the macro column. |
|
MacroColumnSumInTotals | Gets the value indicating whether to show the sum in totals in the macro column. |
|
PermissionID | Gets the ID of the column usable for permissions in the user profile. |
|
Position | Gets the zero-based column position in the sheet. |
|
SetOfFields | Gets the mnemonic of set of fields, if this column is of type OverheadSheetColumnKind.SetOfFields. |
|
SheetInfo | Gets the info about the overhead sheet to which this column belongs. |
|
ShowMultipleFields | Gets a value indicating whether to show multiple fields, one for each value in BreakdownByDiscreteValues. |
|
SlaveListField | Gets the mnemonic of a minute field that is the slave list. |
| Name | Description | |
|---|---|---|
|
Equals(Object) | Determines whether the specified object is equal to the current object. (inherited from Object). |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (inherited from Object). |
|
GetHashCode | Serves as the default hash function. (inherited from Object). |
|
GetType | Gets the Type of the current instance. (inherited from Object). |
|
MemberwiseClone | Creates a shallow copy of the current Object. (inherited from Object). |
|
ToString | Returns a string that represents the current object. (inherited from Object). |
The following example will display all the columns that were added by the user. This means, that all non-removable native columns will be ignored.
There is a minute field of type "List (Name only)" whose mnemonic is LIST1. The code will operate on the overhead sheet that belongs to that field.
The code requires using System.Linq;.
try
{
// Get the overhead workbook. The lock is required.
es.CurrentVersion.Overhead.GetLockOnWorkbook();
var wsMgr = es.CurrentVersion.Overhead.WorksheetManager;
var wbook = es.CurrentVersion.Overhead.GetWorkbook();
foreach (IWorksheet sheet in wbook.Worksheets)
{
// Find the sheet for the "LIST1" field, which is of type "List (Name only)".
// The "LIST1" is the mnemonic, not the name, which may be localized. The OverheadSheetInfo.Name contains the mnemonic,
// and the OverheadSheetInfo.LocalizedName contains the latter.
var sheetInfo = wsMgr.GetOverheadSheetInformation(sheet);
if (sheetInfo.Type == NativeSheetType.List_Box && sheetInfo.Name == "LIST1")
{
// Get only the columns that were added by the user. Exclude the non-removable native columns.
var userColumns = sheetInfo.Columns.Where((col) => col.Kind != OverheadSheetColumnKind.NativeColumn);
// Sort them by the position.
var sortedUserColumns = userColumns.OrderBy((col) => col.Position);
// Display their headers.
string s = "";
foreach (var column in sortedUserColumns)
{
s += column.Header1 + " | " + column.Header2 + " | " + column.Header3 + " | " + "\n";
}
MessageBox.Show(s);
}
}
}
catch (Exception generalError)
{
// Catches all errors to get the proper message.
MessageBox.Show(generalError.Message, "Error!", MessageBoxButtons.OK, MessageBoxIcon.Error);
}
finally
{
// Release the lock on the overhead workbook in any case.
es.CurrentVersion.Overhead.ReleaseLockOnWorkbook();
}
This language is not supported or no code example is available.
Qdv.UserApi.OverheadSheetColumn
Available since QDV 7.23.1099.
