FlexSheetBuilder Class

Defines a builder to configurate FlexSheet.

Inheritance

object

HideObjectMembers

BaseBuilder<FlexSheet, FlexSheetBuilder>

ComponentBuilder<FlexSheet, FlexSheetBuilder>

ControlBuilder<FlexSheet, FlexSheetBuilder>

ItemsBoundControlBuilder<object, FlexSheet, FlexSheetBuilder>

FlexGridBaseBuilder<object, FlexSheet, FlexSheetBuilder>

FlexSheetBuilder

Implements

IHtmlContent

Namespace: C1.Web.Mvc.Sheet.Fluent

Assembly: C1.AspNetCore.Mvc.FlexSheet.dll

Syntax

public class FlexSheetBuilder : FlexGridBaseBuilder<object, FlexSheet, FlexSheetBuilder>, IHtmlContent

Public Class FlexSheetBuilder
    Inherits FlexGridBaseBuilder(Of Object, FlexSheet, FlexSheetBuilder)
    Implements IHtmlContent

Constructors

Name	Description
FlexSheetBuilder(FlexSheet)	Creates one FlexSheetBuilder instance to configurate `component`.

Methods

Name	Description
AddBoundSheet(Action<BoundSheetBuilder<object>>)	Add a bound sheet. It will be put after the loaded Workbook or xlsx file.
AddBoundSheet<T>(Action<BoundSheetBuilder<T>>)	Add a bound sheet. It will be put after the loaded Workbook or xlsx file.
AddUnboundSheet(Action<UnboundSheetBuilder>)	Add an unbound sheet. It will be put after the loaded Workbook or xlsx file.
AddUnboundSheet(string, int, int)	Add an unbound sheet. It will be put after the loaded Workbook or xlsx file.
AllowAutoFill(bool)	Configurates AllowAutoFill. Sets the value to indicates whether enable autofill, the feature to fill cells with data that follows a pattern by dragging the bottom right corner of the cell.
AutoGenerateColumns(bool)	Sets a boolean value decides auto generate columns on FlexSheet.
CalculationPrecision(int)	Configurates CalculationPrecision. Sets the number of digits after the decimal point to round to when calculating formulas. Negative value means that no rounding is performed.
DefinedNames(Action<ListItemFactory<DefinedName, DefinedNameBuilder>>)	Configure DefinedNames.
EnableDragDrop(bool)	Configurates EnableDragDrop. Sets the value to indicates whether enable drag and drop rows or columns in FlexSheet.
EnableFormulas(bool)	Configurates EnableFormulas. Sets the value to indicates whether enable formulas in FlexSheet.
Filter(Action<FlexSheetFilterBuilder>)	Configurates Filter. Sets the filter settings for this FlexSheet.
IsTabHolderVisible(bool)	Configurates IsTabHolderVisible. Sets a value indicating whether the TabHolder is visible.
ItemFormatter(string)	Sets a formatter function used to customize cells on this grid.
Load(Workbook)	Load the Workbook instance.
Load(Stream)	Load the xlsx file with FileStream.
Load(string)	Load the xlsx file with file path.
OnClientAutoFilled(string)	Configurates the OnClientAutoFilled client event. Occurs after has performed the auto-fill operation.
OnClientAutoFilling(string)	Configurates the OnClientAutoFilling client event. Occurs before performing the auto-fill operation.
OnClientBeginDroppingRowColumn(string)	Configurates the OnClientBeginDroppingRowColumn client event. Occurs when begin dropping the rows or the columns of the FlexSheet.
OnClientColumnChanged(string)	Configurates the OnClientColumnChanged client event. Occurs after inserting or deleting columns.
OnClientDraggingRowColumn(string)	Configurates the OnClientDraggingRowColumn client event. Occurs when dragging the rows or the columns of the FlexSheet.
OnClientEndDroppingRowColumn(string)	Configurates the OnClientEndDroppingRowColumn client event. Occurs when end dropping the rows or the columns of the FlexSheet.
OnClientLoaded(string)	Configurates the OnClientLoaded client event. Occurs after the @see:FlexSheet loads the @see:Workbook instance.
OnClientPrepareChangingColumn(string)	Configurates the OnClientPrepareChangingColumn client event. Occurs before inserting or deleting columns.
OnClientPrepareChangingRow(string)	Configurates the OnClientPrepareChangingRow client event. Occurs before inserting or deleting rows.
OnClientRemoteLoaded(string)	Configurates the OnClientRemoteLoaded client event. Occurs after remote loading the data from sever.
OnClientRemoteLoading(string)	Configurates the OnClientRemoteLoading client event. Occurs before remote loading the data from server.
OnClientRemoteSaved(string)	Configurates the OnClientRemoteSaved client event. Occurs when saving the file back to sever successfully.
OnClientRemoteSaving(string)	Configurates the OnClientRemoteSaving client event. Occurs before saving the file back to server.
OnClientRowChanged(string)	Configurates the OnClientRowChanged client event. Occurs after inserting or deleting rows.
OnClientSelectedSheetChanged(string)	Configurates the OnClientSelectedSheetChanged client event. Occurs when current sheet index changed.
OnClientSheetCleared(string)	Configurates the OnClientSheetCleared client event. Occurs when the FlexSheet is cleared.
OnClientSheetVisibleChanged(string)	Configurates the OnClientSheetVisibleChanged client event. Occurs after the visible of the sheet in the sheet collection of the FlexSheet has changed.
OnClientUnknownFunction(string)	Configurates the OnClientUnknownFunction client event. Occurs when the @see:FlexSheet meets the unknown formula.
RemoteLoad(string)	Sets the LoadActionUrl for remote loading.
RemoteSave(string, ContentType)	Sets the SaveActionUrl for remote saving.
SaveContentType(ContentType)	Configurates SaveContentType. Sets the type of remote saving data.
Select(int, int, int?, int?, bool)	Selects a cell range and optionally scrolls it into view.
SelectedSheetIndex(int?)	Configurates SelectedSheetIndex. Sets the index of the current sheet in the FlexSheet.
ShowFilterIcons(bool)	Configurates ShowFilterIcons. Sets the visibility of the filter icon.

Extension Methods

FormulaBarExtension.ShowFormulaBar(FlexSheetBuilder, Action<FormulaBarBuilder>)

FormulaBarExtension.ShowFormulaBar(FlexSheetBuilder, string)