Document Solutions for Excel, .NET Edition | Document Solutions
GrapeCity.Documents.Excel Namespace / IWorkbook Interface
Properties Methods Events

In This Topic
    IWorkbook Interface Members
    In This Topic

    The following tables list the members exposed by IWorkbook.

    Public Properties
     NameDescription
    PropertyActiveSheet Returns an object that represents the active sheet (the sheet on top) in the active workbook or in the specified window or workbook. Returns null if no sheet is active (read-only).  
    PropertyAllowDynamicArray Gets or sets whether allow dynamic array formula.  
    PropertyAutoParse Determines whether to automatically parse when setting a range value to a string value.  
    PropertyAutoRoundValue Determines whether to round the number to 15 significant figures when getting the value.  
    PropertyBookView Returns an object that represents the view settings of this workbook(read-only).  
    PropertyBuiltInDocumentProperties Gets a collection that represents all the built-in document properties of the workbook.  
    PropertyCulture [Init-only] Gets or sets culture for the workbook. The culture must contain both country/region and language.  
    PropertyCustomDocumentProperties Gets a collection that represents all the custom document properties of the workbook.  
    PropertyCustomViews Gets the custom views of the workbook.  
    PropertyDefaultTableStyleSpecifies the table style name from the ITableStyleCollection collection that is used as the default TableStyle (read/write).  
    PropertyDeferUpdateDirtyState Gets or sets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
    PropertyEnableCalculation Gets or sets whether the calculation engine is valid.  
    PropertyFullName Returns the name of the workbook, including its path on disk.  
    PropertyGraphicsInfo Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
    PropertyName Gets or sets a string value that represents the name of the workbook.  
    PropertyNamesReturns the INames collection that represents the workbook-specified names. This is a read-only INames object.  
    PropertyOptionsReturns the IExcelOptions object that represents some settings to control workbook behavior.  
    PropertyPath Gets or sets a string that represents the path to the workbook file that this workbook object represents.  
    PropertyPivotCachesReturns the IPivotCaches collection that represents all the IPivotTable caches in the specified workbook (read-only).  
    PropertyProtectStructure True if the order of the sheets in the workbook is protected. Read-only Boolean.  
    PropertyProtectWindows True if the windows of the workbook are protected. Read-only Boolean.  
    PropertyReferenceStyle Gets or sets the reference style.  
    PropertyResetAdjacentRangeBorder Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true.  
    PropertySelectedSheetsReturns a IWorksheets collection that represents all the selected sheets in the specified workbook.  
    PropertyShowPivotTableFieldList Gets or sets a value indicating whether the PivotTable field list can be shown. Default is true.  
    PropertySignatures Gets a collection of Signature objects that correspond to the digital signature attached to a document.  
    PropertySlicerCachesGets the ISlicerCaches object associated with the workbook.  
    PropertyStylesReturns the IStyleCollection collection that represents all the styles in the specified workbook (read-only).  
    PropertyTableStylesReturns the ITableStyleCollection collection object for the current workbook that refers to the styles used in the current workbook (read-only).  
    PropertyTheme Returns or sets the theme applied to the current workbook.  
    PropertyWorksheetsReturns the IWorksheets collection that represents all the worksheets in the specified workbook. This is a read-only Sheets object.  
    PropertyWriteProtection Provides access to the workbook write protection options.  
    Top
    Public Methods
     NameDescription
    MethodAddDataSource Add data source for template.  
    MethodCalculate Calculates formulas of the workbook as needed.  
    MethodConvertBarcodeToPictureConvert the calculated barcodes to pictures and place them in their respective positions. The original barcode formulas will be cleared.
    Not support GrapeCity.Documents.Excel.Drawing.ImageType.EMF and GrapeCity.Documents.Excel.Drawing.ImageType.WMF image types.  
    MethodDirty Designates all the formulas of the workbook to be recalculated when the next calculation occurs.  
    MethodFromJsonOverloaded.  Generates a workbook from a JSON string.  
    MethodFromSjsJsonOverloaded.  Generates a workbook from a JSON string containing the contents of .sjs file format.  
    MethodGenerateReportOverloaded.  Process the template and return the instance of report workbook.  
    MethodGetExcelLinkSources Returns the names of the linked excel documents.  
    MethodGetUsedFonts Gets all fonts information that used on workbook.  
    MethodIsEncryptedFileOverloaded.  Specifies whether the file is password protected.  
    MethodOpenOverloaded.  Opens the file.  
    MethodPrintOut Prints the workbook.  
    MethodProcessTemplateOverloaded.  Start to process the template  
    MethodProtectOverloaded.  Protects a workbook so that it cannot be modified.  
    MethodSaveOverloaded.  Saves the workbook to the disk.  
    MethodToJsonOverloaded.  Generates a JSON string from a workbook.  
    MethodToSjsJsonOverloaded.  Integrates all JSON files from the SJS file into a single string, then put the string into the stream.  
    MethodUnprotect Removes protection from the workbook.  
    MethodUpdateExcelLinkOverloaded.  Updates a excel link.  
    MethodUpdateExcelLinks Updates all the excel links.  
    MethodWaitForCalculationToFinish Waits for all calculation to complete, including asynchronous calculations. This method blocks the current thread until all calculations have finished. Users can call this method to ensure that all necessary computations have been performed before proceeding with any other operations that depend on the calculation results.  
    Top
    Public Events
     NameDescription
    EventAfterSave Occurs after the workbook is saved.  
    EventBeforeSave Occurs before the workbook is saved.  
    EventNewSheet Occurs when a new sheet is created in the workbook.  
    EventOpened Occurs when the workbook is opened.  
    EventSheetActivate Occurs when a sheet is activate.  
    EventSheetBeforeDelete Occurs before a sheet is deleted.  
    EventSheetChange Occurs when something changes in the cells of a sheet.  
    EventSheetDeactivate Occurs when a sheet is deactivated.  
    EventSheetSelectionChange Occurs when the selection changes on a sheet.  
    Top
    See Also

    Reference

    IWorkbook Interface
    GrapeCity.Documents.Excel Namespace