PDF

Class ExcelOptions

Provides properties to manage Excel document export behaviors.

Inheritance
System.Object
ExcelOptions
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: BoldReports.Writer
Assembly: BoldReports.Web.dll
Syntax
public class ExcelOptions : IReportDispose, IDisposable
Remarks

It contains the ExcelSaveType, LayoutOption, PasswordToOpen, PasswordToModify, ExcelSheetProtection, ReadOnlyRecommended, DisableCellFormat.

Constructors

ExcelOptions()

Declaration
public ExcelOptions()

Properties

DisableCellFormat

Gets or sets the disable cell style in excel sheet.

Declaration
public DisableCellFormat DisableCellFormat { get; set; }
Property Value
Type Description
DisableCellFormat

An enumeration option to disable styles like border, fonts, colors, padding, alignments.

EnableCommentsForExcel

Gets or sets whether to enable comments for an Excel document or not.

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

It set to true if Excel document need to enable comments; otherwise false.

ExcelSaveType

Gets or sets excel version to be export.

Declaration
public ExcelVersion ExcelSaveType { get; set; }
Property Value
Type Description
ExcelVersion

It conatins the excel export format version.

ExcelSheetProtection

Restricts the Excel document from editing.

Declaration
public ExcelSheetProtection ExcelSheetProtection { get; set; }
Property Value
Type Description
Syncfusion.XlsIO.ExcelSheetProtection

Contains the excel sheet protection details.

FitToPagesTall

Gets or sets the height of the pages that the worksheet will be scaled to when it is printed. Applies only to worksheets. Read/write Boolean.

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

An integer value of either 0 or 1.

FitToPagesWide

Gets or sets the width of the pages that the worksheet will be scaled to when it is printed. Applies only to worksheets. Read/write Boolean.

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

An integer value of either 0 or 1.

IncludeRawData

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

IsFitToPage

Indicates whether fit to page mode is selected. This property used to fit the page content before printing.

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

It set to true if the worksheet should fit the page in the print option; otherwise false.

LayoutOption

Gets or sets the rendering type need to be used for exporting reports.

Declaration
public ExcelLayoutOptions LayoutOption { get; set; }
Property Value
Type Description
ExcelLayoutOptions

Contains the layout options Default and IgnoreCellMerge.

PasswordToModify

Gets or Sets the password to modify the excel document.

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

A string containing the modified password.

PasswordToOpen

Gets or sets the password to open the excel document.

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

A string containing the password.

ReadOnlyRecommended

Gets or sets a value indicating whether the Excel document is restricted from editing or not.

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

It set to true if the Excel document is restricted from editing; otherwise false.

Methods

Dispose()

Provides a mechanism for releasing unmanaged resources.

Declaration
public void Dispose()
Remarks

It close or release unmanaged resources such as files, streams, and handles held by an instance of the class that implements this interface.

Implements

System.IDisposable