Pro.CFBF — API for parsing legacy Office documents

Overview

The Pro.CFBF module contains the API for parsing legacy Office documents (e.g. DOC, XLS, PPT).

Directory Enumeration

The following code example demonstrates how to enumerate the directories in a CFBF document.

from Pro.Core import *
from Pro.CFBF import *

def visitor(obj, ud, dir_id, children):
    name = obj.DirectoryName(dir_id)
    print(name)
    return 0

def visitDirectories(fname):
    c = createContainerFromFile(fname)
    if c.isNull():
        return
    cfb = CFBObject()
    if not cfb.Load(c):
        return
    dirs = cfb.BuildDirectoryTree()
    cfb.SetDirectoryTree(dirs)
    cfb.VisitDirectories(dirs, visitor, None)

Decryption

Both Cerbero Suite and Cerbero Engine feature state-of-the-art decryption support for CFBF documents.

While it’s preferable using the scan engine to perform automatic decryption of CFBF documents, it is also possible to perform the decryption manually.

from Pro.Core import *
from Pro.CFBF import *

def loadCFBF(c):
    cfb = CFBObject()
    if not cfb.Load(c):
        return None
    dirs = cfb.BuildDirectoryTree()
    cfb.SetDirectoryTree(dirs)
    return cfb

def decrypt(fname):
    c = createContainerFromFile(fname)
    if c.isNull():
        return
    cfb = loadCFBF(c)
    if not cfb:
        return
    c = cfb.Decrypt()
    if c.isValid():
        # decrypted
        cfb = loadCFBF(c)

Important

An important advantage when using the scan engine is that key provider extensions can provide custom passwords used to try to decrypt the document. When decrypting the document manually, the decryption support is limited to the default Microsoft encryption password usually used by malware.

VBA Extraction

The following code example shows how to extract VBA code from a CFBF document.

from Pro.Core import *
from Pro.CFBF import *

def extractVBAVisitor(obj, ud, dir_id, children):
    name = obj.DirectoryName(dir_id)
    if name == "VBA" and obj.FlagsIsStorage(children.at(0)):
        # extract VBA
        vbacode = obj.ExtractVBAProject(obj.GetDirectoryTree(), dir_id)
        if vbacode != None:
            print(vbacode)
    return 0

def extractVBA(fname):
    c = createContainerFromFile(fname)
    if c.isNull():
        return
    cfb = CFBObject()
    if not cfb.Load(c):
        return
    dirs = cfb.BuildDirectoryTree()
    cfb.SetDirectoryTree(dirs)
    cfb.VisitDirectories(dirs, extractVBAVisitor, None)

XLS Macro Decompiling

While it’s possible to use the low-level ExcelMacroDecompiler.decompile() method to decompile macros, it’s preferable to create a Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace and iterate through its cells.

There are multiple advantages in doing so:

1. Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace is used by all types of Microsoft Excel formats, including XLSB and XLSM. Therefore, the code can be easily generalized.

2. Pro.SiliconSpreadsheet offers a more intuitive and complete API.

3. Pro.SiliconSpreadsheet offers an API to emulate macros if needed.

4. The contents of a Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace instance can be easily manipulated.

The following code examples demonstrates how to convert an XLS document into a Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace instance and then iterates through its cells, printing out the ones that contain a macro.

from Pro.Core import *
from Pro.CFBF import *
from Pro.SiliconSpreadsheet import *

def extractMacros(fname):
    c = createContainerFromFile(fname)
    if c.isNull():
        return
    cfb = CFBObject()
    if not cfb.Load(c):
        return
    dirs = cfb.BuildDirectoryTree()
    cfb.SetDirectoryTree(dirs)
    for name in ("Workbook", "Book"):
        wbs = cfb.DirectoryFromName(dirs, 0, name)
        if wbs.IsValid():
            break
    if wbs.IsNull():
        return
    wbstream = cfb.Stream(wbs)
    if wbstream.isNull():
        return
    parser = CFBXlsParser(wbstream)
    book = CFBXlsBook()
    if not book.Load(parser):
        return
    ws = SiliconSpreadsheetWorkspace()
    if not parser.createSiliconSpreadsheetWorkspace(book, ws):
        return
    # iterate through sheets
    sheets = ws.getSheets()
    it = sheets.iterator()
    while it.hasNext():
        sheet = it.next()
        print(sheet.getName())
        # iterate through cells
        cell_it = sheet.cellIterator()
        while cell_it.hasNext():
            cell = cell_it.next()
            # skip cells without a formula
            if not cell.cell.formula:
                continue
            cell.index.sheet = "" # don't print the sheet name in the cell name
            print("    cell:", SiliconSpreadsheetUtil.cellName(cell.index), "formula:", cell.cell.formula)

An example output of the code:

BvkFvmzLtsgS
    cell: HS1581 formula: CHAR($HS$1883-949)
    cell: HZ1595 formula: RUN($BJ$408)
    cell: HS1582 formula: RUN($FN$624)
    cell: CK1884 formula: RUN($EP$402)
    cell: GZ1652 formula: CHAR($AZ$491-835)
    cell: FD732 formula: CHAR($HL$93-691)
    cell: BX881 formula: RUN($EK$1168)
    [...]

Module API

Pro.CFBF module API.

Attributes:

BiffBoundSheetChart	XLS sheet type.
BiffBoundSheetMacroSheet	XLS sheet type.
BiffBoundSheetVBModule	XLS sheet type.
BiffBoundSheetWorkSheet	XLS sheet type.
BiffMacroSheet	XLS sheet type.
BiffRecordId_AlRuns	XLS BIFF record id.
BiffRecordId_Area	XLS BIFF record id.
BiffRecordId_AreaFormat	XLS BIFF record id.
BiffRecordId_Array	XLS BIFF record id.
BiffRecordId_AttachedLabel	XLS BIFF record id.
BiffRecordId_AutoFilter	XLS BIFF record id.
BiffRecordId_AutoFilter12	XLS BIFF record id.
BiffRecordId_AutoFilterInfo	XLS BIFF record id.
BiffRecordId_AxcExt	XLS BIFF record id.
BiffRecordId_AxesUsed	XLS BIFF record id.
BiffRecordId_Axis	XLS BIFF record id.
BiffRecordId_AxisLine	XLS BIFF record id.
BiffRecordId_AxisParent	XLS BIFF record id.
BiffRecordId_BCUsrs	XLS BIFF record id.
BiffRecordId_BOF	XLS BIFF record id.
BiffRecordId_BRAI	XLS BIFF record id.
BiffRecordId_Backup	XLS BIFF record id.
BiffRecordId_Bar	XLS BIFF record id.
BiffRecordId_Begin	XLS BIFF record id.
BiffRecordId_BigName	XLS BIFF record id.
BiffRecordId_BkHim	XLS BIFF record id.
BiffRecordId_Blank	XLS BIFF record id.
BiffRecordId_BookBool	XLS BIFF record id.
BiffRecordId_BookExt	XLS BIFF record id.
BiffRecordId_BoolErr	XLS BIFF record id.
BiffRecordId_BopPop	XLS BIFF record id.
BiffRecordId_BopPopCustom	XLS BIFF record id.
BiffRecordId_BottomMargin	XLS BIFF record id.
BiffRecordId_BoundSheet8	XLS BIFF record id.
BiffRecordId_BuiltInFnGroupCount	XLS BIFF record id.
BiffRecordId_CF	XLS BIFF record id.
BiffRecordId_CF12	XLS BIFF record id.
BiffRecordId_CFEx	XLS BIFF record id.
BiffRecordId_CRN	XLS BIFF record id.
BiffRecordId_CUsr	XLS BIFF record id.
BiffRecordId_CalcCount	XLS BIFF record id.
BiffRecordId_CalcDelta	XLS BIFF record id.
BiffRecordId_CalcIter	XLS BIFF record id.
BiffRecordId_CalcMode	XLS BIFF record id.
BiffRecordId_CalcPrecision	XLS BIFF record id.
BiffRecordId_CalcRefMode	XLS BIFF record id.
BiffRecordId_CalcSaveRecalc	XLS BIFF record id.
BiffRecordId_CatLab	XLS BIFF record id.
BiffRecordId_CatSerRange	XLS BIFF record id.
BiffRecordId_CbUsr	XLS BIFF record id.
BiffRecordId_CellWatch	XLS BIFF record id.
BiffRecordId_Chart	XLS BIFF record id.
BiffRecordId_Chart3DBarShape	XLS BIFF record id.
BiffRecordId_Chart3d	XLS BIFF record id.
BiffRecordId_ChartFormat	XLS BIFF record id.
BiffRecordId_ChartFrtInfo	XLS BIFF record id.
BiffRecordId_ClrtClient	XLS BIFF record id.
BiffRecordId_CodeName	XLS BIFF record id.
BiffRecordId_CodePage	XLS BIFF record id.
BiffRecordId_ColInfo	XLS BIFF record id.
BiffRecordId_Compat12	XLS BIFF record id.
BiffRecordId_CompressPictures	XLS BIFF record id.
BiffRecordId_CondFmt	XLS BIFF record id.
BiffRecordId_CondFmt12	XLS BIFF record id.
BiffRecordId_Continue	XLS BIFF record id.
BiffRecordId_ContinueBigName	XLS BIFF record id.
BiffRecordId_ContinueFrt	XLS BIFF record id.
BiffRecordId_ContinueFrt11	XLS BIFF record id.
BiffRecordId_ContinueFrt12	XLS BIFF record id.
BiffRecordId_Country	XLS BIFF record id.
BiffRecordId_CrErr	XLS BIFF record id.
BiffRecordId_CrtLayout12	XLS BIFF record id.
BiffRecordId_CrtLayout12A	XLS BIFF record id.
BiffRecordId_CrtLine	XLS BIFF record id.
BiffRecordId_CrtLink	XLS BIFF record id.
BiffRecordId_CrtMlFrt	XLS BIFF record id.
BiffRecordId_CrtMlFrtContinue	XLS BIFF record id.
BiffRecordId_DBCell	XLS BIFF record id.
BiffRecordId_DBQueryExt	XLS BIFF record id.
BiffRecordId_DCon	XLS BIFF record id.
BiffRecordId_DConBin	XLS BIFF record id.
BiffRecordId_DConName	XLS BIFF record id.
BiffRecordId_DConRef	XLS BIFF record id.
BiffRecordId_DConn	XLS BIFF record id.
BiffRecordId_DSF	XLS BIFF record id.
BiffRecordId_DVal	XLS BIFF record id.
BiffRecordId_DXF	XLS BIFF record id.
BiffRecordId_Dat	XLS BIFF record id.
BiffRecordId_DataFormat	XLS BIFF record id.
BiffRecordId_DataLabExt	XLS BIFF record id.
BiffRecordId_DataLabExtContents	XLS BIFF record id.
BiffRecordId_Date1904	XLS BIFF record id.
BiffRecordId_DbOrParamQry	XLS BIFF record id.
BiffRecordId_DefColWidth	XLS BIFF record id.
BiffRecordId_DefaultRowHeight	XLS BIFF record id.
BiffRecordId_DefaultText	XLS BIFF record id.
BiffRecordId_Dimensions	XLS BIFF record id.
BiffRecordId_DocRoute	XLS BIFF record id.
BiffRecordId_DropBar	XLS BIFF record id.
BiffRecordId_DropDownObjIds	XLS BIFF record id.
BiffRecordId_Dv	XLS BIFF record id.
BiffRecordId_DxGCol	XLS BIFF record id.
BiffRecordId_EOF	XLS BIFF record id.
BiffRecordId_End	XLS BIFF record id.
BiffRecordId_EndBlock	XLS BIFF record id.
BiffRecordId_EndObject	XLS BIFF record id.
BiffRecordId_EntExU2	XLS BIFF record id.
BiffRecordId_Excel9File	XLS BIFF record id.
BiffRecordId_ExtSST	XLS BIFF record id.
BiffRecordId_ExtString	XLS BIFF record id.
BiffRecordId_ExternName	XLS BIFF record id.
BiffRecordId_ExternSheet	XLS BIFF record id.
BiffRecordId_Fbi	XLS BIFF record id.
BiffRecordId_Fbi2	XLS BIFF record id.
BiffRecordId_Feat	XLS BIFF record id.
BiffRecordId_FeatHdr	XLS BIFF record id.
BiffRecordId_FeatHdr11	XLS BIFF record id.
BiffRecordId_Feature11	XLS BIFF record id.
BiffRecordId_Feature12	XLS BIFF record id.
BiffRecordId_FileLock	XLS BIFF record id.
BiffRecordId_FilePass	XLS BIFF record id.
BiffRecordId_FileSharing	XLS BIFF record id.
BiffRecordId_FilterMode	XLS BIFF record id.
BiffRecordId_FnGroupName	XLS BIFF record id.
BiffRecordId_FnGrp12	XLS BIFF record id.
BiffRecordId_Font	XLS BIFF record id.
BiffRecordId_FontX	XLS BIFF record id.
BiffRecordId_Footer	XLS BIFF record id.
BiffRecordId_ForceFullCalculation	XLS BIFF record id.
BiffRecordId_Format	XLS BIFF record id.
BiffRecordId_Formula	XLS BIFF record id.
BiffRecordId_Frame	XLS BIFF record id.
BiffRecordId_FrtFontList	XLS BIFF record id.
BiffRecordId_FrtWrapper	XLS BIFF record id.
BiffRecordId_GUIDTypeLib	XLS BIFF record id.
BiffRecordId_GelFrame	XLS BIFF record id.
BiffRecordId_GridSet	XLS BIFF record id.
BiffRecordId_Guts	XLS BIFF record id.
BiffRecordId_HCenter	XLS BIFF record id.
BiffRecordId_HFPicture	XLS BIFF record id.
BiffRecordId_HLink	XLS BIFF record id.
BiffRecordId_HLinkTooltip	XLS BIFF record id.
BiffRecordId_Header	XLS BIFF record id.
BiffRecordId_HeaderFooter	XLS BIFF record id.
BiffRecordId_HideObj	XLS BIFF record id.
BiffRecordId_HorizontalPageBreaks	XLS BIFF record id.
BiffRecordId_IFmtRecord	XLS BIFF record id.
BiffRecordId_Index	XLS BIFF record id.
BiffRecordId_InterfaceEnd	XLS BIFF record id.
BiffRecordId_InterfaceHdr	XLS BIFF record id.
BiffRecordId_Intl	XLS BIFF record id.
BiffRecordId_LPr	XLS BIFF record id.
BiffRecordId_LRng	XLS BIFF record id.
BiffRecordId_Label	XLS BIFF record id.
BiffRecordId_LabelSst	XLS BIFF record id.
BiffRecordId_Lbl	XLS BIFF record id.
BiffRecordId_LeftMargin	XLS BIFF record id.
BiffRecordId_Legend	XLS BIFF record id.
BiffRecordId_LegendException	XLS BIFF record id.
BiffRecordId_Lel	XLS BIFF record id.
BiffRecordId_Line	XLS BIFF record id.
BiffRecordId_LineFormat	XLS BIFF record id.
BiffRecordId_List12	XLS BIFF record id.
BiffRecordId_MDB	XLS BIFF record id.
BiffRecordId_MDTInfo	XLS BIFF record id.
BiffRecordId_MDXKPI	XLS BIFF record id.
BiffRecordId_MDXProp	XLS BIFF record id.
BiffRecordId_MDXSet	XLS BIFF record id.
BiffRecordId_MDXStr	XLS BIFF record id.
BiffRecordId_MDXTuple	XLS BIFF record id.
BiffRecordId_MTRSettings	XLS BIFF record id.
BiffRecordId_MarkerFormat	XLS BIFF record id.
BiffRecordId_MergeCells	XLS BIFF record id.
BiffRecordId_Mms	XLS BIFF record id.
BiffRecordId_MsoDrawing	XLS BIFF record id.
BiffRecordId_MsoDrawingGroup	XLS BIFF record id.
BiffRecordId_MsoDrawingSelection	XLS BIFF record id.
BiffRecordId_MulBlank	XLS BIFF record id.
BiffRecordId_MulRk	XLS BIFF record id.
BiffRecordId_NameCmt	XLS BIFF record id.
BiffRecordId_NameFnGrp12	XLS BIFF record id.
BiffRecordId_NamePublish	XLS BIFF record id.
BiffRecordId_Note	XLS BIFF record id.
BiffRecordId_Number	XLS BIFF record id.
BiffRecordId_ObNoMacros	XLS BIFF record id.
BiffRecordId_ObProj	XLS BIFF record id.
BiffRecordId_Obj	XLS BIFF record id.
BiffRecordId_ObjProtect	XLS BIFF record id.
BiffRecordId_ObjectLink	XLS BIFF record id.
BiffRecordId_OleDbConn	XLS BIFF record id.
BiffRecordId_OleObjectSize	XLS BIFF record id.
BiffRecordId_PLV	XLS BIFF record id.
BiffRecordId_Palette	XLS BIFF record id.
BiffRecordId_Pane	XLS BIFF record id.
BiffRecordId_Password	XLS BIFF record id.
BiffRecordId_PhoneticInfo	XLS BIFF record id.
BiffRecordId_PicF	XLS BIFF record id.
BiffRecordId_Pie	XLS BIFF record id.
BiffRecordId_PieFormat	XLS BIFF record id.
BiffRecordId_PivotChartBits	XLS BIFF record id.
BiffRecordId_PlotArea	XLS BIFF record id.
BiffRecordId_PlotGrowth	XLS BIFF record id.
BiffRecordId_Pls	XLS BIFF record id.
BiffRecordId_Pos	XLS BIFF record id.
BiffRecordId_PrintGrid	XLS BIFF record id.
BiffRecordId_PrintRowCol	XLS BIFF record id.
BiffRecordId_PrintSize	XLS BIFF record id.
BiffRecordId_Prot4Rev	XLS BIFF record id.
BiffRecordId_Prot4RevPass	XLS BIFF record id.
BiffRecordId_Protect	XLS BIFF record id.
BiffRecordId_Qsi	XLS BIFF record id.
BiffRecordId_QsiSXTag	XLS BIFF record id.
BiffRecordId_Qsif	XLS BIFF record id.
BiffRecordId_Qsir	XLS BIFF record id.
BiffRecordId_RK	XLS BIFF record id.
BiffRecordId_RRAutoFmt	XLS BIFF record id.
BiffRecordId_RRDChgCell	XLS BIFF record id.
BiffRecordId_RRDConflict	XLS BIFF record id.
BiffRecordId_RRDDefName	XLS BIFF record id.
BiffRecordId_RRDHead	XLS BIFF record id.
BiffRecordId_RRDInfo	XLS BIFF record id.
BiffRecordId_RRDInsDel	XLS BIFF record id.
BiffRecordId_RRDInsDelBegin	XLS BIFF record id.
BiffRecordId_RRDInsDelEnd	XLS BIFF record id.
BiffRecordId_RRDMove	XLS BIFF record id.
BiffRecordId_RRDMoveBegin	XLS BIFF record id.
BiffRecordId_RRDMoveEnd	XLS BIFF record id.
BiffRecordId_RRDRenSheet	XLS BIFF record id.
BiffRecordId_RRDRstEtxp	XLS BIFF record id.
BiffRecordId_RRDTQSIF	XLS BIFF record id.
BiffRecordId_RRDUserView	XLS BIFF record id.
BiffRecordId_RRFormat	XLS BIFF record id.
BiffRecordId_RRInsertSh	XLS BIFF record id.
BiffRecordId_RRSort	XLS BIFF record id.
BiffRecordId_RRTabId	XLS BIFF record id.
BiffRecordId_RString	XLS BIFF record id.
BiffRecordId_Radar	XLS BIFF record id.
BiffRecordId_RadarArea	XLS BIFF record id.
BiffRecordId_RealTimeData	XLS BIFF record id.
BiffRecordId_RecalcId	XLS BIFF record id.
BiffRecordId_RecipName	XLS BIFF record id.
BiffRecordId_RefreshAll	XLS BIFF record id.
BiffRecordId_RichTextStream	XLS BIFF record id.
BiffRecordId_RightMargin	XLS BIFF record id.
BiffRecordId_Row	XLS BIFF record id.
BiffRecordId_SBaseRef	XLS BIFF record id.
BiffRecordId_SCENARIO	XLS BIFF record id.
BiffRecordId_SIIndex	XLS BIFF record id.
BiffRecordId_SST	XLS BIFF record id.
BiffRecordId_SXAddl	XLS BIFF record id.
BiffRecordId_SXDB	XLS BIFF record id.
BiffRecordId_SXDBB	XLS BIFF record id.
BiffRecordId_SXDBEx	XLS BIFF record id.
BiffRecordId_SXDI	XLS BIFF record id.
BiffRecordId_SXDtr	XLS BIFF record id.
BiffRecordId_SXEx	XLS BIFF record id.
BiffRecordId_SXFDB	XLS BIFF record id.
BiffRecordId_SXFDBType	XLS BIFF record id.
BiffRecordId_SXFormula	XLS BIFF record id.
BiffRecordId_SXInt	XLS BIFF record id.
BiffRecordId_SXLI	XLS BIFF record id.
BiffRecordId_SXNum	XLS BIFF record id.
BiffRecordId_SXPI	XLS BIFF record id.
BiffRecordId_SXPIEx	XLS BIFF record id.
BiffRecordId_SXPair	XLS BIFF record id.
BiffRecordId_SXRng	XLS BIFF record id.
BiffRecordId_SXStreamID	XLS BIFF record id.
BiffRecordId_SXString	XLS BIFF record id.
BiffRecordId_SXTBRGIITM	XLS BIFF record id.
BiffRecordId_SXTH	XLS BIFF record id.
BiffRecordId_SXTbl	XLS BIFF record id.
BiffRecordId_SXVDEx	XLS BIFF record id.
BiffRecordId_SXVDTEx	XLS BIFF record id.
BiffRecordId_SXVI	XLS BIFF record id.
BiffRecordId_SXVS	XLS BIFF record id.
BiffRecordId_SXViewEx	XLS BIFF record id.
BiffRecordId_SXViewEx9	XLS BIFF record id.
BiffRecordId_SXViewLink	XLS BIFF record id.
BiffRecordId_Scatter	XLS BIFF record id.
BiffRecordId_ScenMan	XLS BIFF record id.
BiffRecordId_ScenarioProtect	XLS BIFF record id.
BiffRecordId_Scl	XLS BIFF record id.
BiffRecordId_Selection	XLS BIFF record id.
BiffRecordId_SerAuxErrBar	XLS BIFF record id.
BiffRecordId_SerAuxTrend	XLS BIFF record id.
BiffRecordId_SerFmt	XLS BIFF record id.
BiffRecordId_SerParent	XLS BIFF record id.
BiffRecordId_SerToCrt	XLS BIFF record id.
BiffRecordId_Series	XLS BIFF record id.
BiffRecordId_SeriesList	XLS BIFF record id.
BiffRecordId_SeriesText	XLS BIFF record id.
BiffRecordId_Setup	XLS BIFF record id.
BiffRecordId_ShapePropsStream	XLS BIFF record id.
BiffRecordId_SheetExt	XLS BIFF record id.
BiffRecordId_ShrFmla	XLS BIFF record id.
BiffRecordId_ShtProps	XLS BIFF record id.
BiffRecordId_Sort	XLS BIFF record id.
BiffRecordId_SortData	XLS BIFF record id.
BiffRecordId_StartBlock	XLS BIFF record id.
BiffRecordId_StartObject	XLS BIFF record id.
BiffRecordId_String	XLS BIFF record id.
BiffRecordId_Style	XLS BIFF record id.
BiffRecordId_StyleExt	XLS BIFF record id.
BiffRecordId_SupBook	XLS BIFF record id.
BiffRecordId_Surf	XLS BIFF record id.
BiffRecordId_SxBool	XLS BIFF record id.
BiffRecordId_SxDXF	XLS BIFF record id.
BiffRecordId_SxErr	XLS BIFF record id.
BiffRecordId_SxFilt	XLS BIFF record id.
BiffRecordId_SxFmla	XLS BIFF record id.
BiffRecordId_SxFormat	XLS BIFF record id.
BiffRecordId_SxIsxoper	XLS BIFF record id.
BiffRecordId_SxItm	XLS BIFF record id.
BiffRecordId_SxIvd	XLS BIFF record id.
BiffRecordId_SxName	XLS BIFF record id.
BiffRecordId_SxNil	XLS BIFF record id.
BiffRecordId_SxRule	XLS BIFF record id.
BiffRecordId_SxSelect	XLS BIFF record id.
BiffRecordId_SxTbpg	XLS BIFF record id.
BiffRecordId_SxView	XLS BIFF record id.
BiffRecordId_Sxvd	XLS BIFF record id.
BiffRecordId_Sync	XLS BIFF record id.
BiffRecordId_Table	XLS BIFF record id.
BiffRecordId_TableStyle	XLS BIFF record id.
BiffRecordId_TableStyleElement	XLS BIFF record id.
BiffRecordId_TableStyles	XLS BIFF record id.
BiffRecordId_Template	XLS BIFF record id.
BiffRecordId_Text	XLS BIFF record id.
BiffRecordId_TextPropsStream	XLS BIFF record id.
BiffRecordId_Theme	XLS BIFF record id.
BiffRecordId_Tick	XLS BIFF record id.
BiffRecordId_TopMargin	XLS BIFF record id.
BiffRecordId_TxO	XLS BIFF record id.
BiffRecordId_TxtQry	XLS BIFF record id.
BiffRecordId_Uncalced	XLS BIFF record id.
BiffRecordId_Units	XLS BIFF record id.
BiffRecordId_UserBView	XLS BIFF record id.
BiffRecordId_UserSViewBegin	XLS BIFF record id.
BiffRecordId_UserSViewBegin_Chart	XLS BIFF record id.
BiffRecordId_UserSViewEnd	XLS BIFF record id.
BiffRecordId_UsesELFs	XLS BIFF record id.
BiffRecordId_UsrChk	XLS BIFF record id.
BiffRecordId_UsrExcl	XLS BIFF record id.
BiffRecordId_UsrInfo	XLS BIFF record id.
BiffRecordId_VCenter	XLS BIFF record id.
BiffRecordId_ValueRange	XLS BIFF record id.
BiffRecordId_VerticalPageBreaks	XLS BIFF record id.
BiffRecordId_WOpt	XLS BIFF record id.
BiffRecordId_WebPub	XLS BIFF record id.
BiffRecordId_WinProtect	XLS BIFF record id.
BiffRecordId_Window1	XLS BIFF record id.
BiffRecordId_Window2	XLS BIFF record id.
BiffRecordId_WriteAccess	XLS BIFF record id.
BiffRecordId_WriteProtect	XLS BIFF record id.
BiffRecordId_WsBool	XLS BIFF record id.
BiffRecordId_XCT	XLS BIFF record id.
BiffRecordId_XF	XLS BIFF record id.
BiffRecordId_XFCRC	XLS BIFF record id.
BiffRecordId_XFExt	XLS BIFF record id.
BiffRecordId_YMult	XLS BIFF record id.
BiffUnicodeVersion	Minimum XLS version for unicode support.
BiffWorkBookGlobals	XLS stream type.
BiffWorkBookGlobals4W	XLS stream type.
BiffWorkSheet	XLS sheet type.
CFBDirFlag_MiniStream	CFB directory mini stream flag.
CFBDirFlag_RootStorage	CFB directory root storage flag.
CFBDirFlag_Storage	CFB directory storage flag.
CFBDirFlag_Stream	CFB directory stream flag.
CFBDirFlag_TypeMask	CFB directory type mask.
CFBDirFlag_Unknown	CFB directory unknown flag.
CFBDirFlag_Unlinked	CFB directory unlinked flag.
DIROBJECT_ROOTSTORAGE	Root storage flag returned by CFBObject.Directory().Uns("ObjectType").
DIROBJECT_STORAGE	Storage flag returned by CFBObject.Directory().Uns("ObjectType").
DIROBJECT_STREAM	Stream flag returned by CFBObject.Directory().Uns("ObjectType").
DIROBJECT_UNKNOWN_OR_UNALLOCATED	Unknown or unallocated flag returned by CFBObject.Directory().Uns("ObjectType").
ExcelFormulaType_All	All types of Excel formulas.
ExcelFormulaType_Array	Excel array formula type.
ExcelFormulaType_Cell	Excel cell formula type.
ExcelFormulaType_CondFmt	Excel conditional format formula type.
ExcelFormulaType_DataVal	Excel data formula type.
ExcelFormulaType_Name	Excel name formula type.
ExcelFormulaType_Shared	Excel shared formula type.
ExcelMacroDecompilerErr_Decompile	Excel decompiler error result.
ExcelMacroDecompilerErr_None	Excel decompiler success result.
ExcelMacroDecompilerErr_Opcode	Excel decompiler opcode error result.
ExcelMacroDecompilerErr_Operation	Excel decompiler operation error result.
ExcelMacroDecompilerErr_Read	Excel decompiler read error result.
ExcelMacroDecompilerErr_Size	Excel decompiler size error result.
ExcelMacroDecompilerErr_Stack	Excel decompiler stack error result.
ExcelMacroDecompilerErr_Token	Excel decompiler token error result.
ExcelMacroDecompilerErr_Unsupported	Excel decompiler unsupported error result.
NOSTREAM	A special value used to mark sibling/child fields as unused.
SECNUM_DIFSECT	Specifies a DIFAT sector in the FAT.
SECNUM_ENDOFCHAIN	End of linked chain of sectors.
SECNUM_FATSECT	Specifies a FAT sector in the FAT.
SECNUM_FREESEC	Specifies unallocated sectors in the FAT, mini FAT or DIFAT.
SECNUM_MAXREGSECT	Maximum regular sector number.

Classes:

BiffRecord()	This class represents an XLS BIFF record.
CFBDirectoryTree()	Dictionary of int -> NTUIntList elements.
CFBDirectoryTreeIt(obj)	Iterator class for CFBDirectoryTree.
CFBObject()	This class represents a CFBF object.
CFBXlsBook()	This class represents a legacy XLS workbook.
CFBXlsExternalSheetInfo()	This class contains information about an external workbook sheet.
CFBXlsExternalSheetInfoList()	List of CFBXlsExternalSheetInfo elements.
CFBXlsExternalSheetInfoListIt(obj)	Iterator class for CFBXlsExternalSheetInfoList.
CFBXlsFormulaValueInfo()	This class contains information about an XLS formula value.
CFBXlsName()	This class contains the information about an XLS name.
CFBXlsParser(workbook_stream)	This class implements the parser functionality for a legacy XLS workbook.
CFBXlsSheet()	This class represents an XLS workbook sheet.
CFBXlsSheetList()	List of CFBXlsSheet elements.
CFBXlsSheetListIt(obj)	Iterator class for CFBXlsSheetList.
CFBXlsUtil()	This class contains static utility methods.
ExcelMacroDecompiler()	This class contains the functionality to decompile XLS macros.

BiffBoundSheetChart: Final[int]

XLS sheet type.

See also CFBXlsSheet.type.

BiffBoundSheetMacroSheet: Final[int]

XLS sheet type.

See also CFBXlsSheet.type.

BiffBoundSheetVBModule: Final[int]

XLS sheet type.

See also CFBXlsSheet.type.

BiffBoundSheetWorkSheet: Final[int]

XLS sheet type.

See also CFBXlsSheet.type.

BiffMacroSheet: Final[int]

XLS sheet type.

See also CFBXlsSheet.type.

class BiffRecord

This class represents an XLS BIFF record.

See also CFBXlsParser.

Methods:

dataOffset()	Returns the internal data offset of the record.
dataSize()	Returns the internal data size of the record.
isNull()	Returns True if the record is invalid; otherwise returns False.
isValid()	Returns True if the record is valid; otherwise returns False.

Attributes:

id	The identifier of the record (e.g., BiffRecordId_Formula).
offset	The offset of the record.
size	The size of the record.

dataOffset() → int

Returns

Returns the internal data offset of the record.

Return type

int

See also dataSize() and offset.

dataSize() → int

Returns

Returns the internal data size of the record.

Return type

int

See also dataOffset() and size.

id

The identifier of the record (e.g., BiffRecordId_Formula).

isNull() → bool

Returns

Returns True if the record is invalid; otherwise returns False.

Return type

bool

See also isValid().

isValid() → bool

Returns

Returns True if the record is valid; otherwise returns False.

Return type

bool

See also isNull().

offset

The offset of the record.

See also dataOffset() and size.

size

The size of the record.

See also dataSize() and offset.

BiffRecordId_AlRuns: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Area: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AreaFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Array: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AttachedLabel: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AutoFilter: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AutoFilter12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AutoFilterInfo: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AxcExt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AxesUsed: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Axis: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AxisLine: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_AxisParent: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BCUsrs: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BOF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BRAI: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Backup: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Bar: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Begin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BigName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BkHim: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Blank: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BookBool: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BookExt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BoolErr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BopPop: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BopPopCustom: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BottomMargin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BoundSheet8: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_BuiltInFnGroupCount: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CF12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CFEx: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CRN: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CUsr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CalcCount: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CalcDelta: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CalcIter: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CalcMode: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CalcPrecision: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CalcRefMode: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CalcSaveRecalc: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CatLab: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CatSerRange: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CbUsr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CellWatch: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Chart: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Chart3DBarShape: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Chart3d: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ChartFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ChartFrtInfo: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ClrtClient: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CodeName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CodePage: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ColInfo: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Compat12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CompressPictures: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CondFmt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CondFmt12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Continue: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ContinueBigName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ContinueFrt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ContinueFrt11: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ContinueFrt12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Country: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CrErr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CrtLayout12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CrtLayout12A: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CrtLine: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CrtLink: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CrtMlFrt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_CrtMlFrtContinue: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DBCell: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DBQueryExt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DCon: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DConBin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DConName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DConRef: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DConn: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DSF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DVal: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DXF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Dat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DataFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DataLabExt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DataLabExtContents: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Date1904: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DbOrParamQry: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DefColWidth: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DefaultRowHeight: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DefaultText: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Dimensions: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DocRoute: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DropBar: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DropDownObjIds: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Dv: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_DxGCol: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_EOF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_End: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_EndBlock: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_EndObject: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_EntExU2: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Excel9File: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ExtSST: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ExtString: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ExternName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ExternSheet: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Fbi: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Fbi2: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Feat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FeatHdr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FeatHdr11: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Feature11: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Feature12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FileLock: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FilePass: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FileSharing: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FilterMode: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FnGroupName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FnGrp12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Font: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FontX: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Footer: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ForceFullCalculation: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Format: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Formula: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Frame: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FrtFontList: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_FrtWrapper: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_GUIDTypeLib: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_GelFrame: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_GridSet: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Guts: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_HCenter: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_HFPicture: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_HLink: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_HLinkTooltip: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Header: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_HeaderFooter: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_HideObj: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_HorizontalPageBreaks: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_IFmtRecord: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Index: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_InterfaceEnd: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_InterfaceHdr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Intl: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_LPr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_LRng: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Label: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_LabelSst: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Lbl: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_LeftMargin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Legend: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_LegendException: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Lel: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Line: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_LineFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_List12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MDB: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MDTInfo: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MDXKPI: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MDXProp: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MDXSet: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MDXStr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MDXTuple: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MTRSettings: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MarkerFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MergeCells: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Mms: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MsoDrawing: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MsoDrawingGroup: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MsoDrawingSelection: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MulBlank: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_MulRk: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_NameCmt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_NameFnGrp12: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_NamePublish: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Note: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Number: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ObNoMacros: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ObProj: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Obj: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ObjProtect: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ObjectLink: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_OleDbConn: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_OleObjectSize: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PLV: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Palette: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Pane: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Password: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PhoneticInfo: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PicF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Pie: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PieFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PivotChartBits: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PlotArea: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PlotGrowth: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Pls: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Pos: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PrintGrid: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PrintRowCol: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_PrintSize: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Prot4Rev: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Prot4RevPass: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Protect: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Qsi: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_QsiSXTag: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Qsif: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Qsir: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RK: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRAutoFmt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDChgCell: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDConflict: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDDefName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDHead: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDInfo: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDInsDel: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDInsDelBegin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDInsDelEnd: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDMove: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDMoveBegin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDMoveEnd: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDRenSheet: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDRstEtxp: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDTQSIF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRDUserView: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRInsertSh: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRSort: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RRTabId: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RString: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Radar: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RadarArea: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RealTimeData: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RecalcId: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RecipName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RefreshAll: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RichTextStream: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_RightMargin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Row: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SBaseRef: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SCENARIO: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SIIndex: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SST: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXAddl: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXDB: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXDBB: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXDBEx: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXDI: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXDtr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXEx: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXFDB: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXFDBType: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXFormula: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXInt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXLI: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXNum: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXPI: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXPIEx: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXPair: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXRng: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXStreamID: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXString: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXTBRGIITM: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXTH: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXTbl: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXVDEx: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXVDTEx: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXVI: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXVS: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXViewEx: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXViewEx9: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SXViewLink: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Scatter: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ScenMan: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ScenarioProtect: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Scl: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Selection: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SerAuxErrBar: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SerAuxTrend: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SerFmt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SerParent: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SerToCrt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Series: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SeriesList: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SeriesText: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Setup: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ShapePropsStream: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SheetExt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ShrFmla: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ShtProps: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Sort: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SortData: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_StartBlock: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_StartObject: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_String: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Style: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_StyleExt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SupBook: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Surf: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxBool: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxDXF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxErr: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxFilt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxFmla: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxFormat: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxIsxoper: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxItm: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxIvd: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxName: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxNil: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxRule: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxSelect: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxTbpg: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_SxView: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Sxvd: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Sync: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Table: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_TableStyle: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_TableStyleElement: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_TableStyles: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Template: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Text: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_TextPropsStream: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Theme: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Tick: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_TopMargin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_TxO: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_TxtQry: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Uncalced: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Units: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UserBView: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UserSViewBegin: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UserSViewBegin_Chart: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UserSViewEnd: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UsesELFs: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UsrChk: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UsrExcl: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_UsrInfo: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_VCenter: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_ValueRange: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_VerticalPageBreaks: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_WOpt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_WebPub: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_WinProtect: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Window1: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_Window2: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_WriteAccess: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_WriteProtect: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_WsBool: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_XCT: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_XF: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_XFCRC: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_XFExt: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffRecordId_YMult: Final[int]

XLS BIFF record id.

See also BiffRecord.id.

BiffUnicodeVersion: Final[int]

Minimum XLS version for unicode support.

See also CFBXlsBook.GetVersion().

BiffWorkBookGlobals: Final[int]

XLS stream type.

See also CFBXlsBook.ParseBOF().

BiffWorkBookGlobals4W: Final[int]

XLS stream type.

See also CFBXlsBook.ParseBOF().

BiffWorkSheet: Final[int]

XLS sheet type.

See also CFBXlsSheet.type.

CFBDirFlag_MiniStream: Final[int]

CFB directory mini stream flag.

See also CFBObject.DirectoryFlags().

CFBDirFlag_RootStorage: Final[int]

CFB directory root storage flag.

See also CFBObject.DirectoryFlags().

CFBDirFlag_Storage: Final[int]

CFB directory storage flag.

See also CFBObject.DirectoryFlags().

CFBDirFlag_Stream: Final[int]

CFB directory stream flag.

See also CFBObject.DirectoryFlags().

CFBDirFlag_TypeMask: Final[int]

CFB directory type mask.

See also CFBObject.DirectoryFlags().

CFBDirFlag_Unknown: Final[int]

CFB directory unknown flag.

See also CFBObject.DirectoryFlags().

CFBDirFlag_Unlinked: Final[int]

CFB directory unlinked flag.

class CFBDirectoryTree

Dictionary of int -> NTUIntList elements.

Methods:

clear()	Removes all items from the hash.
contains(key)	Checks whether key is present in the hash.
count(key)	Counts the numbers of values associated with key in the hash.
insert(key, value)	Inserts a new item with key and a value of value.
insertMulti(key, value)	Inserts a new item with key and a value of value.
isEmpty()	Checks whether the hash is empty.
iterator()	Creates an iterator for the hash.
remove(key)	Removes all the items that have key from the hash.
reserve(alloc)	Ensures that the internal hash table consists of at least size buckets.
size()	Returns the number of items in the hash.
take(key)	Removes the item with key from the hash and returns the value associated with it.
value(key[, defaultValue])	Returns the value associated with key.

clear() → None

Removes all items from the hash.

contains(key: CFBDirectoryId) → bool

Checks whether key is present in the hash.

Parameters

key (int) – The key value to check for.

Returns

Returns True if the hash contains an item with the key; otherwise returns False.

Return type

bool

See also count().

count(key: CFBDirectoryId) → int

Counts the numbers of values associated with key in the hash.

Parameters

key (int) – The key value.

Returns

Returns the number of items associated with the key.

Return type

int

See also contains().

insert(key: CFBDirectoryId, value: NTUIntList) → None

Inserts a new item with key and a value of value.

Parameters

• key (int) – The key.

• value (NTUIntList) – The value.

See also insertMulti().

insertMulti(key: CFBDirectoryId, value: NTUIntList) → None

Inserts a new item with key and a value of value.

If there is already an item with the same key in the hash, this method will simply create a new one. (This behaviour is different from insert(), which overwrites the value of an existing item.)

Parameters

• key (int) – The key.

• value (NTUIntList) – The value.

See also insert().

isEmpty() → bool

Checks whether the hash is empty.

Returns

Returns True if the hash contains no items; otherwise returns False.

Return type

bool

See also size().

iterator() → Pro.CFBF.CFBDirectoryTreeIt

Creates an iterator for the hash.

Returns

Returns the iterator.

Return type

CFBDirectoryTreeIt

remove(key: CFBDirectoryId) → int

Removes all the items that have key from the hash.

Parameters

key (int) – The key to remove.

Returns

Returns the number of items removed which is usually 1 but will be 0 if the key isn’t in the hash, or greater than 1 if insertMulti() has been used with the key.

Return type

int

See also clear() and take().

reserve(alloc: int) → None

Ensures that the internal hash table consists of at least size buckets.

Parameters

alloc (int) – The allocation size.

size() → int

Returns

Returns the number of items in the hash.

Return type

int

See also isEmpty() and count().

take(key: CFBDirectoryId) → NTUIntList

Removes the item with key from the hash and returns the value associated with it.

If the item does not exist in the hash, the method simply returns a default-constructed value. If there are multiple items for key in the hash, only the most recently inserted one is removed.

If you don’t use the return value, remove() is more efficient.

Parameters

key (int) – The key.

Returns

Returns the removed value.

Return type

NTUIntList

See also remove().

value(key: CFBDirectoryId, defaultValue: Optional[NTUIntList] = None) → NTUIntList

Returns the value associated with key. If the hash contains no item with key, the method returns a default-constructed value if defaultValue is not provided. If there are multiple items for key in the hash, the value of the most recently inserted one is returned.

Parameters

• key (int) – The key.

• defaultValue (Optional[NTUIntList]) – The default value to return if key is not present in the hash.

Returns

Returns the value associated with key.

Return type

NTUIntList

See also contains().

class CFBDirectoryTreeIt(obj: Pro.CFBF.CFBDirectoryTree)

Iterator class for CFBDirectoryTree.

Parameters

obj (CFBDirectoryTree) – The object to iterate over.

Methods:

hasNext()	Returns True if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container; otherwise returns False.
hasPrevious()	Returns True if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container; otherwise returns False.
key()	Returns the key of the last item that was jumped over using one of the traversal functions (previous(), next()).
next()	Returns the next item and advances the iterator by one position.
previous()	Returns the previous item and moves the iterator back by one position.
toBack()	Moves the iterator to the back of the container (after the last item).
toFront()	Moves the iterator to the front of the container (before the first item).
value()	Returns the value of the last item that was jumped over using one of the traversal functions (previous(), next()).

hasNext() → bool

Returns

Returns True if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container; otherwise returns False.

Return type

bool

See also hasPrevious() and next().

hasPrevious() → bool

Returns

Returns True if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container; otherwise returns False.

Return type

bool

See also hasNext() and previous().

key() → CFBDirectoryId

Returns

Returns the key of the last item that was jumped over using one of the traversal functions (previous(), next()).

Return type

CFBDirectoryId

See also value().

next() → None

Returns

Returns the next item and advances the iterator by one position.

Return type

None

See also hasNext() and previous().

previous() → None

Returns

Returns the previous item and moves the iterator back by one position.

Return type

None

See also hasPrevious() and next().

toBack() → None

Moves the iterator to the back of the container (after the last item).

See also toFront() and previous().

toFront() → None

Moves the iterator to the front of the container (before the first item).

See also toBack() and next().

value() → Pro.Core.NTUIntList

Returns

Returns the value of the last item that was jumped over using one of the traversal functions (previous(), next()).

Return type

NTUIntList

See also key().

class CFBObject

Bases: Pro.Core.CFFObject

This class represents a CFBF object.

Methods:

BuildDirectoryTree()	Builds the CFBF directory tree.
ChainedSectors(startSector)	Returns the data of all the sectors chained to the specified sector.
Decrypt()	Decrypts the CFBF object.
Directories()	Returns the list of CFBF directories.
Directory(index)	Retrieves a CFBF directory from its index.
DirectoryFlags(s)	Computes the flags for a CFBF directory.
DirectoryFromName(dirs, parent_id, name)	Searches for a sub-directory in a CFBF directory tree by name.
DirectoryFromOffset(offset)	Retrieves a CFBF directory from a specified offset.
DirectoryIdToOffset(index)	Converts a CFBF directory id to its offset.
DirectoryName(index_or_s)	Retrieves the name of a CFBF directory.
ExtractVBAProject(dirs, vbadir_id)	Extracts the VBA code from the specified CFBF VBA directory.
FlagsIsStorage(flags)	Checks whether either the CFBDirFlag_RootStorage or CFBDirFlag_Storage CFBF directory flag is set.
FlagsIsStream(flags)	Checks whether either the CFBDirFlag_Stream or CFBDirFlag_MiniStream CFBF directory flag is set.
GetDirectoryTree()	Returns the internal CFBF directory tree.
GetPartialStream(dir_or_directoryEntryIndex, …)	Retrieves a partial stream.
Header()	Returns the CFBF object header.
SectorHeader()	Returns the CFBF object header.
SetDirectoryTree(dirs)	Sets the internal CFBF directory tree.
Stream(dir_or_directoryEntryIndex)	Retrieves a stream.
VisitDirectories(dirs, visitor, param[, root_id])	Visits the directories in a CFBF tree.
WriteStream(dir_or_directoryEntryIndex, stream)	Overwrites the data of a stream with data of the same size.

BuildDirectoryTree() → Pro.CFBF.CFBDirectoryTree

Builds the CFBF directory tree.

Returns

Returns the directory tree.

Return type

CFBDirectoryTree

See also SetDirectoryTree() and GetDirectoryTree().

ChainedSectors(startSector: int) → Pro.Core.NTContainer

Returns the data of all the sectors chained to the specified sector.

Parameters

startSector (int) – The start sector.

Returns

Returns the chained data if successful; otherwise returns an invalid Pro.Core.NTContainer instance.

Return type

NTContainer

Decrypt() → Pro.Core.NTContainer

Decrypts the CFBF object.

Returns

Returns the decrypted object data if successful; otherwise returns an invalid Pro.Core.NTContainer instance.

Return type

NTContainer

Directories() → Pro.Core.CFFStruct

Returns

Returns the list of CFBF directories.

Return type

CFFStruct

Directory(index: CFBDirectoryId) → CFFStruct

Retrieves a CFBF directory from its index.

Parameters

index (CFBDirectoryId) – The directory index.

Returns

Returns the CFBF directory if successful; otherwise returns an invalid Pro.Core.CFFStruct instance.

Return type

CFFStruct

DirectoryFlags(s: Pro.Core.CFFStruct) → int

Computes the flags for a CFBF directory.

Parameters

s (CFFStruct) – The CFBF directory.

Returns

Returns the computed flags (e.g., CFBDirFlag_MiniStream).

Return type

int

See also Directory().

DirectoryFromName(dirs: CFBDirectoryTree, parent_id: CFBDirectoryId, name: str) → CFFStruct

Searches for a sub-directory in a CFBF directory tree by name.

Parameters

• dirs (CFBDirectoryTree) – The CFBF directory tree.

• parent_id (CFBDirectoryId) – The directory parent id.

• name (str) – The name of the directory to search.

Returns

Returns the CFBF directory if present; otherwise returns an invalid Pro.Core.CFFStruct instance.

Return type

CFFStruct

See also DirectoryFromOffset().

DirectoryFromOffset(offset: int) → Pro.Core.CFFStruct

Retrieves a CFBF directory from a specified offset.

Parameters

offset (int) – The directory offset.

Returns

Returns the CFBF directory if successful; otherwise returns an invalid Pro.Core.CFFStruct instance.

Return type

CFFStruct

See also DirectoryIdToOffset() and DirectoryFromName().

DirectoryIdToOffset(index: CFBDirectoryId) → int

Converts a CFBF directory id to its offset.

Parameters

index (CFBDirectoryId) – The directory id.

Returns

Returns the offset of the CFBF directory if successful; otherwise returns Pro.Core.INVALID_STREAM_OFFSET.

Return type

int

See also DirectoryFromOffset().

DirectoryName(index_or_s: Union[CFBDirectoryId, CFFStruct]) → str

Retrieves the name of a CFBF directory.

Parameters

index_or_s (Union[CFBDirectoryId, CFFStruct]) – Either the index or the instance of the CFBF directory.

Returns

Returns the name of the CFBF directory if successful; otherwise returns an empty string.

Return type

str

ExtractVBAProject(dirs: CFBDirectoryTree, vbadir_id: CFBDirectoryId) → Union[str, None]

Extracts the VBA code from the specified CFBF VBA directory.

Parameters

• dirs (CFBDirectoryTree) – The CFBF directory tree.

• vbadir_id (CFBDirectoryId) – The index of the CFBF VBA directory.

Returns

Returns the VBA code if successful; otherwise returns None.

Return type

Union[str, None]

See also VisitDirectories().

FlagsIsStorage(flags: int) → bool

Checks whether either the CFBDirFlag_RootStorage or CFBDirFlag_Storage CFBF directory flag is set.

Parameters

flags (int) – The CFBF directory flags.

Returns

Returns True if the flags specify a storage directory; otherwise returns False.

Return type

bool

See also DirectoryFlags() and FlagsIsStream().

FlagsIsStream(flags: int) → bool

Checks whether either the CFBDirFlag_Stream or CFBDirFlag_MiniStream CFBF directory flag is set.

Parameters

flags (int) – The CFBF directory flags.

Returns

Returns True if the flags specify a stream directory; otherwise returns False.

Return type

bool

See also DirectoryFlags() and FlagsIsStorage().

GetDirectoryTree() → Pro.CFBF.CFBDirectoryTree

Returns

Returns the internal CFBF directory tree.

Return type

CFBDirectoryTree

See also SetDirectoryTree() and BuildDirectoryTree().

GetPartialStream(dir_or_directoryEntryIndex: Union[CFBDirectoryId, CFFStruct], max_len: int) → bytes

Retrieves a partial stream.

Parameters

• dir_or_directoryEntryIndex (Union[CFBDirectoryId, CFFStruct]) – Either the index or the instance of the CFBF directory.

• max_len (int) – The maximum length of the returned data.

Returns

Returns the stream data if successful; otherwise returns an invalid Pro.Core.NTContainer instance.

Return type

bytes

See also Stream().

Header() → Pro.Core.CFFStruct

Returns

Returns the CFBF object header.

Return type

CFFStruct

See also SectorHeader().

SectorHeader() → Pro.Core.CFFStruct

Returns

Returns the CFBF object header.

Return type

CFFStruct

Note

This method is an alias for Header().

See also Header().

SetDirectoryTree(dirs: Pro.CFBF.CFBDirectoryTree) → None

Sets the internal CFBF directory tree.

Parameters

dirs (CFBDirectoryTree) – The CFBF directory tree.

See also BuildDirectoryTree() and GetDirectoryTree().

Stream(dir_or_directoryEntryIndex: Union[CFBDirectoryId, CFFStruct]) → NTContainer

Retrieves a stream.

Parameters

dir_or_directoryEntryIndex (Union[CFBDirectoryId, CFFStruct]) – Either the index or the instance of the CFBF directory.

Returns

Returns the stream data if successful; otherwise returns an invalid Pro.Core.NTContainer instance.

Return type

NTContainer

See also GetPartialStream() and WriteStream().

VisitDirectories(dirs: CFBDirectoryTree, visitor: object, param: object, root_id: CFBDirectoryId = 0) → int

Visits the directories in a CFBF tree.

Example:

from Pro.Core import *
from Pro.CFBF import *

def visitor(obj, ud, dir_id, children):
    name = obj.DirectoryName(dir_id)
    print(name)
    return 0

def visitDirectories(fname):
    c = createContainerFromFile(fname)
    if c.isNull():
        return
    cfb = CFBObject()
    if not cfb.Load(c):
        return
    dirs = cfb.BuildDirectoryTree()
    cfb.SetDirectoryTree(dirs)
    cfb.VisitDirectories(dirs, visitor, None)

Parameters

• dirs (CFBDirectoryTree) – The CFBF directory tree.

• visitor (object) – The visitor function.

• param (object) – The visitor custom parameter.

• root_id (CFBDirectoryId) – The root directory index.

Returns

Returns the values returned by the visitor function.

Return type

int

See also GetDirectoryTree() and BuildDirectoryTree().

WriteStream(dir_or_directoryEntryIndex: Union[CFBDirectoryId, CFFStruct], stream: NTContainer) → bool

Overwrites the data of a stream with data of the same size.

Important

If the input data size doesn’t match the stream data size, then the method will fail.

Parameters

• dir_or_directoryEntryIndex (Union[CFBDirectoryId, CFFStruct]) – Either the index or the instance of the CFBF directory.

• stream (NTContainer) – The new stream data.

Returns

Returns True if successful; otherwise returns False.

Return type

bool

See also Stream().

class CFBXlsBook

This class represents a legacy XLS workbook.

See also Load() and CFBXlsParser.

Methods:

GetAddInFuncName(i)	Retrieves an add-in function name by its index.
GetEncoding()	Returns the encoding identifier.
GetExternSheetInfoList()	Returns the list of external sheet info.
GetName(i)	Retrieves an XLS name by its index.
GetSharedString(i)	Retrieves a shared string by its index.
GetSheetList()	Returns the list of sheets in the workbook.
GetSheetName(i)	Retrieves a sheet name by its index.
GetSheetNames()	Returns a list of the names of the workbook sheets.
GetSupBookAddInsIndex()	Returns the supplementary book add-ins index.
GetSupBookLocalsIndex()	Returns the supplementary book locals index.
GetVersion()	Returns the version of the XLS workbook.
IsNull()	Returns True if the instance is invalid; otherwise returns False.
IsValid()	Returns True if the instance is valid; otherwise returns False.
Load(p)	Initializes the current instance from a CFBXlsParser instance.

GetAddInFuncName(i: int) → str

Retrieves an add-in function name by its index.

Parameters

i (int) – The index.

Returns

Returns the add-in function name if successful; otherwise returns an empty string.

Return type

str

GetEncoding() → int

Returns

Returns the encoding identifier.

Return type

int

GetExternSheetInfoList() → Pro.CFBF.CFBXlsExternalSheetInfoList

Returns

Returns the list of external sheet info.

Return type

CFBXlsExternalSheetInfoList

See also CFBXlsExternalSheetInfo.

GetName(i: int) → Pro.CFBF.CFBXlsName

Retrieves an XLS name by its index.

Parameters

i (int) – The index.

Returns

Returns the information if successful; otherwise returns an invalid CFBXlsName instance.

Return type

CFBXlsName

See also CFBXlsName.

GetSharedString(i: int) → str

Retrieves a shared string by its index.

Parameters

i (int) – The index.

Returns

Returns the shared string if successful; otherwise returns an empty string.

Return type

str

GetSheetList() → Pro.CFBF.CFBXlsSheetList

Returns

Returns the list of sheets in the workbook.

Return type

CFBXlsSheetList

See also CFBXlsSheet.

GetSheetName(i: int) → str

Retrieves a sheet name by its index.

Parameters

i (int) – The index.

Returns

Returns the sheet name if successful; otherwise returns an empty string.

Return type

str

GetSheetNames() → Pro.Core.NTUTF8StringList

Returns

Returns a list of the names of the workbook sheets.

Return type

NTUTF8StringList

GetSupBookAddInsIndex() → int

Returns

Returns the supplementary book add-ins index.

Return type

int

GetSupBookLocalsIndex() → int

Returns

Returns the supplementary book locals index.

Return type

int

GetVersion() → int

Returns

Returns the version of the XLS workbook.

Return type

int

IsNull() → bool

Returns

Returns True if the instance is invalid; otherwise returns False.

Return type

bool

See also IsValid().

IsValid() → bool

Returns

Returns True if the instance is valid; otherwise returns False.

Return type

bool

See also IsNull().

Load(p: Pro.CFBF.CFBXlsParser) → bool

Initializes the current instance from a CFBXlsParser instance.

Parameters

p (CFBXlsParser) – The parser instance.

Returns

Returns True if successful; otherwise returns False.

Return type

bool

class CFBXlsExternalSheetInfo

This class contains information about an external workbook sheet.

See also CFBXlsBook.

Attributes:

ref_first_sheetx	The first referenced sheet.
ref_last_sheetx	The last referenced sheet.
ref_recordx	The record value.

ref_first_sheetx

The first referenced sheet.

ref_last_sheetx

The last referenced sheet.

ref_recordx

The record value.

class CFBXlsExternalSheetInfoList

List of CFBXlsExternalSheetInfo elements.

Methods:

append(value)	Inserts value at the end of the list.
at(i)	Returns the item at index position i in the list.
clear()	Removes all items from the list.
contains(value)	Checks the presence of an element in the list.
count(value)	Returns the number of occurrences of value in the list.
indexOf(value[, start])	Searches for an element in the list.
insert(i, value)	Inserts value at index position i in the list.
isEmpty()	Checks whether the list is empty.
iterator()	Creates an iterator for the list.
removeAll(value)	Removes all occurrences of value in the list and returns the number of entries removed.
removeAt(i)	Removes the item at index position i.
reserve(alloc)	Reserve space for alloc elements.
size()	Returns the number of items in the list.
takeAt(i)	Removes the item at index position i and returns it.

append(value: Pro.CFBF.CFBXlsExternalSheetInfo) → None

Inserts value at the end of the list.

Parameters

value (CFBXlsExternalSheetInfo) – The value to add to the list.

See also insert().

at(i: int) → Pro.CFBF.CFBXlsExternalSheetInfo

Returns the item at index position i in the list. i must be a valid index position in the list (i.e., 0 <= i < size()).

Parameters

i (int) – The index of the element to return.

Returns

Returns the requested element.

Return type

CFBXlsExternalSheetInfo

clear() → None

Removes all items from the list.

contains(value: Pro.CFBF.CFBXlsExternalSheetInfo) → bool

Checks the presence of an element in the list.

Parameters

value (CFBXlsExternalSheetInfo) – The value to check for.

Returns

Returns True if the list contains an occurrence of value; otherwise returns False.

Return type

bool

See also indexOf() and count().

count(value: Pro.CFBF.CFBXlsExternalSheetInfo) → int

Returns the number of occurrences of value in the list.

Parameters

value (CFBXlsExternalSheetInfo) – The value to count.

Returns

Returns the number of occurrences.

Return type

int

See also indexOf() and contains().

indexOf(value: Pro.CFBF.CFBXlsExternalSheetInfo, start: int = 0) → int

Searches for an element in the list.

Parameters

• value (CFBXlsExternalSheetInfo) – The value to search for.

• start (int) – The start index.

Returns

Returns the index position of the first occurrence of value in the list. Returns -1 if no item was found.

Return type

int

See also contains().

insert(i: int, value: Pro.CFBF.CFBXlsExternalSheetInfo) → None

Inserts value at index position i in the list. If i is 0, the value is prepended to the list. If i is size(), the value is appended to the list.

Parameters

• i (int) – The position at which to add the value.

• value (CFBXlsExternalSheetInfo) – The value to add.

See also append() and removeAt().

isEmpty() → bool

Checks whether the list is empty.

Returns

Returns True if the list contains no items; otherwise returns False.

Return type

bool

See also size().

iterator() → Pro.CFBF.CFBXlsExternalSheetInfoListIt

Creates an iterator for the list.

Returns

Returns the iterator.

Return type

CFBXlsExternalSheetInfoListIt

removeAll(value: Pro.CFBF.CFBXlsExternalSheetInfo) → int

Removes all occurrences of value in the list and returns the number of entries removed.

Parameters

value (CFBXlsExternalSheetInfo) – The value to remove from the list.

Returns

Returns the number of entries removed.

Return type

int

See also removeAt().

removeAt(i: int) → None

Removes the item at index position i. i must be a valid index position in the list (i.e., 0 <= i < size()).

Parameters

i (int) – The index of the item to remove.

See also removeAll().

reserve(alloc: int) → None

Reserve space for alloc elements. Calling this method doesn’t change the size of the list.

Parameters

alloc (int) – The amount of elements to reserve space for.

size() → int

Returns

Returns the number of items in the list.

Return type

int

See also isEmpty().

takeAt(i: int) → Pro.CFBF.CFBXlsExternalSheetInfo

Removes the item at index position i and returns it. i must be a valid index position in the list (i.e., 0 <= i < size()).

Parameters

i (int) – The index of the element to remove from the list.

Returns

Returns the removed element. If you don’t use the return value, removeAt() is more efficient.

Return type

CFBXlsExternalSheetInfo

See also removeAt().

class CFBXlsExternalSheetInfoListIt(obj: Pro.CFBF.CFBXlsExternalSheetInfoList)

Iterator class for CFBXlsExternalSheetInfoList.

Parameters

obj (CFBXlsExternalSheetInfoList) – The object to iterate over.

Methods:

hasNext()	Returns True if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container; otherwise returns False.
hasPrevious()	Returns True if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container; otherwise returns False.
next()	Returns the next item and advances the iterator by one position.
previous()	Returns the previous item and moves the iterator back by one position.
toBack()	Moves the iterator to the back of the container (after the last item).
toFront()	Moves the iterator to the front of the container (before the first item).

hasNext() → bool

Returns

Returns True if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container; otherwise returns False.

Return type

bool

See also hasPrevious() and next().

hasPrevious() → bool

Returns

Returns True if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container; otherwise returns False.

Return type

bool

See also hasNext() and previous().

next() → Pro.CFBF.CFBXlsExternalSheetInfo

Returns

Returns the next item and advances the iterator by one position.

Return type

CFBXlsExternalSheetInfo

See also hasNext() and previous().

previous() → Pro.CFBF.CFBXlsExternalSheetInfo

Returns

Returns the previous item and moves the iterator back by one position.

Return type

CFBXlsExternalSheetInfo

See also hasPrevious() and next().

toBack() → None

Moves the iterator to the back of the container (after the last item).

See also toFront() and previous().

toFront() → None

Moves the iterator to the front of the container (before the first item).

See also toBack() and next().

class CFBXlsFormulaValueInfo

This class contains information about an XLS formula value.

See also CFBXlsParser.

Attributes:

FVIT_Bool	Boolean type.
FVIT_Error	Error type.
FVIT_Number	Number type.
FVIT_String	String type.
FVIT_Unknown	Unknown type.
str_repr	The string representation of the formula value.
type	The type of the value.

Methods:

getBool()	Returns the boolean value.
getError()	Returns the error value.
getNumber()	Returns the numeric value.

FVIT_Bool: Final[int]

Boolean type.

See also type.

FVIT_Error: Final[int]

Error type.

See also type.

FVIT_Number: Final[int]

Number type.

See also type.

FVIT_String: Final[int]

String type.

See also type.

FVIT_Unknown: Final[int]

Unknown type.

See also type.

getBool() → bool

Returns

Returns the boolean value.

Return type

bool

getError() → int

Returns

Returns the error value.

Return type

int

getNumber() → float

Returns

Returns the numeric value.

Return type

float

str_repr

The string representation of the formula value.

See also type.

type

The type of the value.

See also str_repr.

class CFBXlsName

This class contains the information about an XLS name.

See also CFBXlsParser and CFBXlsBook.

Attributes:

basic_formula_len	The basic length of the formula.
binary	The binary flag.
builtin	The built-in flag.
complex	The complex flag.
excel_sheet_index	The XLS sheet index.
extn_sheet_num	The external sheet number.
formula	The formula string.
func	The function flag.
funcgroup	The function group.
hidden	The hidden flag.
internal_name	The internal name.
macro	The macro flag.
name	The name.
name_index	The name index.
option_flags	The option flags.
raw_formula	The raw formula NTContainer instance.
vbasic	The Visual Basic flag.

Methods:

isValid()

Returns True if the instance is valid; otherwise returns False.

basic_formula_len

The basic length of the formula.

binary

The binary flag.

builtin

The built-in flag.

complex

The complex flag.

excel_sheet_index

The XLS sheet index.

extn_sheet_num

The external sheet number.

formula

The formula string.

func

The function flag.

funcgroup

The function group.

hidden

The hidden flag.

internal_name

The internal name.

isValid() → bool

Returns

Returns True if the instance is valid; otherwise returns False.

Return type

bool

macro

The macro flag.

name

The name.

name_index

The name index.

option_flags

The option flags.

raw_formula

The raw formula NTContainer instance.

vbasic

The Visual Basic flag.

class CFBXlsParser(workbook_stream: Pro.Core.NTContainer)

This class implements the parser functionality for a legacy XLS workbook.

Parameters

workbook_stream (NTContainer) – The workbook stream to parse.

See also CFBXlsBook and Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace.

Methods:

EncryptionType()	Returns the type of encryption.
FilePassRecord()	Returns the file pass record if present; otherwise returns an invalid record.
FindRecord(id)	Find a record by its identifier.
GetFormulaValueInfo(v[, to_string])	Retrieves the value information for a formula.
GetRecordData(r[, max_size])	Retrieves the BIFF record data.
GetRecordDataEx(r, c[, max_size])	Retrieves the BIFF record data.
GetRecordDescr(r[, book])	Retrieves the description for a BIFF record.
GetRecordName(id)	Retrieved the name of a BIFF record.
GetVersion()	Returns the version of the workbook.
GetWorkbookObject()	Returns the Pro.Core.CFFObject workbook instance if successful; otherwise returns an invalid Pro.Core.CFFObject instance.
GetWorkbookStream()	Returns the Pro.Core.NTContainer workbook instance if successful; otherwise returns an invalid Pro.Core.NTContainer instance.
IsEncrypted()	Returns True if the workbook is encrypted; otherwise returns False.
IsRecordFormula(id)	Checks whether the BIFF record identifier represents a formula.
IsXorEncrypted()	Returns True if the workbook is xor encrypted; otherwise returns False.
NextContinuousRecord(r)	Returns the next continuous BIFF record to the one specified.
NextRecord(r)	Retrieves the next record to the one specified.
NumberFromRK(rk)	Converts an RK value to a floating point number.
ParseBoundSheet(book_or_version, c_or_encoding)	Parses a bound sheet.
ParseName(book, c)	Parses an XLS name.
ReadRecord(offs, r)	Reads a BIFF record.
createSiliconSpreadsheetWorkspace(book, w)	Creates a Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace instance from the current instance and specified XLS workbook.

EncryptionType() → int

Returns

Returns the type of encryption.

Return type

int

FilePassRecord() → Pro.CFBF.BiffRecord

Returns

Returns the file pass record if present; otherwise returns an invalid record.

Return type

BiffRecord

FindRecord(id: int) → Pro.CFBF.BiffRecord

Find a record by its identifier.

Parameters

id (int) – The record identifier (e.g., BiffRecordId_Formula).

Returns

Returns the record if present; otherwise returns an invalid record.

Return type

BiffRecord

GetFormulaValueInfo(v: int, to_string: bool = True) → Pro.CFBF.CFBXlsFormulaValueInfo

Retrieves the value information for a formula.

Parameters

• v (int) – The value.

• to_string (bool) – If True, the CFBXlsFormulaValueInfo.str_repr is set.

Returns

Returns the value information.

Return type

CFBXlsFormulaValueInfo

See also CFBXlsFormulaValueInfo.

GetRecordData(r: Pro.CFBF.BiffRecord, max_size: Optional[int] = None) → Pro.Core.NTContainer

Retrieves the BIFF record data.

Parameters

• r (BiffRecord) – The BIFF record.

• max_size (Optional[int]) – The maximum size of the data.

Returns

Returns the record data if successful; otherwise returns an invalid Pro.Core.NTContainer instance.

Return type

NTContainer

See also GetRecordDataEx().

GetRecordDataEx(r: Pro.CFBF.BiffRecord, c: Pro.Core.NTContainer, max_size: Optional[int] = None) → bool

Retrieves the BIFF record data.

Parameters

• r (BiffRecord) – The BIFF record.

• c (NTContainer) – The Pro.Core.NTContainer instance used to append the retrieved data. The instance must be resizable.

• max_size (Optional[int]) – The maximum size of the data.

Returns

Returns True if successful; otherwise returns False.

Return type

bool

See also GetRecordData().

GetRecordDescr(r: Pro.CFBF.BiffRecord, book: Optional[Pro.CFBF.CFBXlsBook] = None) → str

Retrieves the description for a BIFF record.

Parameters

• r (BiffRecord) – The BIFF record.

• book (CFBXlsBook) – The XLS workbook.

Returns

Returns the description if successful; otherwise returns an empty string.

Return type

str

GetRecordName(id: int) → str

Retrieved the name of a BIFF record.

Parameters

id (int) – The BIFF record identifier.

Returns

Returns the name if successful; otherwise returns an empty string.

Return type

str

GetVersion() → int

Returns

Returns the version of the workbook.

Return type

int

Available since Cerbero Suite 6.0 and Cerbero Engine 3.0.

GetWorkbookObject() → Pro.Core.CFFObject

Returns

Returns the Pro.Core.CFFObject workbook instance if successful; otherwise returns an invalid Pro.Core.CFFObject instance.

Return type

CFFObject

See also GetWorkbookStream().

GetWorkbookStream() → Pro.Core.NTContainer

Returns

Returns the Pro.Core.NTContainer workbook instance if successful; otherwise returns an invalid Pro.Core.NTContainer instance.

Return type

NTContainer

See also GetWorkbookObject().

IsEncrypted() → bool

Returns

Returns True if the workbook is encrypted; otherwise returns False.

Return type

bool

IsRecordFormula(id: int) → bool

Checks whether the BIFF record identifier represents a formula.

Parameters

id (int) – The BIFF record identifier.

Returns

Returns True if the record identifier represents a formula; otherwise returns False.

Return type

bool

IsXorEncrypted() → bool

Returns

Returns True if the workbook is xor encrypted; otherwise returns False.

Return type

bool

NextContinuousRecord(r: Pro.CFBF.BiffRecord) → bool

Returns the next continuous BIFF record to the one specified.

Parameters

r (BiffRecord) – The input/output BIFF record.

Returns

Returns True if the retrieved record has a BiffRecordId_Continue identifier; otherwise returns False.

Return type

bool

See also NextRecord().

NextRecord(r: Pro.CFBF.BiffRecord) → bool

Retrieves the next record to the one specified.

Parameters

r (BiffRecord) – The input/output BIFF record.

Returns

Returns True if successful; otherwise returns False.

Return type

bool

See also ReadRecord() and NextContinuousRecord().

NumberFromRK(rk: int) → float

Converts an RK value to a floating point number.

Parameters

rk (int) – The RK value.

Returns

Returns the floating point number.

Return type

float

ParseBoundSheet(book_or_version: Union[Pro.CFBF.CFBXlsBook, int], c_or_encoding: Union[Pro.Core.NTContainer, int], c: Optional[Pro.Core.NTContainer] = None) → Pro.CFBF.CFBXlsSheet

Parses a bound sheet.

This method is declared the following ways:

def ParseBoundSheet(version: int, encoding: int, c: NTContainer) -> CFBXlsSheet
def ParseBoundSheet(book: CFBXlsBook, c: NTContainer) -> CFBXlsSheet

Parameters

• book_or_version (Union[CFBXlsBook, int]) – Either the version of the XLS workbook or the XLS workbook.

• c_or_encoding (Union[NTContainer, int]) – Either the input data or the encoding of the XLS workbook.

• c (Optional[NTContainer]) – The input data.

Returns

Returns the sheet instance if successful; otherwise returns an invalid CFBXlsSheet instance.

Return type

CFBXlsSheet

See also CFBXlsSheet.

ParseName(book: Pro.CFBF.CFBXlsBook, c: Pro.Core.NTContainer) → Pro.CFBF.CFBXlsName

Parses an XLS name.

Parameters

• book (CFBXlsBook) – The XLS workbook.

• c (NTContainer) – The input data.

Returns

Returns the name instance if successful; otherwise returns an invalid CFBXlsName instance.

Return type

CFBXlsName

See also CFBXlsName.

ReadRecord(offs: int, r: Pro.CFBF.BiffRecord) → bool

Reads a BIFF record.

Parameters

• offs (int) – The offset of the BIFF record.

• r (BiffRecord) – The BIFF record instance.

Returns

Returns True if successful; otherwise returns False.

Return type

bool

See also NextRecord().

createSiliconSpreadsheetWorkspace(book: CFBXlsBook, w: SiliconSpreadsheetWorkspace) → bool

Creates a Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace instance from the current instance and specified XLS workbook.

Parameters

• book (CFBXlsBook) – The XLS workbook.

• w (SiliconSpreadsheetWorkspace) – The output Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace instance.

Returns

Returns True if successful; otherwise returns False.

Return type

bool

See also Pro.SiliconSpreadsheet.SiliconSpreadsheetWorkspace.

class CFBXlsSheet

This class represents an XLS workbook sheet.

See also CFBXlsBook and CFBXlsParser.

Attributes:

descr	The description of the sheet.
name	The name of the sheet.
type	The type of the sheet.
visibility	The visibility of the sheet.

Methods:

isHiddenOrVeryHidden()	Returns True if the sheet is either hidder or very hidden; otherwise returns False.
isValid()	Returns True if the current instance is valid; otherwise returns False.

descr

The description of the sheet.

isHiddenOrVeryHidden() → bool

Returns

Returns True if the sheet is either hidder or very hidden; otherwise returns False.

Return type

bool

isValid() → bool

Returns

Returns True if the current instance is valid; otherwise returns False.

Return type

bool

name

The name of the sheet.

type

The type of the sheet.

visibility

The visibility of the sheet.

class CFBXlsSheetList

List of CFBXlsSheet elements.

Methods:

append(value)	Inserts value at the end of the list.
at(i)	Returns the item at index position i in the list.
clear()	Removes all items from the list.
contains(value)	Checks the presence of an element in the list.
count(value)	Returns the number of occurrences of value in the list.
indexOf(value[, start])	Searches for an element in the list.
insert(i, value)	Inserts value at index position i in the list.
isEmpty()	Checks whether the list is empty.
iterator()	Creates an iterator for the list.
removeAll(value)	Removes all occurrences of value in the list and returns the number of entries removed.
removeAt(i)	Removes the item at index position i.
reserve(alloc)	Reserve space for alloc elements.
size()	Returns the number of items in the list.
takeAt(i)	Removes the item at index position i and returns it.

append(value: Pro.CFBF.CFBXlsSheet) → None

Inserts value at the end of the list.

Parameters

value (CFBXlsSheet) – The value to add to the list.

See also insert().

at(i: int) → Pro.CFBF.CFBXlsSheet

Returns the item at index position i in the list. i must be a valid index position in the list (i.e., 0 <= i < size()).

Parameters

i (int) – The index of the element to return.

Returns

Returns the requested element.

Return type

CFBXlsSheet

clear() → None

Removes all items from the list.

contains(value: Pro.CFBF.CFBXlsSheet) → bool

Checks the presence of an element in the list.

Parameters

value (CFBXlsSheet) – The value to check for.

Returns

Returns True if the list contains an occurrence of value; otherwise returns False.

Return type

bool

See also indexOf() and count().

count(value: Pro.CFBF.CFBXlsSheet) → int

Returns the number of occurrences of value in the list.

Parameters

value (CFBXlsSheet) – The value to count.

Returns

Returns the number of occurrences.

Return type

int

See also indexOf() and contains().

indexOf(value: Pro.CFBF.CFBXlsSheet, start: int = 0) → int

Searches for an element in the list.

Parameters

• value (CFBXlsSheet) – The value to search for.

• start (int) – The start index.

Returns

Returns the index position of the first occurrence of value in the list. Returns -1 if no item was found.

Return type

int

See also contains().

insert(i: int, value: Pro.CFBF.CFBXlsSheet) → None

Inserts value at index position i in the list. If i is 0, the value is prepended to the list. If i is size(), the value is appended to the list.

Parameters

• i (int) – The position at which to add the value.

• value (CFBXlsSheet) – The value to add.

See also append() and removeAt().

isEmpty() → bool

Checks whether the list is empty.

Returns

Returns True if the list contains no items; otherwise returns False.

Return type

bool

See also size().

iterator() → Pro.CFBF.CFBXlsSheetListIt

Creates an iterator for the list.

Returns

Returns the iterator.

Return type

CFBXlsSheetListIt

removeAll(value: Pro.CFBF.CFBXlsSheet) → int

Removes all occurrences of value in the list and returns the number of entries removed.

Parameters

value (CFBXlsSheet) – The value to remove from the list.

Returns

Returns the number of entries removed.

Return type

int

See also removeAt().

removeAt(i: int) → None

Removes the item at index position i. i must be a valid index position in the list (i.e., 0 <= i < size()).

Parameters

i (int) – The index of the item to remove.

See also removeAll().

reserve(alloc: int) → None

Reserve space for alloc elements. Calling this method doesn’t change the size of the list.

Parameters

alloc (int) – The amount of elements to reserve space for.

size() → int

Returns

Returns the number of items in the list.

Return type

int

See also isEmpty().

takeAt(i: int) → Pro.CFBF.CFBXlsSheet

Removes the item at index position i and returns it. i must be a valid index position in the list (i.e., 0 <= i < size()).

Parameters

i (int) – The index of the element to remove from the list.

Returns

Returns the removed element. If you don’t use the return value, removeAt() is more efficient.

Return type

CFBXlsSheet

See also removeAt().

class CFBXlsSheetListIt(obj: Pro.CFBF.CFBXlsSheetList)

Iterator class for CFBXlsSheetList.

Parameters

obj (CFBXlsSheetList) – The object to iterate over.

Methods:

hasNext()	Returns True if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container; otherwise returns False.
hasPrevious()	Returns True if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container; otherwise returns False.
next()	Returns the next item and advances the iterator by one position.
previous()	Returns the previous item and moves the iterator back by one position.
toBack()	Moves the iterator to the back of the container (after the last item).
toFront()	Moves the iterator to the front of the container (before the first item).

hasNext() → bool

Returns

Returns True if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container; otherwise returns False.

Return type

bool

See also hasPrevious() and next().

hasPrevious() → bool

Returns

Returns True if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container; otherwise returns False.

Return type

bool

See also hasNext() and previous().

next() → Pro.CFBF.CFBXlsSheet

Returns

Returns the next item and advances the iterator by one position.

Return type

CFBXlsSheet

See also hasNext() and previous().

previous() → Pro.CFBF.CFBXlsSheet

Returns

Returns the previous item and moves the iterator back by one position.

Return type

CFBXlsSheet

See also hasPrevious() and next().

toBack() → None

Moves the iterator to the back of the container (after the last item).

See also toFront() and previous().

toFront() → None

Moves the iterator to the front of the container (before the first item).

See also toBack() and next().

class CFBXlsUtil

This class contains static utility methods.

Methods:

readString(r, encoding[, lenlen, known_len])	Reads a string.
readUnicodeString(r[, lenlen, known_len])	Reads a unicode string.

static readString(r: Pro.Core.NTBuffer, encoding: int, lenlen: int = 1, known_len: int = - 1) → str

Reads a string.

Parameters

• r (NTBuffer) – The input buffer instance.

• encoding (int) – The encoding.

• lenlen (int) – The length of the string length.

• known_len (int) – The known length of the string.

Returns

Returns the string if successful; otherwise returns an empty string.

Return type

str

See also readUnicodeString().

static readUnicodeString(r: Pro.Core.NTBuffer, lenlen: int = 2, known_len: int = - 1) → str

Reads a unicode string.

Parameters

• r (NTBuffer) – The input buffer instance.

• lenlen (int) – The length of the string length.

• known_len (int) – The known length of the string.

Returns

Returns the string if successful; otherwise returns an empty string.

Return type

str

See also readString().

DIROBJECT_ROOTSTORAGE: Final[int]

Root storage flag returned by CFBObject.Directory().Uns("ObjectType").

DIROBJECT_STORAGE: Final[int]

Storage flag returned by CFBObject.Directory().Uns("ObjectType").

DIROBJECT_STREAM: Final[int]

Stream flag returned by CFBObject.Directory().Uns("ObjectType").

DIROBJECT_UNKNOWN_OR_UNALLOCATED: Final[int]

Unknown or unallocated flag returned by CFBObject.Directory().Uns("ObjectType").

ExcelFormulaType_All: Final[int]

All types of Excel formulas.

See also ExcelMacroDecompiler.decompile().

ExcelFormulaType_Array: Final[int]

Excel array formula type.

See also ExcelMacroDecompiler.decompile().

ExcelFormulaType_Cell: Final[int]

Excel cell formula type.

See also ExcelMacroDecompiler.decompile().

ExcelFormulaType_CondFmt: Final[int]

Excel conditional format formula type.

See also ExcelMacroDecompiler.decompile().

ExcelFormulaType_DataVal: Final[int]

Excel data formula type.

See also ExcelMacroDecompiler.decompile().

ExcelFormulaType_Name: Final[int]

Excel name formula type.

See also ExcelMacroDecompiler.decompile().

ExcelFormulaType_Shared: Final[int]

Excel shared formula type.

See also ExcelMacroDecompiler.decompile().

class ExcelMacroDecompiler

This class contains the functionality to decompile XLS macros.

Methods:

cellName(rowx, colx)	Returns the name of a cell from its coordinates.
decompile(out, book, data[, type, browx, …])	Decompiles an XLS macro.

static cellName(rowx: int, colx: int) → str

Returns the name of a cell from its coordinates.

Parameters

• rowx (int) – The row coordinate.

• colx (int) – The column coordinate.

Returns

Returns the name of the cell.

Return type

str

decompile(out: Pro.Core.NTTextStream, book: Pro.CFBF.CFBXlsBook, data: Pro.Core.NTContainer, type: int = 0, browx: int = - 1, bcolx: int = - 1, verbose: bool = True, level: int = 0, r1c1: int = 0) → int

Decompiles an XLS macro.

Parameters

• out (NTTextStream) – The output text stream.

• book (CFBXlsBook) – The XLS workbook.

• data (NTContainer) – The macro data.

• type (int) – The type of the macro (e.g., ExcelFormulaType_Cell).

• browx (int) – The relative row coordinate.

• bcolx (int) – The relative column coordinate.

• verbose (bool) – If True, provides verbose output.

• level (int) – The current level of decompiling.

• r1c1 (int) – If not 0, provides R1C1 output.

Returns

Returns ExcelMacroDecompilerErr_None if successful; otherwise return an error code.

Return type

int

ExcelMacroDecompilerErr_Decompile: Final[int]

Excel decompiler error result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_None: Final[int]

Excel decompiler success result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_Opcode: Final[int]

Excel decompiler opcode error result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_Operation: Final[int]

Excel decompiler operation error result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_Read: Final[int]

Excel decompiler read error result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_Size: Final[int]

Excel decompiler size error result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_Stack: Final[int]

Excel decompiler stack error result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_Token: Final[int]

Excel decompiler token error result.

See also ExcelMacroDecompiler.decompile().

ExcelMacroDecompilerErr_Unsupported: Final[int]

Excel decompiler unsupported error result.

See also ExcelMacroDecompiler.decompile().

NOSTREAM: Final[int]

A special value used to mark sibling/child fields as unused.

SECNUM_DIFSECT: Final[int]

Specifies a DIFAT sector in the FAT.

SECNUM_ENDOFCHAIN: Final[int]

End of linked chain of sectors.

SECNUM_FATSECT: Final[int]

Specifies a FAT sector in the FAT.

SECNUM_FREESEC: Final[int]

Specifies unallocated sectors in the FAT, mini FAT or DIFAT.

SECNUM_MAXREGSECT: Final[int]

Maximum regular sector number.