menu

ASP.NET Web Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WorkbookPropertiesBuilder<T>

    Show / Hide Table of Contents

    Class WorkbookPropertiesBuilder<T>

    Represents the class for properties.

    Inheritance
    System.Object
    WorkbookPropertiesBuilder<T>
    Implements
    IPropertiesBuilder
    System.Web.IHtmlString
    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 WorkbookPropertiesBuilder<T> : IPropertiesBuilder, IHtmlString where T : class
    Type Parameters
    Name Description
    T

    Constructors

    WorkbookPropertiesBuilder()

    Declaration
    public WorkbookPropertiesBuilder()

    WorkbookPropertiesBuilder(Spreadsheet<T>)

    Initializes a new instance of the WorkbookPropertiesBuilder<T> with the specified spreadsheet model.

    Declaration
    public WorkbookPropertiesBuilder(Spreadsheet<T> spreadsheet)
    Parameters
    Type Name Description
    Spreadsheet<T> spreadsheet

    The Spreadsheet model.

    Fields

    spreadsheet

    Declaration
    public Spreadsheet<T> spreadsheet
    Field Value
    Type Description
    Spreadsheet<T>

    Methods

    ActivationPanelWidth(Int32)

    Specifies the width for activation panel.

    Declaration
    public WorkbookPropertiesBuilder<T> ActivationPanelWidth(int activationPanelWidth)
    Parameters
    Type Name Description
    System.Int32 activationPanelWidth

    The activation panel width.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ActiveSheetIndex(Int32)

    Specifies the active sheet index.

    Declaration
    public WorkbookPropertiesBuilder<T> ActiveSheetIndex(int activeSheetIndex)
    Parameters
    Type Name Description
    System.Int32 activeSheetIndex

    The active sheet index.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowAutoCellType()

    Specifies to enable auto cell type.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowAutoCellType()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowAutoCellType(Boolean)

    Specifies to indicate whether allowAutoCellType is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowAutoCellType(bool allowAutoCellType)
    Parameters
    Type Name Description
    System.Boolean allowAutoCellType

    true if the cell type is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowAutoFill()

    Specifies to enable autofill.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowAutoFill()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowAutoFill(Boolean)

    Specifies to indicate whether autofill is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowAutoFill(bool allowAutoFill)
    Parameters
    Type Name Description
    System.Boolean allowAutoFill

    true if the auto fill is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowAutoSum()

    Specifies to enable autosum.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowAutoSum()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowAutoSum(Boolean)

    Specifies to indicate whether autosum is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowAutoSum(bool allowAutoSum)
    Parameters
    Type Name Description
    System.Boolean allowAutoSum

    true if the auto sum option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowCellFormatting()

    Specifies to enable cell formatting.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowCellFormatting()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowCellFormatting(Boolean)

    Specifies to indicate whether cell formatting is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowCellFormatting(bool allowCellFormatting)
    Parameters
    Type Name Description
    System.Boolean allowCellFormatting

    true if the cell formatting is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowCellType()

    Specifies to enable cell type.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowCellType()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowCellType(Boolean)

    Specifies to indicate whether allowCellType is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowCellType(bool allowCellType)
    Parameters
    Type Name Description
    System.Boolean allowCellType

    true if the cell type is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowCharts()

    Specifies to enable charts.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowCharts()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowCharts(Boolean)

    Specifies to indicate whether charts is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowCharts(bool allowCharts)
    Parameters
    Type Name Description
    System.Boolean allowCharts

    true if the chart option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowClear(Boolean)

    Specifies to indicate whether allowClear is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowClear(bool allowClear)
    Parameters
    Type Name Description
    System.Boolean allowClear

    true if the document content is clear ; otherwise not clear, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowClipboard()

    Specifies to enable clipboard.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowClipboard()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowClipboard(Boolean)

    Specifies to indicate whether clipboard functionalities are enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowClipboard(bool allowClipboard)
    Parameters
    Type Name Description
    System.Boolean allowClipboard

    true if the clipboard operations are enbled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowComments()

    Specifies to enable comments.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowComments()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowComments(Boolean)

    Specifies to indicate whether comments is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowComments(bool allowComments)
    Parameters
    Type Name Description
    System.Boolean allowComments

    true if the comment is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowConditionalFormats()

    Specifies to enable conditional formats.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowConditionalFormats()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowConditionalFormats(Boolean)

    Specifies to indicate whether conditional formats is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowConditionalFormats(bool allowConditionalFormats)
    Parameters
    Type Name Description
    System.Boolean allowConditionalFormats

    true if the conditional formatting is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowDataValidation()

    Specifies to enable datavalidation as true.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowDataValidation()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowDataValidation(Boolean)

    Specifies to indicate whether datavalidation is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowDataValidation(bool allowDataValidation)
    Parameters
    Type Name Description
    System.Boolean allowDataValidation

    true if the data validation is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowDelete()

    Specifies to enable delete.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowDelete()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowDelete(Boolean)

    Specifies to indicate whether delete option is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowDelete(bool allowDelete)
    Parameters
    Type Name Description
    System.Boolean allowDelete

    true if the delete option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowDragAndDrop()

    Specifies to enable DragAndDrop.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowDragAndDrop()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowDragAndDrop(Boolean)

    Specifies to indicate whether drag and drop is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowDragAndDrop(bool allowDragAndDrop)
    Parameters
    Type Name Description
    System.Boolean allowDragAndDrop

    true if the drag and drop is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowEditing()

    Specifies to enable editing.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowEditing()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowEditing(Boolean)

    Specifies to indicate whether editing is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowEditing(bool allowEditing)
    Parameters
    Type Name Description
    System.Boolean allowEditing

    true if the editing is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFiltering()

    Specifies to enable filtering.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFiltering()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFiltering(Boolean)

    Specifies to indicate whether filtering is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFiltering(bool allowFiltering)
    Parameters
    Type Name Description
    System.Boolean allowFiltering

    true if the filtering is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFormatAsTable()

    Specifies to enable format table as true.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFormatAsTable()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFormatAsTable(Boolean)

    Specifies to indicate whether format table is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFormatAsTable(bool allowFormatAsTable)
    Parameters
    Type Name Description
    System.Boolean allowFormatAsTable

    true if the format table is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFormatPainter()

    Specifies to enable format painter.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFormatPainter()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFormatPainter(Boolean)

    Specifies to indicate whether format painter is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFormatPainter(bool allowFormatPainter)
    Parameters
    Type Name Description
    System.Boolean allowFormatPainter

    true if the format painter is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFormulaBar()

    Specifies to enable formula bar.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFormulaBar()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFormulaBar(Boolean)

    Specifies to indicate whether formulaBar is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFormulaBar(bool allowFormulaBar)
    Parameters
    Type Name Description
    System.Boolean allowFormulaBar

    true if the formula bar is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFreezing()

    Specifies to enable freezing.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFreezing()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowFreezing(Boolean)

    Specifies to indicate whether freezing is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowFreezing(bool allowFreezing)
    Parameters
    Type Name Description
    System.Boolean allowFreezing

    true if the freezing is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowHyperlink()

    Specifies to enable hyperlink.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowHyperlink()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowHyperlink(Boolean)

    Specifies to indicate whether hyperlink is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowHyperlink(bool allowHyperlink)
    Parameters
    Type Name Description
    System.Boolean allowHyperlink

    true if the hyperlink is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowImport()

    Specifies to enable import.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowImport()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowImport(Boolean)

    Specifies to indicate whether import is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowImport(bool allowImport)
    Parameters
    Type Name Description
    System.Boolean allowImport

    true if the import option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowInsert()

    Specifies to enable insert.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowInsert()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowInsert(Boolean)

    Specifies to indicate whether insert option is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowInsert(bool allowInsert)
    Parameters
    Type Name Description
    System.Boolean allowInsert

    true if the insert option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowKeyboardNavigation()

    Specifies to enable keyboard navigation.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowKeyboardNavigation()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowKeyboardNavigation(Boolean)

    Specifies to indicate whether keyboard navigation is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowKeyboardNavigation(bool allowKeyboardNavigation)
    Parameters
    Type Name Description
    System.Boolean allowKeyboardNavigation

    true if the keyboard navigation is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowLockCell()

    Specifies to enable lockcell.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowLockCell()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowLockCell(Boolean)

    Specifies to indicate whether lockcell is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowLockCell(bool allowLockCell)
    Parameters
    Type Name Description
    System.Boolean allowLockCell

    true if the lock cell is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowMerging()

    Specifies to enable merging.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowMerging()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowMerging(Boolean)

    Specifies to indicate whether merging is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowMerging(bool allowMerging)
    Parameters
    Type Name Description
    System.Boolean allowMerging

    true if the merging option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowOverflow()

    Specifies to enable allowOverflow.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowOverflow()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowOverflow(Boolean)

    Specifies to indicate whether allowOverflow is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowOverflow(bool allowOverflow)
    Parameters
    Type Name Description
    System.Boolean allowOverflow

    true if the document text overflow ; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowResizing()

    Specifies to enable resizing.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowResizing()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowResizing(Boolean)

    Specifies to indicate whether resizing is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowResizing(bool allowResizing)
    Parameters
    Type Name Description
    System.Boolean allowResizing

    true if the resizing is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSearching()

    Specifies to enable searching.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSearching()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSearching(Boolean)

    Specifies to indicate whether searching is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSearching(bool allowSearching)
    Parameters
    Type Name Description
    System.Boolean allowSearching

    true if the searching is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSelection()

    Specifies to enable selection.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSelection()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSelection(Boolean)

    Specifies to indicate whether selection is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSelection(bool allowSelection)
    Parameters
    Type Name Description
    System.Boolean allowSelection

    true if the cell selection is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSorting()

    Specifies to enable sorting.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSorting()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSorting(Boolean)

    Specifies to indicate whether sorting is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSorting(bool allowSorting)
    Parameters
    Type Name Description
    System.Boolean allowSorting

    true if the sorting option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSparkline()

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSparkline()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowSparkline(Boolean)

    Specifies to indicate whether sparkline is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowSparkline(bool allowSparkline)
    Parameters
    Type Name Description
    System.Boolean allowSparkline

    true if the undo and redo option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowUndoRedo()

    Specifies to enable undo redo.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowUndoRedo()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowUndoRedo(Boolean)

    Specifies to indicate whether undo redo is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowUndoRedo(bool allowUndoRedo)
    Parameters
    Type Name Description
    System.Boolean allowUndoRedo

    true if the undo and redo option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowWrap()

    Specifies to enable wraptext.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowWrap()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AllowWrap(Boolean)

    Specifies to indicate whether wraptext is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> AllowWrap(bool allowWrap)
    Parameters
    Type Name Description
    System.Boolean allowWrap

    true if the wraptext option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ApWidth(Int32)

    Specifies the width for activation panel.

    Declaration
    [Obsolete("This property has been deprecated because the another name of API ActivationPanelWidth.")]
    public WorkbookPropertiesBuilder<T> ApWidth(int apWidth)
    Parameters
    Type Name Description
    System.Int32 apWidth
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AutoFillSettings(SpreadsheetAutoFillSettings)

    Specifies the autoFillSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> AutoFillSettings(SpreadsheetAutoFillSettings autoFillOption)
    Parameters
    Type Name Description
    SpreadsheetAutoFillSettings autoFillOption

    The autoFillSettings using AutoFillSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    AutoFillSettings(Action<SpreadsheetAutoFillOptionsBuilder<T>>)

    Specifies the autoFillSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> AutoFillSettings(Action<SpreadsheetAutoFillOptionsBuilder<T>> autoFillOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetAutoFillOptionsBuilder<T>> autoFillOption

    The autoFillSettings using AutoFillOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ChartSettings(SpreadsheetChartSettings)

    Specifies the chartSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ChartSettings(SpreadsheetChartSettings chartOption)
    Parameters
    Type Name Description
    SpreadsheetChartSettings chartOption

    The ChartSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ChartSettings(Action<SpreadsheetChartOptionsBuilder<T>>)

    Specifies the chartSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ChartSettings(Action<SpreadsheetChartOptionsBuilder<T>> chartOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetChartOptionsBuilder<T>> chartOption

    The chartSettings using ChartOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ClientSideEvents(Action<SpreadsheetClientSideEventsBuilder<T>>)

    Specifies the clientside events for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ClientSideEvents(Action<SpreadsheetClientSideEventsBuilder<T>> clientSideEvents)
    Parameters
    Type Name Description
    System.Action<SpreadsheetClientSideEventsBuilder<T>> clientSideEvents

    The clientside events.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ColumnCount(Int32)

    Specifies the column count for sheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ColumnCount(int columnCount)
    Parameters
    Type Name Description
    System.Int32 columnCount

    The column count.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ColumnWidth(Int32)

    Specifies the column width for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ColumnWidth(int columnWidth)
    Parameters
    Type Name Description
    System.Int32 columnWidth

    The column width.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    CssClass(String)

    Specifies the cssClass for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> CssClass(string cssClass)
    Parameters
    Type Name Description
    System.String cssClass

    The cssClass string.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    CustomFormulas(Action<SpreadsheetCustomFormulaBuilder<T>>)

    Specifies the CustomFormulas for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> CustomFormulas(Action<SpreadsheetCustomFormulaBuilder<T>> customFormula)
    Parameters
    Type Name Description
    System.Action<SpreadsheetCustomFormulaBuilder<T>> customFormula
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    CustomFormulas(List<CustomFormula>)

    Specifies the CustomFormulas for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> CustomFormulas(List<CustomFormula> customOptions)
    Parameters
    Type Name Description
    System.Collections.Generic.List<CustomFormula> customOptions
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnableContextMenu()

    Specifies to enable context menu.

    Declaration
    public WorkbookPropertiesBuilder<T> EnableContextMenu()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnableContextMenu(Boolean)

    Specifies to indicate whether context menu is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> EnableContextMenu(bool enableContextMenu)
    Parameters
    Type Name Description
    System.Boolean enableContextMenu

    true if the context menu option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnablePersistence()

    Specifies to enable persistence.

    Declaration
    public WorkbookPropertiesBuilder<T> EnablePersistence()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnablePersistence(Boolean)

    Specifies to indicate whether persistence is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> EnablePersistence(bool enablePersistence)
    Parameters
    Type Name Description
    System.Boolean enablePersistence

    true if the presistence is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnablePivotTable()

    Specifies to enable pivottable.

    Declaration
    public WorkbookPropertiesBuilder<T> EnablePivotTable()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnablePivotTable(Boolean)

    Specifies to indicate whether pivottable is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> EnablePivotTable(bool enablePivotTable)
    Parameters
    Type Name Description
    System.Boolean enablePivotTable

    true if the pivot table is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnableTouch()

    Specifies to enable touch.

    Declaration
    public WorkbookPropertiesBuilder<T> EnableTouch()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    EnableTouch(Boolean)

    Specifies to indicate whether touch is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> EnableTouch(bool enableTouch)
    Parameters
    Type Name Description
    System.Boolean enableTouch

    true if the touch option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ExportSettings(SpreadsheetExportSettings)

    Specifies the export settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ExportSettings(SpreadsheetExportSettings exportOption)
    Parameters
    Type Name Description
    SpreadsheetExportSettings exportOption

    The exportSettings using ExportSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ExportSettings(Action<SpreadsheetExportOptionsBuilder<T>>)

    Specifies the export settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ExportSettings(Action<SpreadsheetExportOptionsBuilder<T>> exportOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetExportOptionsBuilder<T>> exportOption

    The exportSettings using ExportOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    FormatSettings(SpreadsheetFormatSettings)

    Specifies the formatSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> FormatSettings(SpreadsheetFormatSettings formatOption)
    Parameters
    Type Name Description
    SpreadsheetFormatSettings formatOption

    The formatSettings using FormatSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    FormatSettings(Action<SpreadsheetFormatOptionsBuilder<T>>)

    Specifies the formatSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> FormatSettings(Action<SpreadsheetFormatOptionsBuilder<T>> formatOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetFormatOptionsBuilder<T>> formatOption

    The formatSettings using FormatOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    HtmlAttributes(Object)

    Specifies the HtmlAttributes for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> HtmlAttributes(object Attributes)
    Parameters
    Type Name Description
    System.Object Attributes

    The HtmlAttributes.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ImportSettings(SpreadsheetImportSettings)

    Specifies the import settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ImportSettings(SpreadsheetImportSettings importOption)
    Parameters
    Type Name Description
    SpreadsheetImportSettings importOption

    The importSettings using ImportSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ImportSettings(Action<SpreadsheetImportOptionsBuilder<T>>)

    Specifies the import settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ImportSettings(Action<SpreadsheetImportOptionsBuilder<T>> importOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetImportOptionsBuilder<T>> importOption

    The importSettings using ImportOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    IsGridMode()

    Declaration
    public WorkbookPropertiesBuilder<T> IsGridMode()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    IsGridMode(Boolean)

    Specifies to indicate whether grid mode is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> IsGridMode(bool isGridMode)
    Parameters
    Type Name Description
    System.Boolean isGridMode

    true if the undo and redo option is enabled; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    IsReadOnly()

    Specifies to enable isReadOnly.

    Declaration
    public WorkbookPropertiesBuilder<T> IsReadOnly()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    IsReadOnly(Boolean)

    Specifies to indicate whether isReadOnly is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> IsReadOnly(bool isReadOnly)
    Parameters
    Type Name Description
    System.Boolean isReadOnly

    true if the document is readOnly mode; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    Locale(String)

    Specifies the locale for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> Locale(string locale)
    Parameters
    Type Name Description
    System.String locale

    The locale value.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    NameManager(Action<SpreadsheetNameManagerBuilder<T>>)

    Declaration
    public WorkbookPropertiesBuilder<T> NameManager(Action<SpreadsheetNameManagerBuilder<T>> nameManager)
    Parameters
    Type Name Description
    System.Action<SpreadsheetNameManagerBuilder<T>> nameManager
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    NameManager(List<NameManager>)

    Specifies the nameManager for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> NameManager(List<NameManager> nameManager)
    Parameters
    Type Name Description
    System.Collections.Generic.List<NameManager> nameManager

    The nameManager using NameManager object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    PageSettings(SpreadsheetPageSettings)

    Specifies the pageSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> PageSettings(SpreadsheetPageSettings pageOption)
    Parameters
    Type Name Description
    SpreadsheetPageSettings pageOption

    The PageSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    PageSettings(Action<SpreadsheetPageOptionsBuilder<T>>)

    Specifies the pageSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> PageSettings(Action<SpreadsheetPageOptionsBuilder<T>> pageOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetPageOptionsBuilder<T>> pageOption

    The pageSettings using PageOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    PageSize(SpreadsheetPageSize)

    Specifies the pageSize for print.

    Declaration
    public WorkbookPropertiesBuilder<T> PageSize(SpreadsheetPageSize pageSize)
    Parameters
    Type Name Description
    SpreadsheetPageSize pageSize

    The pageSize Enum.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    PictureSettings(SpreadsheetPictureSettings)

    Specifies the picture settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> PictureSettings(SpreadsheetPictureSettings pictureOption)
    Parameters
    Type Name Description
    SpreadsheetPictureSettings pictureOption

    The pictureOption using PictureSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    PictureSettings(Action<SpreadsheetPictureOptionsBuilder<T>>)

    Specifies the picture settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> PictureSettings(Action<SpreadsheetPictureOptionsBuilder<T>> pictureOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetPictureOptionsBuilder<T>> pictureOption

    The pictureSettings using PictureOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    PrintSettings(SpreadsheetPrintSettings)

    Specifies the printSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> PrintSettings(SpreadsheetPrintSettings printOption)
    Parameters
    Type Name Description
    SpreadsheetPrintSettings printOption

    The pageSettings using PrintSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    PrintSettings(Action<SpreadsheetPrintOptionsBuilder<T>>)

    Specifies the print settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> PrintSettings(Action<SpreadsheetPrintOptionsBuilder<T>> printOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetPrintOptionsBuilder<T>> printOption

    The pageSettings using PrintOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    Render()

    Declaration
    public void Render()

    RibbonSettings(SpreadsheetRibbonSettings)

    Specifies the RibbonSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> RibbonSettings(SpreadsheetRibbonSettings ribbonOption)
    Parameters
    Type Name Description
    SpreadsheetRibbonSettings ribbonOption

    The ribbonOption using RibbonSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    RibbonSettings(Action<SpreadsheetRibbonOptionsBuilder<T>>)

    Specifies the RibbonSettings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> RibbonSettings(Action<SpreadsheetRibbonOptionsBuilder<T>> ribbonOptions)
    Parameters
    Type Name Description
    System.Action<SpreadsheetRibbonOptionsBuilder<T>> ribbonOptions

    The ribbonOptions using SpreadsheetRibbonOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    RowCount(Int32)

    Specifies the row count for sheets.

    Declaration
    public WorkbookPropertiesBuilder<T> RowCount(int rowCount)
    Parameters
    Type Name Description
    System.Int32 rowCount

    The row count.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    RowHeight(Int32)

    Specifies the row height for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> RowHeight(int rowHeight)
    Parameters
    Type Name Description
    System.Int32 rowHeight

    The row height.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ScrollSettings(SpreadsheetScrollSettings)

    Specifies the scroll settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ScrollSettings(SpreadsheetScrollSettings scrollOption)
    Parameters
    Type Name Description
    SpreadsheetScrollSettings scrollOption

    The scrollSettings using ScrollSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ScrollSettings(Action<SpreadsheetScrollOptionsBuilder<T>>)

    Specifies the scroll settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> ScrollSettings(Action<SpreadsheetScrollOptionsBuilder<T>> scrollOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetScrollOptionsBuilder<T>> scrollOption

    The scrollSettings using ScrollOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    SelectionSettings(SpreadsheetSelectionSettings)

    Specifies the selection settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> SelectionSettings(SpreadsheetSelectionSettings selectionOption)
    Parameters
    Type Name Description
    SpreadsheetSelectionSettings selectionOption

    The selectionSettings using SelectionSettings object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    SelectionSettings(Action<SpreadsheetSelectionOptionsBuilder<T>>)

    Specifies the selection settings for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> SelectionSettings(Action<SpreadsheetSelectionOptionsBuilder<T>> selectionOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetSelectionOptionsBuilder<T>> selectionOption

    The selectionSettings using SelectionOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    SheetCount(Int32)

    Specifies the sheet count.

    Declaration
    public WorkbookPropertiesBuilder<T> SheetCount(int sheetCount)
    Parameters
    Type Name Description
    System.Int32 sheetCount

    The sheet count.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    Sheets(Action<SpreadsheetSheetOptionsBuilder<T>>)

    Specifies the sheets for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> Sheets(Action<SpreadsheetSheetOptionsBuilder<T>> sheetOption)
    Parameters
    Type Name Description
    System.Action<SpreadsheetSheetOptionsBuilder<T>> sheetOption

    The sheet using sheetOptionsBuilder.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    Sheets(List<Sheet>)

    Specifies the sheets for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> Sheets(List<Sheet> sheetOption)
    Parameters
    Type Name Description
    System.Collections.Generic.List<Sheet> sheetOption

    The sheet using Sheet object.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ShowPager()

    Specifies to enable the Pager.

    Declaration
    public WorkbookPropertiesBuilder<T> ShowPager()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ShowPager(Boolean)

    Specifies to indicate whether Pager is enable or not.

    Declaration
    public WorkbookPropertiesBuilder<T> ShowPager(bool showPager)
    Parameters
    Type Name Description
    System.Boolean showPager
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ShowRibbon()

    Specifies to enable the ribbon.

    Declaration
    public WorkbookPropertiesBuilder<T> ShowRibbon()
    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ShowRibbon(Boolean)

    Specifies to indicate whether ribbon is show or hide.

    Declaration
    public WorkbookPropertiesBuilder<T> ShowRibbon(bool showRibbon)
    Parameters
    Type Name Description
    System.Boolean showRibbon

    true if the ribbon is show; otherwise, false.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    ToHtmlString()

    Declaration
    public string ToHtmlString()
    Returns
    Type Description
    System.String

    UndoredoStep(Int32)

    Specifies the undo redo step for sheet.

    Declaration
    public WorkbookPropertiesBuilder<T> UndoredoStep(int undoredoStep)
    Parameters
    Type Name Description
    System.Int32 undoredoStep

    The undo redo step.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    UserName(String)

    Specifies the userName for Spreadsheet.

    Declaration
    public WorkbookPropertiesBuilder<T> UserName(string userName)
    Parameters
    Type Name Description
    System.String userName

    The username.

    Returns
    Type Description
    WorkbookPropertiesBuilder<T>

    Implements

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