BeforeSaveEventArgs

23 Sep 20251 minute to read

Represents the event arguments triggered before the save action is performed.

Properties

autoDetectFormat boolean

Automatically detects the number format for cells, if enabled.

cancel boolean

Specifies whether the save action should be canceled.

• true: Cancels the save action and stops further execution.
• false: Proceeds with the save action as normal.

customParams Object

Specifies custom parameters that need to be included in the save request.
These parameters will be sent along with the save action request to the server.

fileName string

The name of the file to be saved. This name will be used as the default file name
when the document is downloaded.

isFullPost boolean

Determines whether a full post-back is required for the save action.

jsonConfig SerializationOptions

Defines the serialization options applied when the Spreadsheet is saved as an Excel file.

needBlobData boolean

Specifies whether the spreadsheet should be generated as blobData or not.

• true: Generates the spreadsheet data as a Blob object, which can be used for custom handling
  (e.g., downloading, uploading to a server, or storing in memory).
• false: The spreadsheet will not be generated as blobData.

pdfLayoutSettings pdfLayoutSettings

The layout settings to use when saving a document as a PDF.
These settings can control aspects like page orientation (portrait or landscape)
or fit-to-one-page functionality.

saveType SaveType

The type of the file to be saved. By default, the file will be saved in Excel format.
Supported file types might include formats such as Excel, CSV, or PDF.

url string

Specify the URL where the document will be sent for saving.