Class OpenRequest

Specifies a class for file open request.

Inheritance
System.Object
OpenRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.EJ2.Spreadsheet
Assembly: Syncfusion.EJ2.Spreadsheet.dll
Syntax
public class OpenRequest

Constructors

OpenRequest()

Declaration
public OpenRequest()

Properties

AllowExternalWorkbook

Gets or sets information regarding opening a file. If it’s true, then will allow opening an excel file with external workbook links. Otherwise, will request confirmation from the user for opening an excel file.

Declaration
public bool AllowExternalWorkbook { get; set; }
Property Value
Type
System.Boolean

ChunkPayload

Gets or sets the headers for the internal usage from the Spreadsheet client code.

Declaration
public string ChunkPayload { get; set; }
Property Value
Type
System.String

File

Gets or sets the file.

Declaration
public object File { get; set; }
Property Value
Type
System.Object

Guid

Gets or sets the cache unique key. Either file directory information or a worksheet will be saved in the cache and later retrieved using the cache unique key depending on the user's preference.

Declaration
public string Guid { get; set; }
Property Value
Type
System.String

IsManualCalculationEnabled

Gets or sets a value indicating whether manual calculation is enabled in the spreadsheet.

true if manual calculation is enabled; otherwise, false.

Setting this property to true improves performance when loading multiple sheets by deferring calculation until requested. If set to false, calculations occur automatically upon data changes.

Declaration
public bool IsManualCalculationEnabled { get; set; }
Property Value
Type
System.Boolean

ParseOptions

Gets or sets parsing options that control how the Excel file is loaded into the Spreadsheet during open.

Declaration
public WorkbookParseOptions ParseOptions { get; set; }
Property Value
Type
WorkbookParseOptions

Password

Gets or sets the password.

Declaration
public string Password { get; set; }
Property Value
Type
System.String

SheetIndex

Gets or sets the sheet index.

Declaration
public int SheetIndex { get; set; }
Property Value
Type
System.Int32

SheetPassword

Gets or sets the sheet password.

Declaration
public string SheetPassword { get; set; }
Property Value
Type
System.String

ThresholdLimit

Gets or sets information regarding the threshold limit for opening a file. Either the total file size or the maximum amount of data that a workbook can hold is used to determine the limit.

Declaration
public ThresholdLimit ThresholdLimit { get; set; }
Property Value
Type
ThresholdLimit

UsedRangeIncludesValuesOnly

Gets or sets a value that determines how the used range is calculated. If set to true, the used range is based only on cells containing data, ignoring empty rows and columns even if they have other features applied. If set to false (default), the used range includes empty cells that have formatting or other applied features.

Declaration
public bool UsedRangeIncludesValuesOnly { get; set; }
Property Value
Type
System.Boolean