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

In This Topic
    Workbook Class Members
    In This Topic

    The following tables list the members exposed by Workbook.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public Property Gets the active sheet.  
    Public Property This api is obsolete, please use Formula2 to get or set dynamic array formula.  
    Public Property Gets or sets the author.  
    Public Property Determines whether to parse automatically when setting range value to string value.  
    Public Property Determines whether to round the number to 15 significant figures when getting the value.  
    Public Property Returns an object that represents the view settings of this workbook(read-only).  
    Public Property Gets a collection that represents all the built-in document properties of the workbook.  
    Public Property [Init-only] Gets or sets culture for the workbook. The culture must contain both country/region and language.  
    Public Property Gets a collection that represents all the custom document properties of the workbook.  
    Public Property Gets the custom views of the workbook.  
    Public Property Specifies the table style that is used as the default TableStyle.  
    Public Property Gets or sets whether update the dirty state of the formula cells immediately when changing the value of a cell.  
    Public Property Specifies whether the calculation engine is working.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the location of font files that will be used when exporting pdf.  
    Public Property Returns the name of the workbook, including its path on disk.  
    Public Property Provides graphics information. If this property doesn't have value, the workbook will use built-in graphic information.  
    Public Property Filters data in a workbook based on a cell icon from the IconSets collection. This property is read-only.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the logger factory shared by all workbooks.  
    Public Property Get or set a string value that represents the name of the workbook.  
    Public PropertyReturns the INames collection that represents the workbook-specified names. The Names object is read-only.  
    Public PropertyReturns the IExcelOptions object that represents some settings to control workbook behavior.  
    Public Property Gets or sets a string that represents the path to the workbook file that this workbook object represents.  
    Public Property Gets a PivotCaches collection that represents all the PivotTable caches in the specified workbook.  
    Public Property True if the order of the sheets in the workbook is protected. Read-only Boolean.  
    Public Property True if the windows of the workbook are protected. Read-only Boolean.  
    Public Property Gets or sets the reference style.  
    Public Property Determines whether to reset adjacent range's border when setting border for a range. The default value of this property is true.  
    Public PropertyReturns a IWorksheets collection that represents all the selected sheets in the specified workbook.  
    Public Property Gets a collection of Signature objects that correspond to the digital signature attached to a document.  
    Public PropertyGets the ISlicerCaches object associated with the workbook.  
    Public Property Provides access to the collection of cell styles in the current workbook.  
    Public Property Gets the table styles used in the current workbook.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the json serializer/deserializer for custom type.  
    Public Property Returns an instance of ITheme which provides access to the theme associated with a workbook.  
    Public Propertystatic (Shared in Visual Basic) Gets or sets the json serializer/deserializer for custom cell values  
    Public Propertystatic (Shared in Visual Basic)Gets or sets the singleton instance of the IWebRequestHandler implementation that will be used to handle web requests. This property provides a centralized way to access and set the web request handler for the application.  
    Public Property Gets a collection of worksheets contained in the workbook.  
    Public PropertyReturns a WriteProtection object that provides access to the workbook write protection options.  
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic) Add custom function into the function set.  
    Public Method Add data source for template.  
    Public Method Calculates formulas in the workbook as needed.  
    Public MethodConvert 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.  
    Public Method Designates all the formulas of the workbook to be recalculated when the next calculation occurs.  
    Public MethodOverloaded.  Generates a workbook from a json string.  
    Public MethodOverloaded.  Generates a workbook from a JSON string containing the contents of .sjs file format.  
    Public MethodOverloaded.  Process the template and return the instance of report workbook.  
    Public Method Returns the names of the linked excel documents.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets all sheet names and tables names that will be used as the parameter source of ImportData.
    If the name is a table name, the worksheet name is qualified before the table name, such as "Sheet1!Table1".  
    Public Method Gets all fonts information that are used on workbook.  
    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 specified excel file  
    Public Method Prints the workbook.  
    Public MethodOverloaded.  Start to process the template with global options.  
    Public MethodOverloaded.  Protects a workbook so that it cannot be modified.  
    Public MethodOverloaded.  Saves data to the specified excel file.  
    Public Methodstatic (Shared in Visual Basic) Set the license key of Documents for Excel.  
    Public MethodOverloaded.  Generates a json string from a workbook.  
    Public MethodOverloaded.  Integrates all JSON files from the SpreadJS .sjs file into a single string, then put the string into the stream.  
    Public Method Removes protection from the workbook.  
    Public MethodOverloaded.  Updates a excel link.  
    Public Method Updates all the excel links.  
    Public Method Waits for all calculation to complete, includes 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
    Public Event Occurs after the workbook is saved.  
    Public Event Occurs before the workbook is saved.  
    Public Event Occurs when a new sheet is created in the workbook.  
    Public Event Occurs when the workbook is opened.  
    Public Event Occurs when a sheet is active.  
    Public Event Occurs before a sheet is deleted.  
    Public Event Occurs when something changes in the cells of a sheet.  
    Public Event Occurs when a sheet is deactivated.  
    Public Event Occurs when the selection changes on a sheet.  
    Top
    See Also