Document Solutions for Excel, Java Edition | Document Solutions
com.grapecity.documents.excel Package / IWorkbook Interface
Methods

In This Topic
    IWorkbook Interface Members
    In This Topic

    The following tables list the members exposed by IWorkbook.

    Public Methods
     NameDescription
     MethodAdd data source for template.  
     MethodCalculates formulas of the workbook as needed.  
     MethodOverloaded. Convert the calculated barcodes to pictures and place them in their respective positions.
    The original barcode formulas will be cleared.
    The com.grapecity.documents.excel.drawing.ImageType of converted image is com.grapecity.documents.excel.drawing.ImageType.SVG.  
     MethodDesignates all the formulas of the workbook to be recalculated when the next calculation occurs.  
     MethodOverloaded. Generates a workbook from a json string.  
     MethodOverloaded. Generates a workbook from a JSON string containing the contents of .sjs file format.  
     MethodOverloaded. Process the template and return the instance of report workbook.  
     MethodReturns 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.  
     MethodOccurs after the workbook is saved.  
     MethodGets whether allow dynamic array formula.  
     MethodGets the author.  
     MethodGets whether to automatically parse when setting a range value to a string value.  
     MethodGets whether to round the number to 15 significant figures when getting the value.  
     MethodOccurs before the workbook is saved.  
     MethodReturns an object that represents the view settings of this workbook.  
     MethodGets a collection that represents all the built-in document properties of the workbook.  
     MethodGets culture info for the workbook. Which influences the feature related culture.  
     MethodGets a collection that represents all the custom document properties of the workbook.  
     MethodGets the custom views of the workbook.  
     MethodGets the table style name from the ITableStyleCollection collectionthat is used as the default TableStyle.  
     MethodGets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
     MethodGets whether the calculation engine is valid.  
     MethodReturns the names of the linked excel documents.  
     MethodReturns the name of the workbook, including its path on disk.  
     MethodProvides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
     MethodFilters data in a workbook based on a cell icon from the IconSets collection.  
     MethodGets a string value that represents the name of the workbook.  
     MethodReturns the INames collection that represents the workbook-specified names.  
     MethodOccurs when a new sheet is created in the workbook.  
     MethodOccurs when the workbook is opened.  
     MethodReturns the IExcelOptions object that represents some settings to control workbook behavior.  
     MethodGets a string that represents the path to the workbook file that this workbook object represents.  
     MethodReturns the IPivotCaches collection that represents all the IPivotTable caches in the specified workbook.  
     MethodTrue if the order of the sheets in the workbook is protected. Read-only Boolean.  
     MethodTrue if the windows of the workbook are protected. Read-only Boolean.  
     MethodGets the reference style.  
     MethodDetermines whether to reset adjacent range's border when setting border for a range. The default value of this property is true.  
     MethodReturns a @code:IWorksheets collectionthat represents all the selected sheets in the specified workbook.  
     MethodOccurs when a sheet is activate.  
     MethodOccurs before a sheet is deleted.  
     MethodOccurs when something changes in the cells of a sheet.  
     MethodOccurs when a sheet is deactivated.  
     MethodOccurs when the selection changes on a sheet.  
     MethodGets a collection of Signature objects that correspond to the digital signature attached to a document.  
     MethodGets the ISlicerCaches object associated with the workbook.  
     MethodReturns the IStyleCollection collection that represents all thestyles in the specified workbook.  
     MethodReturns the ITableStyleCollection collection object for the currentworkbook that refers to the styles used in the current workbook.  
     MethodReturns the theme applied to the current workbook.  
     MethodGets all fonts information that used on workbook.  
     MethodReturns the IWorksheets collection that represents all the worksheetsin the specified workbook. This is a read-only Sheets object.  
     MethodReturns a WriteProtection object that provides access to the workbook write protection options.  
     MethodOverloaded. Specifies whether the file is password protected.  
     MethodOverloaded. Opens the specified excel file  
     MethodOverloaded. Start to process the template.  
     MethodOverloaded. Protects a workbook so that it cannot be modified.  
     MethodOverloaded. Saves the workbook to the disk.  
     MethodSets whether allow dynamic array formula.  
     MethodSets the author.  
     MethodSets whether to automatically parse when setting a range value to a string value.  
     MethodSets whether to round the number to 15 significant figures when getting the value.  
     MethodSets culture info for the workbook. Which influences the feature related culture.

    The culture must contain both country/region and language. For example:

    • java.util.Locale.CHINA
    • java.util.Locale.KOREA
    • java.util.Locale.US
     
     MethodSets the table style name from the ITableStyleCollection collectionthat is used as the default TableStyle.  
     MethodSets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
     MethodSets whether the calculation engine is valid.  
     MethodProvides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
     MethodSets a string value that represents the name of the workbook.  
     MethodSets a string that represents the path to the workbook file that this workbook object represents.  
     MethodSets the reference style.  
     MethodDetermines whether to reset adjacent range's border when setting border for a range. The default value of this property is true.  
     MethodSets the theme applied to the current workbook.  
     MethodOverloaded. Generates a json string from a workbook.  
     MethodOverloaded. Generates a JSON string from a workbook. It integrates all JSON files from the SpreadJS .sjs file into a single string.  
     MethodOverloaded. Removes protection from the workbook.  
     MethodOverloaded. Updates a excel link.  
     MethodUpdates all the excel links.  
     MethodWaits 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
    See Also