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

In This Topic
    Workbook Class Members
    In This Topic

    The following tables list the members exposed by Workbook.

    Public Constructors
     NameDescription
    Public ConstructorWorkbook ConstructorOverloaded.   
    Top
    Public Fields
     NameDescription
    Public FieldFontProviderGets or sets the font provider that will be used when using Auto fit, PDF export, and Image export.  
    Public FieldFontsFolderPathGets or sets the location of font files that will be used when exporting pdf.  
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)AddCustomFunctionOverloaded. Add custom function into the function set.  
    Public MethodaddDataSourceAdd data source for template.  
    Public MethodcalculateCalculates formulas in the workbook as needed.  
    Public MethodconvertBarcodeToPictureOverloaded. 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.  
    Public MethoddirtyDesignates all the formulas of the workbook to be recalculated when the next calculation occurs.  
    Public MethodfromJsonOverloaded. Generates a workbook from the JSON string.  
    Public MethodfromSjsJsonOverloaded. Generates a workbook from a JSON string containing the contents of .sjs file format.  
    Public MethodgenerateReportOverloaded. Process the template and return the instance of report workbook.  
    Public MethodgetActiveSheetGets the active sheet.  
    Public MethodgetAfterSaveEventOccurs after the workbook is saved.  
    Public MethodgetAllowDynamicArrayGets whether allow dynamic array formula.  
    Public MethodgetAuthorGets the author.  
    Public MethodgetAutoParseDetermines whether to parse automatically when setting range value to string value.  
    Public MethodgetAutoRoundValueDetermines whether to round the number to 15 significant figures when getting the value.  
    Public MethodgetBeforeSaveEventOccurs before the workbook is saved.  
    Public MethodgetBookViewReturns an object that represents the view settings of this workbook.  
    Public MethodgetBuiltInDocumentPropertiesGets a collection that represents all the built-in document properties of the workbook.  
    Public MethodgetCultureGets the culture info of workbook, default is Locale.getDefault().  
    Public MethodgetCustomDocumentPropertiesGets a collection that represents all the custom document properties of the workbook.  
    Public MethodgetCustomViewsGets a collection that represents all the custom document properties of the workbook.  
    Public MethodgetDefaultTableStyleSpecifies the table style that is used as the default TableStyle.  
    Public MethodgetDeferUpdateDirtyStateGets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
    Public MethodgetEnableCalculationSpecifies whether the calculation engine is working.  
    Public MethodgetExcelLinkSourcesReturns the names of the linked excel documents.  
    Public MethodgetFullNameReturns the name of the workbook, including its path on disk.  
    Public MethodgetGraphicsInfoProvides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
    Public MethodgetIconSetsFilters data in a workbook based on a cell icon from the IconSets collection.  
    Public MethodgetNameGets a string value that represents the name of the workbook.  
    Public MethodgetNamesOverloaded. Returns the INames collection that represents the workbook-specified names.  
    Public MethodgetNewSheetEventOccurs when a new sheet is created in the workbook.  
    Public MethodgetOpenedEventOccurs when the workbook is opened.  
    Public MethodgetOptionsReturns the IExcelOptions object that represents some settings to control workbook behavior.  
    Public MethodgetPathGets a string that represents the path to the workbook file that this workbook object represents.  
    Public MethodgetPivotCachesGets a PivotCaches collection that represents all the PivotTable caches in the specified workbook.  
    Public MethodgetProtectStructureTrue if the order of the sheets in the workbook is protected. Read-only Boolean.  
    Public MethodgetProtectWindowsTrue if the windows of the workbook are protected. Read-only Boolean.  
    Public MethodgetReferenceStyleGets the reference style.  
    Public MethodgetResetAdjacentRangeBorderDetermines whether to reset adjacent range's border when setting border for a range. The default value of this property is true.  
    Public MethodgetSelectedSheetsReturns a IWorksheets collection that represents all the selected sheets in the specified workbook.  
    Public MethodgetSheetActivateEventOccurs when a sheet is active.  
    Public MethodgetSheetBeforeDeleteEventOccurs before a sheet is deleted.  
    Public MethodgetSheetChangeEventOccurs when something changes in the cells of a sheet.  
    Public MethodgetSheetDeactivateEventOccurs when a sheet is deactivated.  
    Public MethodgetSheetSelectionChangeOccurs when the selection changes on a sheet.  
    Public MethodgetShowPivotTableFieldListGets a value indicating whether the PivotTable field list can be shown. Default is true.  
    Public MethodgetSignaturesGets a collection of Signature objects that correspond to the digital signature attached to a document.  
    Public MethodgetSlicerCachesGets the ISlicerCaches object associated with the workbook.  
    Public MethodgetStylesProvides access to the collection of cell styles in the current workbook.  
    Public MethodgetTableStylesGets the table styles used in the current workbook.  
    Public Methodstatic (Shared in Visual Basic)getTagJsonSerializerGets JSON serializer for custom type  
    Public MethodgetThemeReturns an instance of ITheme which provides access to the theme associated with a workbook.  
    Public MethodgetUsedFontsGets all fonts information that are used on workbook.  
    Public Methodstatic (Shared in Visual Basic)getValueJsonSerializerGets JSON serializer for custom type  
    Public Methodstatic (Shared in Visual Basic)getWebRequestHandlerGets the singleton instance of the IWebRequestHandler implementation that will be used to handle web requests. This property provides a centralized way to access the web request handler for the application.  
    Public MethodgetWorksheetsGets a collection of worksheets contained in the workbook.  
    Public MethodgetWriteProtectionProvides access to the workbook write protection options.  
    Public Methodstatic (Shared in Visual Basic)importDataOverloaded. Import all the data of the specified source of the file.  
    Public MethodisEncryptedFileOverloaded. Specifies whether the file is password protected.  
    Public MethodopenOverloaded. Opens the file with default options. The file type is inferred from file extension.  
    Public MethodprocessTemplateOverloaded. Start to process the template.  
    Public MethodprotectOverloaded. Protects a workbook so that it cannot be modified.  
    Public MethodsaveOverloaded. Saves the workbook to the disk.  
    Public MethodsetAllowDynamicArraySets whether allow dynamic array formula.  
    Public MethodsetAuthorSets the author.  
    Public MethodsetAutoParseSets whether to automatically parse when setting a range value to a string value.  
    Public MethodsetAutoRoundValueSets whether to round the number to 15 significant figures when getting the value.  
    Public MethodsetCultureSets 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
     
    Public MethodsetDefaultTableStyleSets the table style name from the ITableStyleCollection collectionthat is used as the default TableStyle.  
    Public MethodsetDeferUpdateDirtyStateSets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
    Public MethodsetEnableCalculationSets whether the calculation engine is valid.  
    Public MethodsetGraphicsInfoProvides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
    Public Methodstatic (Shared in Visual Basic)SetLicenseFileFor 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)SetLicenseKeySets license for all workbook instances.

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

     
    Public MethodsetNameSets a string value that represents the name of the workbook.  
    Public MethodsetPathSets a string that represents the path to the workbook file that this workbook object represents.  
    Public MethodsetReferenceStyleSets the reference style.  
    Public MethodsetResetAdjacentRangeBorderDetermines whether to reset adjacent range's border when setting border for a range. The default value of this property is true.  
    Public MethodsetShowPivotTableFieldListSets a value indicating whether the PivotTable field list can be shown. Default is true.  
    Public Methodstatic (Shared in Visual Basic)setTagJsonSerializerSets JSON serializer for custom type in from/to JSON.  
    Public MethodsetThemeSets the theme applied to the current workbook.  
    Public Methodstatic (Shared in Visual Basic)setValueJsonSerializerSets JSON serializer for custom type in from/to JSON.  
    Public Methodstatic (Shared in Visual Basic)setWebRequestHandlerSets the singleton instance of the IWebRequestHandler implementation that will be used to handle web requests. This property provides a centralized way to set the web request handler for the application.  
    Public MethodtoJsonOverloaded. Generates a JSON string from the workbook.  
    Public MethodtoSjsJsonOverloaded. Integrates all JSON files from the SpreadJS .sjs file into a single string, then put the string into the stream.  
    Public MethodunprotectOverloaded. Removes protection from the workbook.  
    Public MethodupdateExcelLinkOverloaded. Updates a excel link.  
    Public MethodupdateExcelLinksUpdates all the excel links.  
    Public MethodwaitForCalculationToFinishWaits 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

    Reference

    Workbook Class
    com.grapecity.documents.excel Package