Class SpreadsheetRangeSettingsBuilder<T>

Represents the class for range settings which includes query, startcell, primary key, datamanager id, showheader and datasource properties.

Inheritance

System.Object

SpreadsheetRangeSettingsBuilder<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 SpreadsheetRangeSettingsBuilder<T>
    where T : class

Type Parameters

Name	Description
T

Constructors

SpreadsheetRangeSettingsBuilder(Sheet)

Initializes a new instance of the SpreadsheetRangeSettingsBuilder<T> with the specified sheetOptions.

Declaration

public SpreadsheetRangeSettingsBuilder(Sheet sheetOptions)

Parameters

Type	Name	Description
Sheet	sheetOptions	The sheet option using sheet object.

Methods

Add()

Add a rangeOptions in sheet RangeSettings.

Declaration

public void Add()

DataManagerID(String)

Specifies the datamanager id for datasource.

Declaration

public SpreadsheetRangeSettingsBuilder<T> DataManagerID(string id)

Parameters

Type	Name	Description
System.String	id	The identifier of the data manager.

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

Datasource(DataSource)

Specifies the datasource for sheet.

Declaration

public SpreadsheetRangeSettingsBuilder<T> Datasource(DataSource datasource)

Parameters

Type	Name	Description
DataSource	datasource	The datasource object.

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

Datasource(Action<DataSourceBuilder>)

Specifies the datasource for sheet.

Declaration

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

Parameters

Type	Name	Description
System.Action<DataSourceBuilder>	datasource	The datasource in the specified range settings.

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

Datasource(IEnumerable<T>)

Specifies the datasource for sheet.

Declaration

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

Parameters

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

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

Datasource(IEnumerable)

Specifies the datasource for sheet.

Declaration

public SpreadsheetRangeSettingsBuilder<T> Datasource(IEnumerable datasource)

Parameters

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

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

Datasource(String)

Specifies the datasource for sheet.

Declaration

public SpreadsheetRangeSettingsBuilder<T> Datasource(string dataURL)

Parameters

Type	Name	Description
System.String	dataURL

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

HeaderStyles(SpreadsheetCellStyles)

Specifies the styles for datasource field headers.

Declaration

public SpreadsheetRangeSettingsBuilder<T> HeaderStyles(SpreadsheetCellStyles headerStyles)

Parameters

Type	Name	Description
SpreadsheetCellStyles	headerStyles	The Style using Styles object.

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

HeaderStyles(Action<SpreadsheetStyleBuilder<T>>)

Specifies the styles for datasource field headers.

Declaration

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

Parameters

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

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

PrimaryKey(String)

Specifies the primary key for datasource.

Declaration

public SpreadsheetRangeSettingsBuilder<T> PrimaryKey(string primaryKey)

Parameters

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

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

Query(String)

Specifies the Query for datasource.

Declaration

public SpreadsheetRangeSettingsBuilder<T> Query(string query)

Parameters

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

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

ShowHeader()

Specifies to enable the header for datasource.

Declaration

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

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

ShowHeader(Boolean)

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

Declaration

public SpreadsheetRangeSettingsBuilder<T> ShowHeader(bool showHeader)

Parameters

Type	Name	Description
System.Boolean	showHeader	true If the header is visible; otherwise, false.

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>

StartCell(String)

Specifies the start cell to render the datasource.

Declaration

public SpreadsheetRangeSettingsBuilder<T> StartCell(string startCell)

Parameters

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

Returns

Type	Description
SpreadsheetRangeSettingsBuilder<T>