Document Solutions for Excel, Java Edition | Document Solutions
com.grapecity.documents.excel Package / Workbook Class

In This Topic
    Workbook Class Methods
    In This Topic

    For a list of all members of this type, see Workbook members.

    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)Overloaded. Add custom function into the function set.  
    Public MethodAdd data source for template  
    Public MethodCalculates formulas in the workbook as needed.  
    Public MethodDesignates all the formulas of the workbook to be recalculated when the next calculation occurs.  
    Public MethodOverloaded. Generates a workbook from the JSON string.  
    Public MethodOverloaded. Process the template and return the instance of report workbook.  
    Public MethodGets the active sheet.  
    Public MethodOccurs after the workbook is saved.  
    Public MethodGets whether allow dynamic array formula. This method is obsoleted, please use getFormula2() to get dynamic array formula.  
    Public MethodGets the author.  
    Public MethodDetermines whether to parse automatically when setting range value to string value.  
    Public MethodDetermines whether to round the number to 15 significant figures when getting the value.  
    Public MethodOccurs before the workbook is saved.  
    Public MethodReturns an object that represents the view settings of this workbook.  
    Public MethodGets a collection that represents all the built-in document properties of the workbook.  
    Public MethodGets the culture info of workbook, default is Locale.getDefault().  
    Public MethodGets a collection that represents all the custom document properties of the workbook.  
    Public MethodGets a collection that represents all the custom document properties of the workbook.  
    Public MethodSpecifies the table style that is used as the default TableStyle.  
    Public MethodGets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
    Public MethodSpecifies whether the calculation engine is working.  
    Public MethodReturns the names of the linked excel documents.  
    Public MethodReturns the name of the workbook, including its path on disk.  
    Public MethodProvides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
    Public MethodFilters data in a workbook based on a cell icon from the IconSets collection.  
    Public MethodGets a string value that represents the name of the workbook.  
    Public MethodOverloaded. Returns the INames collection that represents the workbook-specified names.  
    Public MethodOccurs when a new sheet is created in the workbook.  
    Public MethodOccurs when the workbook is opened.  
    Public MethodReturns the IExcelOptions object that represents some settings to control workbook behavior.  
    Public MethodGets a string that represents the path to the workbook file that this workbook object represents.  
    Public MethodGets a PivotCaches collection that represents all the PivotTable caches in the specified workbook.  
    Public MethodTrue if the order of the sheets in the workbook is protected. Read-only Boolean.  
    Public MethodTrue if the windows of the workbook are protected. Read-only Boolean.  
    Public MethodGets the reference style.  
    Public MethodDetermines whether to reset adjacent range's border when setting border for a range. The default value of this property is true  
    Public MethodReturns a IWorksheets collection that represents all the selected sheets in the specified workbook.  
    Public MethodOccurs when a sheet is active.  
    Public MethodOccurs before a sheet is deleted.  
    Public MethodOccurs when something changes in the cells of a sheet.  
    Public MethodOccurs when a sheet is deactivated.  
    Public MethodOccurs when the selection changes on a sheet.  
    Public MethodGets a collection of Signature objects that correspond to the digital signature attached to a document.  
    Public MethodGets the ISlicerCaches object associated with the workbook.  
    Public MethodProvides access to the collection of cell styles in the current workbook.  
    Public MethodGets the table styles used in the current workbook.  
    Public Methodstatic (Shared in Visual Basic)Gets JSON serializer for custom type  
    Public MethodReturns an instance of ITheme which provides access to the theme associated with a workbook.  
    Public MethodGets all fonts information that are used on workbook.  
    Public Methodstatic (Shared in Visual Basic)Gets JSON serializer for custom type  
    Public MethodGets a collection of worksheets contained in the workbook.  
    Public MethodProvides access to the workbook write protection options.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Import all the data of the specified source of the file.  
    Public MethodOverloaded. Specifies whether the file is password protected.  
    Public MethodOverloaded. Opens the file with default options. The file type is inferred from file extension.  
    Public MethodStart to process the template  
    Public MethodOverloaded. Protects a workbook so that it cannot be modified.  
    Public MethodOverloaded. Saves the workbook to the disk.  
    Public MethodSets whether allow dynamic array formula.This method is obsoleted, please use setFormula2() to set dynamic array formula.  
    Public MethodSets the author.  
    Public MethodSets whether to automatically parse when setting a range value to a string value.  
    Public MethodSets whether to round the number to 15 significant figures when getting the value.  
    Public MethodSets culture info for the workbook. Which influences the feature related culture.  
    Public MethodSets the table style name from the ITableStyleCollection collectionthat is used as the default TableStyle.  
    Public MethodSets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
    Public MethodSets whether the calculation engine is valid.  
    Public MethodProvides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
    Public Methodstatic (Shared in Visual Basic)For licenses of the Chinese market, apply deployment license or unlimited dev license from file.

    This method shouldn't be called if your license was purchased from other markets.

     
    Public Methodstatic (Shared in Visual Basic)Sets license for all workbook instances.

    Important: For licenses of the Chinese market, use @code:SetLicenseFile orset license in the @code:GCEXCEL_JAVA_DEPLOY_LICENSE_V5 environment variable instead.

     
    Public MethodSets a string value that represents the name of the workbook.  
    Public MethodSets a string that represents the path to the workbook file that this workbook object represents.  
    Public MethodSets the reference style.  
    Public MethodDetermines whether to reset adjacent range's border when setting border for a range. The default value of this property is true  
    Public Methodstatic (Shared in Visual Basic)Sets JSON serializer for custom type in from/to JSON.  
    Public MethodSets the theme applied to the current workbook.  
    Public Methodstatic (Shared in Visual Basic)Sets JSON serializer for custom type in from/to JSON.  
    Public MethodOverloaded. Generates a JSON string from the workbook.  
    Public MethodOverloaded. Integrates all JSON files from the SpreadJS .sjs file into a single string, then put the string into the stream.  
    Public MethodOverloaded. Removes protection from the workbook.  
    Public MethodOverloaded. Updates a excel link.  
    Public MethodUpdates all the excel links.  
    Top
    See Also