IWorksheetManager.GetNativeWorksheet Method

Gets the overhead worksheet of the specified type from the overhead workbook.
Function GetNativeWorksheet( _ 
ByVal overheadWorkbook As IWorkbook, _ 
ByVal sheetType As NativeSheetType, _ 
Optional ByVal fieldMnemonic As String = "" _ 
) As IWorksheet
This language is not supported or no code example is available.
IWorksheet GetNativeWorksheet( 
IWorkbook overheadWorkbook
NativeSheetType sheetType
string fieldMnemonic = "" 
)
This language is not supported or no code example is available.

Parameters

overheadWorkbook
IWorkbook

The overhead workbook.

sheetType
NativeSheetType

Required.

fieldMnemonic
string

The mnemonic of a minute field or set of fields, which refers to the sheet in the fields manager. It has only meaning for some types of overhead worksheets, such as material, workforce, list, etc. In such a case, it should be the same as OverheadSheetInfo.Name returned from GetOverheadSheetInformation.

If omitted or set to an empty string, the first matching worksheet will be returned.

Return Value

IWorksheet
Remarks
 
This function is useful to return a native worksheet regardless the language of the user interface. Keep in mind that names of worksheets can be localized. Using this function, you can find a worksheet using its ID instead of using its localized name.

A more flexible alternative to calling this method is to simply enumerate all sheets in overheadWorkbook. Then just call GetOverheadSheetInformation on each sheet and test the returned OverheadSheetInfo.

Sheets of type NativeSheetType.Template are very hidden in QDV. They are used by QDV internally when you create new sheets. You must NOT modify these sheets.

It is highly recommended that you don't write to sheets of any other type than NativeSheetType.User.

If you really want to add information to such sheets, please make sure that you write only:

If by mistake, you break the logic of such sheet, you can remove it (by removing the corresponding field of set of fields) and create it again. You'll get a fresh sheet derived from the hidden templates.

Version
 
Available since QDV 7.13.0001.

.NET Framework

Supported in: 4.8, 4.7, 4.6, 4.5.2

In this article

Definition