menu

ASP.NET MVC

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class Sheet

    Show / Hide Table of Contents

    Class Sheet

    Inheritance
    System.Object
    EJTagHelper
    Sheet
    Inherited Members
    EJTagHelper.GetControlDetails()
    EJTagHelper.GetControlDetails(String)
    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.Models
    Assembly: Syncfusion.EJ.dll
    Syntax
    public class Sheet : EJTagHelper

    Constructors

    Sheet()

    Declaration
    public Sheet()

    Properties

    ActiveCell

    Gets or sets the activeCell.

    Declaration
    [JsonProperty("_activeCell")]
    public CellIndex ActiveCell { get; set; }
    Property Value
    Type Description
    CellIndex

    The activeCell.

    Border

    Gets or sets the border for cell data binding.

    Declaration
    [JsonProperty("border")]
    public List<CellBorder> Border { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<CellBorder>

    The border value.

    CellAttribute

    Declaration
    [JsonProperty("dataAttribute")]
    [HtmlAttributeName("dataattribute")]
    public List<List<CellAttributes>> CellAttribute { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Collections.Generic.List<CellAttributes>>

    CellType

    Gets or sets the cell type.

    Declaration
    [JsonProperty("cellTypes")]
    public virtual List<CellType> CellType { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<CellType>

    The cell type using CellType object.

    CellTypes

    Gets or sets the cell type.

    Declaration
    public List<CellType> CellTypes { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<CellType>

    The cell type using CellType object.

    CFormatRule

    Gets or sets the cFormatRule for cell data binding.

    Declaration
    [JsonProperty("cFormatRule")]
    public List<ConditionalFormatting> CFormatRule { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<ConditionalFormatting>

    The cFormatRule value.

    Chart

    Declaration
    [JsonProperty("chart")]
    public List<Charts> Chart { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<Charts>

    ColCount

    Gets or sets the column count.

    Declaration
    [JsonProperty("colCount")]
    public int ColCount { get; set; }
    Property Value
    Type Description
    System.Int32

    The column count.

    Columns

    Gets or sets the columns.

    Declaration
    [JsonProperty("columns")]
    public List<SheetColumn> Columns { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<SheetColumn>

    The columns.

    ColumnsWidthCollection

    Gets or sets the column width collection.

    Declaration
    [JsonProperty("columnsWidthCollection")]
    public List<double> ColumnsWidthCollection { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Double>

    The column width collection.

    ColumnWidth

    Gets or sets the column width.

    Declaration
    [JsonProperty("columnWidth")]
    public int ColumnWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    The column width.

    DataManagerID

    Gets or sets the datamanager id.

    Declaration
    [HtmlAttributeName("datasource")]
    [JsonProperty("dataSource")]
    [JsonConverter(typeof(DataManagerConverter), "ID")]
    public string DataManagerID { get; set; }
    Property Value
    Type Description
    System.String

    The datamanager id.

    Datasource

    Gets or sets the datasource.

    Declaration
    [JsonProperty("dataSource")]
    [HtmlAttributeName("datasource")]
    [JsonConverter(typeof(DataManagerConverter))]
    public object Datasource { get; set; }
    Property Value
    Type Description
    System.Object

    The datasource object.

    EndCell

    Gets or sets the end cell.

    Declaration
    [JsonProperty("_endCell")]
    public CellIndex EndCell { get; set; }
    Property Value
    Type Description
    CellIndex

    The end cell.

    FieldAsColumnHeader

    Gets or sets a value indicating whether the datasource field is header or not.

    Declaration
    [JsonProperty("fieldAsColumnHeader")]
    public bool FieldAsColumnHeader { get; set; }
    Property Value
    Type Description
    System.Boolean

    langword_csharp_True if the field as column header is enabled; otherwise, false.

    FilterSettings

    Declaration
    [JsonProperty("filterSettings")]
    public SheetFilterSettings FilterSettings { get; set; }
    Property Value
    Type Description
    SheetFilterSettings

    FormulaRange

    Declaration
    [JsonProperty("formulaRange")]
    public Dictionary<string, object> FormulaRange { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    FrozenColumns

    Gets or sets the frozen columns.

    Declaration
    [JsonProperty("frozenColumns")]
    public int FrozenColumns { get; set; }
    Property Value
    Type Description
    System.Int32

    The frozen columns.

    FrozenRows

    Gets or sets the frozen rows.

    Declaration
    [JsonProperty("frozenRows")]
    public int FrozenRows { get; set; }
    Property Value
    Type Description
    System.Int32

    The frozen rows.

    HeaderStyles

    Gets or sets the header styles.

    Declaration
    [JsonProperty("headerStyles")]
    public SpreadsheetCellStyles HeaderStyles { get; set; }
    Property Value
    Type Description
    SpreadsheetCellStyles

    The header style.

    HideColsCollection

    Declaration
    [JsonProperty("hideColsCollection")]
    public Dictionary<string, object> HideColsCollection { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    HideColumns

    Gets or sets the hideColumn index.

    Declaration
    [JsonProperty("hideColumns")]
    public List<int> HideColumns { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    The hideColumn index.

    HideRows

    Gets or sets the hideRow index.

    Declaration
    [JsonProperty("hideRows")]
    public List<int> HideRows { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    The hideRow index.

    HideRowsCollection

    Declaration
    [JsonProperty("hideRowsCollection")]
    public List<int> HideRowsCollection { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    IsColumnSelected

    Gets or sets a value indicating whether the column is selected or not.

    Declaration
    [JsonProperty("_isColSelected")]
    public bool IsColumnSelected { get; set; }
    Property Value
    Type Description
    System.Boolean

    langword_csharp_True if the column is seleted; otherwise, false.

    IsRowSelected

    Gets or sets a value indicating whether the row is selected or not.

    Declaration
    [JsonProperty("_isRowSelected")]
    public bool IsRowSelected { get; set; }
    Property Value
    Type Description
    System.Boolean

    langword_csharp_True if the row is seleted; otherwise, false.

    IsSheetProtected

    Gets or sets a value indicating whether the sheet is protected or not.

    Declaration
    [JsonProperty("isSheetProtected")]
    public bool IsSheetProtected { get; set; }
    Property Value
    Type Description
    System.Boolean

    langword_csharp_True if the sheet is protected; otherwise, false.

    MergeCells

    Gets or sets the mergeCells.

    Declaration
    [JsonProperty("mergeCells")]
    public List<string> MergeCells { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.String>

    The mergeCells.

    MergedCells

    Declaration
    [JsonProperty("mergedCells")]
    public List<MergeCells> MergedCells { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<MergeCells>

    PaneTopLeftCell

    Gets or sets the Top Left frozen Cell.

    Declaration
    [JsonProperty("paneTopLeftCell")]
    public string PaneTopLeftCell { get; set; }
    Property Value
    Type Description
    System.String

    The Top Left frozen Cell.

    PaperSettings

    Gets or sets the PaperSettings

    Declaration
    [JsonProperty("paperSettings")]
    public PaperSettings PaperSettings { get; set; }
    Property Value
    Type Description
    PaperSettings

    PaperSettings

    PivotMngr

    Declaration
    [JsonProperty("pivotMngr")]
    public PivotMngr PivotMngr { get; set; }
    Property Value
    Type Description
    PivotMngr

    PrimaryKey

    Gets or sets the primary key of datasource.

    Declaration
    [JsonProperty("primaryKey")]
    public string PrimaryKey { get; set; }
    Property Value
    Type Description
    System.String

    The primary key.

    PvtStartCell

    Gets or sets the pivot start cell.

    Declaration
    [JsonProperty("_startCell")]
    public CellIndex PvtStartCell { get; set; }
    Property Value
    Type Description
    CellIndex

    The start cell.

    Query

    Gets or sets the query.

    Declaration
    [JsonConverter(typeof(QueryConverter))]
    [JsonProperty("query")]
    public string Query { get; set; }
    Property Value
    Type Description
    System.String

    The query.

    RangeSetting

    Gets or sets the range settings.

    Declaration
    [JsonProperty("rangeSettings")]
    public virtual List<RangeSetting> RangeSetting { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<RangeSetting>

    The range settings using RangeSettings object.

    RangeSettings

    Gets or sets the range settings.

    Declaration
    public List<RangeSetting> RangeSettings { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<RangeSetting>

    The range settings using RangeSettings object.

    RestrictedHeightRows

    Gets or sets the restricted height rows index.

    Declaration
    [JsonProperty("_restrictedHeightRows")]
    public List<int> RestrictedHeightRows { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    The Restricted height rows index.

    RowCount

    Gets or sets the row count.

    Declaration
    [JsonProperty("rowCount")]
    public int RowCount { get; set; }
    Property Value
    Type Description
    System.Int32

    The row count.

    RowHeight

    Gets or sets the row height.

    Declaration
    [JsonProperty("rowHeight")]
    public int RowHeight { get; set; }
    Property Value
    Type Description
    System.Int32

    The row height.

    Rows

    Gets or sets the rows for cell data binding.

    Declaration
    [JsonProperty("rows")]
    public List<Row> Rows { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<Row>

    The rows.

    RowsHeightCollection

    Gets or sets the row height collection.

    Declaration
    [JsonProperty("rowsHeightCollection")]
    public List<double> RowsHeightCollection { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Double>

    The row height collection.

    ShapeMngr

    Declaration
    [JsonProperty("shapeMngr")]
    public ShapeMngr ShapeMngr { get; set; }
    Property Value
    Type Description
    ShapeMngr

    SheetInfo

    Declaration
    [JsonProperty("sheetInfo")]
    public SheetName SheetInfo { get; set; }
    Property Value
    Type Description
    SheetName

    SheetName

    Gets or sets the sheet name.

    Declaration
    [JsonProperty("sheetName")]
    public string SheetName { get; set; }
    Property Value
    Type Description
    System.String

    The sheet name.

    ShowGridlines

    Gets or sets a value indicating whether the gridlines is visible or not.

    Declaration
    [JsonProperty("showGridlines")]
    public bool ShowGridlines { get; set; }
    Property Value
    Type Description
    System.Boolean

    langword_csharp_True if the gridlines is enabled; otherwise, false.

    ShowHeader

    Gets or sets a value indicating whether the header is enabled for datasource.

    Declaration
    [JsonProperty("showHeader")]
    public bool ShowHeader { get; set; }
    Property Value
    Type Description
    System.Boolean

    langword_csharp_True if the header is enabled; otherwise, false.

    ShowHeadings

    Gets or sets a value indicating whether the headings is visible or not.

    Declaration
    [JsonProperty("showHeadings")]
    public bool ShowHeadings { get; set; }
    Property Value
    Type Description
    System.Boolean

    langword_csharp_True if the headings is enabled; otherwise, false.

    StartCell

    Gets or sets the start cell.

    Declaration
    [JsonProperty("startCell")]
    public string StartCell { get; set; }
    Property Value
    Type Description
    System.String

    The StartCell.

    StyleIndex

    Gets or sets the style index.

    Declaration
    [JsonProperty("styleIndex")]
    public List<int> StyleIndex { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    The style index.

    TableManager

    Declaration
    [JsonProperty("tableManager")]
    public Dictionary<string, object> TableManager { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    TopLeftCell

    Gets or sets the Top Left Cell.

    Declaration
    [JsonProperty("topLeftCell")]
    public string TopLeftCell { get; set; }
    Property Value
    Type Description
    System.String

    The Top Left Cell.

    UsedRange

    Gets or sets the used range.

    Declaration
    [JsonProperty("usedRange")]
    public CellIndex UsedRange { get; set; }
    Property Value
    Type Description
    CellIndex

    The used range using cell index.

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved