Class SpreadsheetSheetOptionsBuilder<T>

Represent a class for sheet options which includes, row count, col count, range settings, show gridlines, show headings properties.

Inheritance

System.Object

SpreadsheetSheetOptionsBuilder<T>

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: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class SpreadsheetSheetOptionsBuilder<T>
    where T : class

Type Parameters

Name	Description
T

Constructors

SpreadsheetSheetOptionsBuilder(Sheet)

Initializes a new instance of the SpreadsheetSheetOptionsBuilder<T> with the specified sheet.

Declaration

public SpreadsheetSheetOptionsBuilder(Sheet sheet)

Parameters

Type	Name	Description
Sheet	sheet	The Sheet object.

SpreadsheetSheetOptionsBuilder(Spreadsheet<T>)

Initializes a new instance of the SpreadsheetSheetOptionsBuilder<T> with the specified spreadsheet object.

Declaration

public SpreadsheetSheetOptionsBuilder(Spreadsheet<T> spreadsheet)

Parameters

Type	Name	Description
Spreadsheet<T>	spreadsheet	The Spreadsheet object

Methods

Add()

Declaration

public void Add()

Border(Action<SpreadsheetCellBorderBuilder<T>>)

Specifies the border for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Border(Action<SpreadsheetCellBorderBuilder<T>> border)

Parameters

Type	Name	Description
System.Action<SpreadsheetCellBorderBuilder<T>>	border	The border using apply the border in selected cell range.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Border(List<CellBorder>)

Specifies the border for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Border(List<CellBorder> border)

Parameters

Type	Name	Description
System.Collections.Generic.List<CellBorder>	border	The border using apply the border in selected cell range.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

CellTypes(Action<SpreadsheetCellTypeBuilder<T>>)

Specifies the celltype for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> CellTypes(Action<SpreadsheetCellTypeBuilder<T>> cellTypes)

Parameters

Type	Name	Description
System.Action<SpreadsheetCellTypeBuilder<T>>	cellTypes	The celltype settings.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

CellTypes(List<CellType>)

Specifies the cellType for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> CellTypes(List<CellType> cellTypes)

Parameters

Type	Name	Description
System.Collections.Generic.List<CellType>	cellTypes	The celltype settings.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

CFormatRule(Action<SpreadsheetConditionalFormattingBuilder<T>>)

Specifies the cFormatRule for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> CFormatRule(Action<SpreadsheetConditionalFormattingBuilder<T>> cFormatRule)

Parameters

Type	Name	Description
System.Action<SpreadsheetConditionalFormattingBuilder<T>>	cFormatRule	The cFormatRule using ConditionalFormattingBuilder.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

CFormatRule(List<ConditionalFormatting>)

Specifies the CFormatRule for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> CFormatRule(List<ConditionalFormatting> cFormatRule)

Parameters

Type	Name	Description
System.Collections.Generic.List<ConditionalFormatting>	cFormatRule	The CFormatRule added currentsheet.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

ColCount(Int32)

Specifies the column count.

Declaration

public SpreadsheetSheetOptionsBuilder<T> ColCount(int colCount)

Parameters

Type	Name	Description
System.Int32	colCount	The column count.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

DataManagerID(String)

Specifies the datamanager id for datasource.

Declaration

public SpreadsheetSheetOptionsBuilder<T> DataManagerID(string id)

Parameters

Type	Name	Description
System.String	id	The identifier for data manager.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Datasource(DataSource)

Specifies the datasource for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Datasource(DataSource datasource)

Parameters

Type	Name	Description
DataSource	datasource	The datasource in datasource object.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Datasource(Action<DataSourceBuilder>)

Specifies the datasource for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Datasource(Action<DataSourceBuilder> datasource)

Parameters

Type	Name	Description
System.Action<DataSourceBuilder>	datasource	The datasource for spreadsheet.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Datasource(IEnumerable<T>)

Specifies the datasource for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Datasource(IEnumerable<T> datasource)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<T>	datasource	The datasource using IEnumerable.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Datasource(IEnumerable)

Specifies the datasource for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Datasource(IEnumerable datasource)

Parameters

Type	Name	Description
System.Collections.IEnumerable	datasource	The datasource using IEnumerable.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Datasource(String)

Specifies the datasource for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Datasource(string dataURL)

Parameters

Type	Name	Description
System.String	dataURL	The datasource using url.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

FieldAsColumnHeader()

Specifies to set the datasource value as the column header.

Declaration

public SpreadsheetSheetOptionsBuilder<T> FieldAsColumnHeader()

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

FieldAsColumnHeader(Boolean)

Specifies to set the datasource value as column header.

Declaration

public SpreadsheetSheetOptionsBuilder<T> FieldAsColumnHeader(bool fieldAsColumnHeader)

Parameters

Type	Name	Description
System.Boolean	fieldAsColumnHeader	true if the field as column header is enabled; otherwise, false.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

FrozenColumns(Int32)

Specifies the frozen columns.

Declaration

public SpreadsheetSheetOptionsBuilder<T> FrozenColumns(int frozenColumns)

Parameters

Type	Name	Description
System.Int32	frozenColumns	The frozen columns of the sheet.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

FrozenRows(Int32)

Specifies the frozen rows.

Declaration

public SpreadsheetSheetOptionsBuilder<T> FrozenRows(int frozenRows)

Parameters

Type	Name	Description
System.Int32	frozenRows	The frozen rows of the sheet.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

HeaderStyles(SpreadsheetCellStyles)

Specifies the styles for datasource field headers.

Declaration

public SpreadsheetSheetOptionsBuilder<T> HeaderStyles(SpreadsheetCellStyles headerStyles)

Parameters

Type	Name	Description
SpreadsheetCellStyles	headerStyles	The Style using styles object.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

HeaderStyles(Action<SpreadsheetStyleBuilder<T>>)

Specifies the styles for datasource field headers.

Declaration

public SpreadsheetSheetOptionsBuilder<T> HeaderStyles(Action<SpreadsheetStyleBuilder<T>> headerStyles)

Parameters

Type	Name	Description
System.Action<SpreadsheetStyleBuilder<T>>	headerStyles	The Style using style builder.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

HideColumns(List<Int32>)

Specifies the hideColumns for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> HideColumns(List<int> hideColumns)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	hideColumns	The hideColumns index collection.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

HideRows(Action<SpreadsheetHideRowBuilder<T>>)

Specifies the HideRows for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> HideRows(Action<SpreadsheetHideRowBuilder<T>> hideRows)

Parameters

Type	Name	Description
System.Action<SpreadsheetHideRowBuilder<T>>	hideRows	To hide the row .

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

HideRows(List<Int32>)

Specifies the hiderows for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> HideRows(List<int> hideRows)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	hideRows	The hide row index Collection.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

MergeCells(List<String>)

Specifies the MergeCells for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> MergeCells(List<string> mergeCells)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	mergeCells	The mergeCells using to merge the cell.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

PrimaryKey(String)

Specifies the primary key for datasource.

Declaration

public SpreadsheetSheetOptionsBuilder<T> PrimaryKey(string primaryKey)

Parameters

Type	Name	Description
System.String	primaryKey	The primay key value for datasource.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Query(String)

Specifies the query for datasource.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Query(string query)

Parameters

Type	Name	Description
System.String	query	The query string for datasource.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

RangeSettings(Action<SpreadsheetRangeSettingsBuilder<T>>)

Specifies the range settings for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> RangeSettings(Action<SpreadsheetRangeSettingsBuilder<T>> rangeSettings)

Parameters

Type	Name	Description
System.Action<SpreadsheetRangeSettingsBuilder<T>>	rangeSettings	The range settings.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

RangeSettings(List<RangeSetting>)

Specifies the rangeSettings for sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> RangeSettings(List<RangeSetting> rangeSettings)

Parameters

Type	Name	Description
System.Collections.Generic.List<RangeSetting>	rangeSettings	The range settings.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

RowCount(Int32)

Specifies the row count.

Declaration

public SpreadsheetSheetOptionsBuilder<T> RowCount(int rowCount)

Parameters

Type	Name	Description
System.Int32	rowCount	The row count of the sheet.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Rows(Action<SpreadsheetRowBuilder<T>>)

Specifies the rows for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Rows(Action<SpreadsheetRowBuilder<T>> rows)

Parameters

Type	Name	Description
System.Action<SpreadsheetRowBuilder<T>>	rows	The rows using rowBuilder.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

Rows(List<Row>)

Specifies the rows for cell data binding.

Declaration

public SpreadsheetSheetOptionsBuilder<T> Rows(List<Row> rows)

Parameters

Type	Name	Description
System.Collections.Generic.List<Row>	rows	The rows using Row Collection.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

SheetName(String)

Specifies the sheet name for a sheet.

Declaration

public SpreadsheetSheetOptionsBuilder<T> SheetName(string sheetName)

Parameters

Type	Name	Description
System.String	sheetName	The name of the sheet.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

ShowGridlines(Boolean)

Specifies to indicate whether the gridlines is visible or not.

Declaration

public SpreadsheetSheetOptionsBuilder<T> ShowGridlines(bool showGridlines)

Parameters

Type	Name	Description
System.Boolean	showGridlines	true if the gridlines is enabled; otherwise, false.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

ShowHeader()

Specifies to enable the header for datasource.

Declaration

[Obsolete("This property has been deprecated because the default value is true.")]
public SpreadsheetSheetOptionsBuilder<T> ShowHeader()

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

ShowHeader(Boolean)

Specifies to indicate whether the header is visble or not for datasource.

Declaration

public SpreadsheetSheetOptionsBuilder<T> ShowHeader(bool showHeader)

Parameters

Type	Name	Description
System.Boolean	showHeader	true if the header is enabled; otherwise, false.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

ShowHeadings(Boolean)

Specifies to indicate whether the showHeadings is visible or not.

Declaration

public SpreadsheetSheetOptionsBuilder<T> ShowHeadings(bool showHeadings)

Parameters

Type	Name	Description
System.Boolean	showHeadings	true if the headings is enabled; otherwise, false.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>

StartCell(String)

Specifies the start cell to render the datasource.

Declaration

public SpreadsheetSheetOptionsBuilder<T> StartCell(string startCell)

Parameters

Type	Name	Description
System.String	startCell	The start cell for datasource.

Returns

Type	Description
SpreadsheetSheetOptionsBuilder<T>