Documents for Excel, Java Edition Documentation
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)AddCustomFunctionOverloaded. Add custom function into the function set.  
    Public MethodaddDataSourceAdd data source for template  
    Public MethodcalculateCalculates formulas in the workbook as needed.  
    Public MethoddirtyDesignates all the formulas of the workbook to be recalculated when the next calculation occurs.  
    Public MethodgenerateReportOverloaded. Process the template and return the instance of report workbook.  
    Public MethodgetActiveSheetGets the active sheet.  
    Public MethodgetAllowDynamicArrayGets whether allow dynamic array formula. This method is obsoleted, please use getFormula2() to get 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 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 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 all the names in thespecified workbook (including all worksheet-specific names).  
    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 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 Methodstatic (Shared in Visual Basic)getValueJsonSerializerGets json serializer for custom type  
    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 specified excel file  
    Public MethodprocessTemplateStart 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.This method is obsoleted, please use setFormula2() to set 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.  
    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)SetLicenseKeySets license for all workbook instances.

    Important: For licenses of the Chinese market, use @code:SetLicenseFile or set license in the @code:GCEXCEL_JAVA_DEPLOY_LICENSE_V5 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 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 MethodtoJsonOverloaded. Generates a json string from the workbook.  
    Public MethodunprotectOverloaded. Removes protection from the workbook.  
    Public MethodupdateExcelLinkOverloaded. Updates a excel link.  
    Public MethodupdateExcelLinksUpdates all the excel links.  
    Top
    See Also

    Reference

    Workbook Class
    com.grapecity.documents.excel Package

     

     

    Copyright ? 2022 GrapeCity, Inc. All rights reserved.

    Product Support Forum | Print this page