menu

ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SheetBuilder - ASP.NETMVC-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SheetBuilder

    Inheritance
    System.Object
    Syncfusion.EJ2.ControlBuilder
    SheetBuilder
    Namespace: Syncfusion.EJ2.Spreadsheet
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class SheetBuilder : ControlBuilder

    Constructors

    SheetBuilder()

    Declaration
    public SheetBuilder()

    SheetBuilder(List<Sheet>)

    Declaration
    public SheetBuilder(List<Sheet> collection)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Sheet> collection

    Methods

    ActiveCell(String)

    Specifies active cell within selectedRange in the sheet.

    Declaration
    public SheetBuilder ActiveCell(string activeCell)
    Parameters
    Type Name Description
    System.String activeCell
    Returns
    Type
    SheetBuilder

    Add()

    Declaration
    public void Add()

    ColCount(Int32)

    Defines the number of columns to be rendered in the sheet.

    Declaration
    public SheetBuilder ColCount(int colCount)
    Parameters
    Type Name Description
    System.Int32 colCount
    Returns
    Type
    SheetBuilder

    Columns(Action<ColumnBuilder>)

    Declaration
    public SheetBuilder Columns(Action<ColumnBuilder> columns)
    Parameters
    Type Name Description
    System.Action<ColumnBuilder> columns
    Returns
    Type
    SheetBuilder

    Columns(List<Column>)

    Configures column and its properties for the sheet.

    Declaration
    public SheetBuilder Columns(List<Column> columns)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Column> columns
    Returns
    Type
    SheetBuilder

    ConditionalFormats(Action<ConditionalFormatBuilder>)

    Declaration
    public SheetBuilder ConditionalFormats(Action<ConditionalFormatBuilder> conditionalFormats)
    Parameters
    Type Name Description
    System.Action<ConditionalFormatBuilder> conditionalFormats
    Returns
    Type
    SheetBuilder

    ConditionalFormats(List<ConditionalFormat>)

    Specifies the conditional formatting for the sheet.

    Declaration
    public SheetBuilder ConditionalFormats(List<ConditionalFormat> conditionalFormats)
    Parameters
    Type Name Description
    System.Collections.Generic.List<ConditionalFormat> conditionalFormats
    Returns
    Type
    SheetBuilder

    FrozenColumns(Int32)

    Gets or sets the number of frozen columns.

    Declaration
    public SheetBuilder FrozenColumns(int frozenColumns)
    Parameters
    Type Name Description
    System.Int32 frozenColumns
    Returns
    Type
    SheetBuilder

    FrozenRows(Int32)

    Gets or sets the number of frozen rows.

    Declaration
    public SheetBuilder FrozenRows(int frozenRows)
    Parameters
    Type Name Description
    System.Int32 frozenRows
    Returns
    Type
    SheetBuilder

    Index(Int32)

    Specifies index of the sheet. Based on the index, sheet properties are applied.

    Declaration
    public SheetBuilder Index(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type
    SheetBuilder

    IsProtected(Boolean)

    Specifies to protect the cells in the sheet.

    Declaration
    public SheetBuilder IsProtected(bool isProtected)
    Parameters
    Type Name Description
    System.Boolean isProtected
    Returns
    Type
    SheetBuilder

    Name(String)

    Specifies the name of the sheet, the name will show in the sheet tabs.

    Declaration
    public SheetBuilder Name(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type
    SheetBuilder

    PaneTopLeftCell(String)

    Represents the freeze pane top left cell. Its default value would be based on the number of freeze rows and columns.

    Declaration
    public SheetBuilder PaneTopLeftCell(string paneTopLeftCell)
    Parameters
    Type Name Description
    System.String paneTopLeftCell
    Returns
    Type
    SheetBuilder

    Password(String)

    Specifies the password.

    Declaration
    public SheetBuilder Password(string password)
    Parameters
    Type Name Description
    System.String password
    Returns
    Type
    SheetBuilder

    ProtectSettings(SpreadsheetProtectSettings)

    Configures protect and its options.

    Declaration
    public SheetBuilder ProtectSettings(SpreadsheetProtectSettings protectSettings)
    Parameters
    Type Name Description
    SpreadsheetProtectSettings protectSettings
    Returns
    Type
    SheetBuilder

    ProtectSettings(Action<SpreadsheetProtectSettingsBuilder>)

    Declaration
    public SheetBuilder ProtectSettings(Action<SpreadsheetProtectSettingsBuilder> protectSettings)
    Parameters
    Type Name Description
    System.Action<SpreadsheetProtectSettingsBuilder> protectSettings
    Returns
    Type
    SheetBuilder

    Ranges(Action<RangeBuilder>)

    Declaration
    public SheetBuilder Ranges(Action<RangeBuilder> ranges)
    Parameters
    Type Name Description
    System.Action<RangeBuilder> ranges
    Returns
    Type
    SheetBuilder

    Ranges(List<Range>)

    Specifies the collection of range for the sheet.

    Declaration
    public SheetBuilder Ranges(List<Range> ranges)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Range> ranges
    Returns
    Type
    SheetBuilder

    RowCount(Int32)

    Defines the number of rows to be rendered in the sheet.

    Declaration
    public SheetBuilder RowCount(int rowCount)
    Parameters
    Type Name Description
    System.Int32 rowCount
    Returns
    Type
    SheetBuilder

    Rows(Action<RowBuilder>)

    Declaration
    public SheetBuilder Rows(Action<RowBuilder> rows)
    Parameters
    Type Name Description
    System.Action<RowBuilder> rows
    Returns
    Type
    SheetBuilder

    Rows(List<Row>)

    Configures row and its properties for the sheet.

    Declaration
    public SheetBuilder Rows(List<Row> rows)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Row> rows
    Returns
    Type
    SheetBuilder

    SelectedRange(String)

    Specifies selected range in the sheet.

    Declaration
    public SheetBuilder SelectedRange(string selectedRange)
    Parameters
    Type Name Description
    System.String selectedRange
    Returns
    Type
    SheetBuilder

    ShowGridLines(Boolean)

    Specifies to show / hide grid lines in the sheet.

    Declaration
    public SheetBuilder ShowGridLines(bool showGridLines)
    Parameters
    Type Name Description
    System.Boolean showGridLines
    Returns
    Type
    SheetBuilder

    ShowHeaders(Boolean)

    Specifies to show / hide column and row headers in the sheet.

    Declaration
    public SheetBuilder ShowHeaders(bool showHeaders)
    Parameters
    Type Name Description
    System.Boolean showHeaders
    Returns
    Type
    SheetBuilder

    StandardHeight(Double)

    Represents the standard height of the sheet.

    Declaration
    public SheetBuilder StandardHeight(double standardHeight)
    Parameters
    Type Name Description
    System.Double standardHeight
    Returns
    Type
    SheetBuilder

    State(SheetState)

    Specifies the sheet visibility state. There must be at least one visible sheet in Spreadsheet.

    Declaration
    public SheetBuilder State(SheetState state)
    Parameters
    Type Name Description
    SheetState state
    Returns
    Type
    SheetBuilder

    TopLeftCell(String)

    Specified cell will be positioned at the upper-left corner of the sheet.

    Declaration
    public SheetBuilder TopLeftCell(string topLeftCell)
    Parameters
    Type Name Description
    System.String topLeftCell
    Returns
    Type
    SheetBuilder

    UsedRange(SpreadsheetUsedRange)

    Defines the used range of the sheet.

    Declaration
    public SheetBuilder UsedRange(SpreadsheetUsedRange usedRange)
    Parameters
    Type Name Description
    SpreadsheetUsedRange usedRange
    Returns
    Type
    SheetBuilder

    UsedRange(Action<SpreadsheetUsedRangeBuilder>)

    Declaration
    public SheetBuilder UsedRange(Action<SpreadsheetUsedRangeBuilder> usedRange)
    Parameters
    Type Name Description
    System.Action<SpreadsheetUsedRangeBuilder> usedRange
    Returns
    Type
    SheetBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved