[]
        
(Showing Draft Content)

FarPoint.Web.Spread.FpSpread

FpSpread Class

Represents a Web Forms (ASP.NET) Spread spreadsheet component that displays data in rows and columns.

Inheritance
FpSpread
Namespace: FarPoint.Web.Spread
Assembly: FarPoint.Web.Spread.dll
Syntax
[ToolboxBitmap(typeof(FpSpread), "FpSpread.png")]
public class FpSpread : WebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IPostBackDataHandler, IPostBackEventHandler, INamingContainer, ISerializeSupport, ISerializeSettings, ISerializeStyles, ISerializeData, ISerializePresentation
<ToolboxBitmap(GetType(FpSpread), "FpSpread.png")>
Public Class FpSpread
    Inherits WebControl
    Implements IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IPostBackDataHandler, IPostBackEventHandler, INamingContainer, ISerializeSupport, ISerializeSettings, ISerializeStyles, ISerializeData, ISerializePresentation

Constructors

Name Description
FpSpread()

Creates a new spreadsheet component with only one sheet.

FpSpread(int)

Creates a new spreadsheet component with the specified number of sheets.

Fields

Name Description
CollapseImage

Specifies the identifier for the image for the collapse icon in hierarchical displays in the component.

ExpandImage

Specifies the identifier for the image for the expand icon in hierarchical displays in the component.

FrozenIndicatorImage

Specifies the identifier for the image for the frozen indicator.

SortAscendingImage

Specifies the identifier for the image for the sort indicator (for ascending sorts) in the component.

SortDescendingImage

Specifies the identifier for the image for the sort indicator (for descending sorts) in the component.

Unchanged

Represents the unchanged property of the cell contents.

Properties

Name Description
About

Gets the read-only string that contains version information about the Spread component.

ActiveSheetView

Gets the currently selected sheet for the Spread component.

ActiveSheetViewIndex

Gets or sets the currently selected sheet in the Spread component.

AllowClientUnlock

Gets or sets whether the user can unlock a cell from the client side.

AllowGenerateHiddenData

Gets or sets whether to allow generate data of hidden rows/columns.

AllowGetAllHiddenValue

Gets or sets whether Spread should support getting or setting a value from any hidden cell in the sheet.

AllowHeaderResize

Gets or sets whether to allow the user to resize the headers.

AllowLoadOnDemand

Gets or sets whether to allow incremental loads to the client on demand when the user is scrolling.

BackColor

Gets the background color of the active sheet in the Spread component. To change the background color, please use the BackColor property of the SheetView class.

Cells

Gets the cells in the client area of the active sheet in the Spread component.

ClientAutoCalculation

Gets or sets whether to perform automatic re-calculation on the client-side data in support of AJAX applications.

ClientAutoSize

Gets or sets whether to resize the spread automatically.

ClientAutoSizeMaxHeight

Gets or sets the maximum height of Spread when the ClientAutoSize property is True.

ClientAutoSizeMaxWidth

Gets or sets the maximum width of Spread when the ClientAutoSize property is True.

ColumnFooter

Gets the column footers in the Spread component.

ColumnHeader

Gets the column headers in the Spread component.

Columns

Gets the columns in the client area of the active sheet in the Spread component.

CommandBar

Gets the command bar information for the component.

CommandBarOnBottom

Gets or sets whether to display the command bar at the bottom of the Spread component.

ContextMenus

Gets the context menus.

Controls

Gets the controls.

CurrentPage

Gets or sets the current page.

DataMember

Gets or sets the name of the data member that populates the active sheet for the Spread component.

DataSource

Gets or sets the name of the data source that populates the active sheet for the Spread component.

DataSourceID

Gets or sets the unique identifier of the data source for the Spread component.

DeleteMethod

Gets or sets the name of the method to call to delete data.

DesignString

Gets or sets an XML string that contains the serialization of the design-time settings for the Spread component.

DocumentMode

Indicates which mode is used to render content properly.

DragColumnCssClass

Gets or sets the CSS class for the column being dragged during grouping.

DragRowCssClass

Gets or sets the CSS class for the row being dragged during grouping.

EditModePermanent

Gets or sets whether edit mode remains on for any cell in the component when that cell becomes active.

EditModeReplace

Gets or sets whether the existing text in a cell is selected when the cell enters edit mode.

EnableAjaxCall

Gets or sets whether to enable an AJAX call for certain actions.

EnableClientScript

Gets or sets whether the Spread component can use client-side JavaScript for up-level browsers.

EnableContextMenu

Gets or sets a value that indicates whether to enable the context menu.

EnableCrossSheetReference

Gets or sets whether to enable cross-sheet referencing for the Spread component.

EnablejQueryTheme

Gets or sets whether Spread should apply the jQuery theme on the client-side.

EncodeValue

Gets or sets whether the Spread component encodes the values from the data model and the user's input using the HtmlEncode method.

ExpandIconOnRight

Gets or sets the position of the expand and collapse image in the Spread component.

FocusRectangleBorderColor

Gets or sets the color of the border for the focus rectangle.

FocusRectangleBorderStyle

Gets or sets the style of the border for the focus rectangle.

Font

This property is not used. To change the font for all the cells, please use the DefaultStyle property of the SheetView class.

ForeColor

This property is not used. To change the text color for all the cells, please use the DefaultStyle property of the SheetView class.

FpSpreadAdapter

Call DynamicDataManager's RegisterControl method against this property to register spread with the DynamicDataManager.

GroupColumnHeaderCssClass

Gets or sets the CSS class for the column headers on the group bar.

GroupingPolicy

Gets or sets grouping policy to collapse or expand rows when grouping occurs.

HeaderIndicatorPositionAdjusting

Gets or sets the distance between the sorting and filtering indicators and the right edge of the column.

HierBar

Gets the hierarchy bar information for the component.

HierarchicalView

Gets or sets whether to display the child sheets in the Spread component hierarchically.

HorizontalScrollBarPolicy

Gets or sets whether and how the Spread component displays the horizontal scroll bar.

InsertMethod

Gets or sets the name of the method to call to insert data.

IsPrint

Determines whether the FarPoint component creates the print output.

IsProtectedStructure

Specifies whether Spread allows the user to change the structure of the sheet collection.

ItemType

Gets or sets the name of the data item type for strongly typed data binding.

LoadInitRowCount

Gets or sets the number of rows to load initially to the client.

LoadRowIncrement

Gets or sets the number of rows to include in incremental loads on demand.

MoveToNextCellThenControl

Gets or sets whether to process the Tab key as a way of advancing to the next control when tabbing from the last cell.

MoveToPreviousCellThenControl

Gets or sets whether to process the Tab key as a way of advancing to the previous control when tabbing from the first cell.

NamedStyles

Gets a collection of styles for the Spread component.

NonEditModeValidation

Gets or sets whether to perform validation when Spread in non-editing state.

Pager

Gets the page navigation information for the component.

Parallel

Gets or sets a value that indicates whether Spread supports multi-threading.

ProcessTab

Gets or sets whether to process the Tab key as a way of advancing to the next active cell in the Spread component.

RenderCSSClass

Gets or sets whether the Spread component should render the styles by using CSS styles or by using in-line style attributes.

RenderCoveredCell

Gets or sets whether the spread should render the cells being covered by a span cell.

ResetIfNoFilteredRow

Gets or sets a value that indicates whether the filtered row list will be reset if there is no filtered row. Set this property to False to be compatible with version 6 or earlier.

RetainSelectionBlock

Gets or sets whether the selected range of cells remains highlighted when the component loses the focus.

RowEditTemplate

Gets the row edit template.

RowHeader

Gets the row headers in the Spread component.

Rows

Gets the rows in the client area of the active sheet in the Spread component.

SaveViewStateToSession

When this property is true, the spread will save its view state to the Session object. And, the SaveOrLoadSheetState event will not be fired. If you do not want to save the spread view state to the Session object, you should set this property to false. The default value is true.

ScrollBar3DLightColor

Gets or sets the color of the top and left edges of the scroll box and scroll arrows of a scroll bar in the Spread component.

ScrollBarArrowColor

Gets or sets the color for the arrows (when active) in the scroll bars in the Spread component.

ScrollBarBaseColor

Gets or sets the base color of the scroll boxes, scroll tracks, and scroll arrows in the Spread component.

ScrollBarDarkShadowColor

Gets or sets the color of the gutter of the scroll bars in the Spread component.

ScrollBarFaceColor

Gets or sets the color of the scroll box and scroll arrows in the Spread component.

ScrollBarHighlightColor

Gets or sets the color of the top and left edges of the scroll box and scroll arrows of the scroll bars in the Spread component.

ScrollBarShadowColor

Gets or sets the color of the bottom and right edges of the scroll box and scroll arrows of the scroll bars in the Spread component.

ScrollBarTrackColor

Gets or sets the color of the track element of the scroll bars in the Spread component.

SelectMethod

Gets or sets the name of the method to call to read data.

SelectionBlockOptions

Gets or sets which types of selections the user can make in the view.

SheetCorner

Gets the sheet corner in the Spread component.

Sheets

Gets a collection of sheets for the Spread component.

ShowFocusRectangle

Gets or sets whether to display the focus rectangle.

ShowHeaderSelection

Gets or sets whether to highlight the header cells when the cells in the row or column are selected.

Tab

Gets the sheet tab name information for the component.

TabIndex

Gets or sets the index of the tab. Internal use only.

TitleInfo

Gets the title information.

TouchInfo

Gets a TouchInfo object that determines touch behavior for Spread.

TouchStrips

The TouchStrip collection of Spread.

UIVirtualization

Gets or sets whether to use UI virtualization.

UpdateMethod

Gets or sets the name of the method to call to update data.

UseClipboard

Gets or sets whether to access the Clipboard with client-side scripting.

ValidationErrorMessage

Gets or sets the validation error message.

VerticalScrollBarPolicy

Gets or sets whether and how the Spread component displays the vertical scroll bar.

WaitMessage

Gets or sets the Wait Message for load on demand.

Methods

Name Description
AddParsedSubObject(object)

Adds the Spread component to the child control collection.

AddedControl(Control, int)

Handles the event when a DIRECT child control is added to Spread Controls collection. Changes its ClientIDMode to ClientIDMode.Predictable to make spread client script run correctly in NET40 or above environment.

CancelEdit()

Discards the editing values in the Spread component.

CreateChildControls()

Creates the child controls.

CreateDesignView()

Creates a new design-time view of the Spread component.

CreateDesignView(string)

Creates a new design-time view of the spreadsheet component at the specified location.

CreateDesignView(string, Page)

Creates a new design-time view of the spreadsheet component at the specified location and page.

DataBind()

Binds a data source to the Spread component.

Dispose()

Cleans up any resources being used.

FindControl(string, int)

Searches the current naming container for a server control with the specified id and integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the Overload:System.Web.UI.Control.FindControl method.

FindControl(Control, string)

Finds the control.

FlushData()

Flushes the data.

GetColumnIndex(int)

Returns the client column index for the specified column.

GetEditValue(int, int)

Gets the postback value of the specified cell on the active sheet in the Spread component.

GetExcelSheetNames(Stream)

Gets an array of sheet names from the specified Excel file from a stream.

GetExcelSheetNames(Stream, string)

Gets an array of sheet names from the specified Excel file from a stream.

GetExcelSheetNames(string)

Gets an array of sheet names from the specified Excel file.

GetExcelSheetNames(string, string)

Gets an array of sheet names from the specified Excel file.

GetImage(SpreadImages)

Gets the image in the component.

GetMergeCell(int, int)

Gets the merged cell range at the specified cell.

GetMergeCells(int, int, int, int)

Gets the merged cell ranges in the specified range.

GetPageIndex(int)

Returns the page index the specified row is rendered in.

GetRowIndex(int, int)

Returns the client row index for the specified row.

GetTabText(int)

Gets the text of the sheet name tab at the specified sheet in the Spread component.

GoalSeek(int, int, int, int, int, int, double)

Attempts to find values for one cell that will produce the desired formula result in another cell.

GotoPage(int)

Scrolls through the sheet in the component to the specified page.

Group(int, int, bool)

Groups the rows in the specified column.

IsExcelFile(string)

Opens the specified file and determines whether it meets the minimal requirements to be considered an Excel file.

IsExcelFile(string, ref ExcelWorkbookType, out bool)

Opens the specified file and determines whether it meets the minimal requirements
to be considered a structured storage file containing an Excel workbook.

IsExcelStream(Stream)

Opens the specified file and determines whether it meets the minimal requirements
to be considered an Excel-compatible stream.

IsExcelStream(Stream, ref ExcelWorkbookType, out bool)

Opens the specified file and determines whether it meets the minimal requirements to be considered a stream containing an Excel workbook.

IsStrictMode()

Determines whether the component is under strict standards-compliant mode.

LoadFormulas(bool)

Loads formulas that are deserialized, but not parsed yet, to be used after all sheets have been created and deserialized.

LoadViewState(object)

Loads the view state of the Spread component.

MoveColumn(int, int)

Moves the column from one location to another as specified.

MoveRow(int, int)

Moves the row from one location to another as specified.

OnAdd()

Processes the Add command in the Spread component.

OnAggregate(AggregateArgs)

Raises the Changed event, and permits derived classes to handle the event without attaching a delegate.

OnButtonCmd(string, int, int)

Processes the specified button command for the cell at the specified row and column in the Spread component.

OnCancel()

Processes the Cancel command in the Spread component.

OnCellClick(int, int)

Processes the click on a cell at the specified row and column in the Spread component.

OnChildView(string)

Displays the specified child view in the Spread component.

OnColumnHeaderClick(int, int)

Processes a click on a column header cell at the specified row and column in the Spread component.

OnDelete(int)

Processes the Delete command in the Spread component.

OnEdit(int)

Processes the Edit command in the Spread component.

OnExpandView(int)

Displays the child view in the component at the specified row.

OnFirstPage()

Occurs when the first page is reached.

OnInit(EventArgs)

Initializes the Spread component.

OnInsert(int)

Processes the Insert command at the specified row in the Spread component.

OnLastPage()

Occurs when the last page is reached.

OnLoad(EventArgs)

Occurs when the Load event is raised.

OnLoadOnDemand()

Occurs when an incremental load to the client occurs for load on demand.

OnMenuItemClicked(MenuItemClickEventArgs)

Raises the MenuItemClicked event.

OnNextPage()

Processes the Next Page command in the Spread component.

OnPage(int)

Processes the Page command for the Spread component.

OnPreRender(EventArgs)

Pre-renders the Spread component and creates the child controls.

OnPrevPage()

Processes the Previous Page command in the Spread component.

OnPrint()

Processes the Print command in the Spread component.

OnPrintAbort(PrintAbortEventArgs)

Raises the PrintAbort event.

OnPrintBackground(PrintBackgroundEventArgs)

Raises the PrintBackground event.

OnPrintExternalImage(PrintExternalImageEventArgs)

Raises the PrintExternalImage event.

OnPrintExternalImageEnd(PrintExternalImageEventArgs)

Raises the PrintExternalImageEnd event.

OnPrintPDF()

Processes the PrintPDF command in the Spread component.

OnPrintPDF(string[])

Processes the PrintPDF command in the Spread component.

OnRowHeaderClick(int, int)

Processes a click on a row header cell at the specified row and column in the Spread component.

OnSaveExcel(string[])

Processes the SaveExcel command in the Spread component.

OnSelect(int)

Selects the specified row in the Spread component.

OnSelectView(int)

Switches to a different sheet in the Spread component.

OnSortColumn(int)

Processes the Column Sort command for the specified column in the Spread component.

OnTabLeft()

Scrolls the tabs to the right in the Spread component.

OnTabRight()

Scrolls the tabs to the left in the Spread component.

OnTouchStripItemClicked(TouchStripItemClickEventArgs)

Raises the TouchStripItemClicked event.

OnUpdate(int)

Processes the Update command and updates the Spread component.

OnUpdateDownLevel()

Processes the Update command for a down-level browser and updates the Spread component.

OnUpdateRenderEditors()

Processes the Update command for the RenderEditors mode in the Spread component.

OnUpdateRowEditTemplate()

Handles the update of the editing template.

OnUpdateUpperLevel()

Handles the Update command (and updates the Spread component) for the up-level browser (IE5.5 or above).

Open(Stream)

Opens a saved Spread XML file and loads it into the Spread component from a stream.

Open(string)

Opens a saved Spread XML file and loads it into the Spread component.

OpenExcel(Stream)

Opens an Excel stream and loads it into the Spread component.

OpenExcel(Stream, ExcelOpenFlags)

Opens an Excel stream into the Spread component including the specified parts of the spreadsheet.

OpenExcel(Stream, ExcelOpenFlags, ExcelWarningList)

Opens an Excel stream into the Spread component including the specified parts keeping track of warnings.

OpenExcel(Stream, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel stream into the Spread component including the specified parts keeping track of warnings.

OpenExcel(Stream, ExcelWarningList)

Opens an Excel stream into the Spread component keeping track of warnings.

OpenExcel(Stream, int, int)

Opens an Excel stream and loads the specified Excel sheet (by index) into this sheet of the Spread component (by index).

OpenExcel(Stream, int, int, ExcelOpenFlags)

Opens an Excel file from a stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(Stream, int, int, ExcelOpenFlags, ExcelWarningList)

Opens an Excel file from a stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

OpenExcel(Stream, int, int, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel file from a stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

OpenExcel(Stream, int, int, ExcelWarningList)

Opens an Excel stream and loads the specified Excel sheet (by index) into this sheet of the Spread component (by index) keeping track of warnings.

OpenExcel(Stream, int, string)

Opens an Excel stream and loads the specified Excel sheet (by name) into this sheet of the Spread component (by index).

OpenExcel(Stream, int, string, ExcelOpenFlags)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(Stream, int, string, ExcelOpenFlags, string)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(Stream, string)

Opens an Excel stream and loads it into the Spread component.

OpenExcel(Stream, string, string)

Opens an Excel stream and loads the specified Excel sheet (by name) into this sheet of the Spread component (by name).

OpenExcel(Stream, string, string, ExcelOpenFlags)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(Stream, string, string, ExcelOpenFlags, string)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(string)

Opens an Excel file and loads it into the Spread component.

OpenExcel(string, ExcelOpenFlags)

Opens an Excel file into the Spread component including the specified parts of the spreadsheet.

OpenExcel(string, ExcelOpenFlags, ExcelWarningList)

Opens an Excel file into the Spread component including the specified parts and keeps track of warnings.

OpenExcel(string, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel file into the Spread component including the specified parts and keeps track of warnings.

OpenExcel(string, ExcelWarningList)

Opens an Excel file into the Spread component keeping track of warnings.

OpenExcel(string, int, int)

Opens an Excel file and loads the specified Excel sheet (by index) into the specified sheet of the Spread component (by index).

OpenExcel(string, int, int, ExcelOpenFlags)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(string, int, int, ExcelOpenFlags, ExcelWarningList)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

OpenExcel(string, int, int, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

OpenExcel(string, int, int, ExcelWarningList)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component keeping track of warnings.

OpenExcel(string, int, string)

Opens an Excel file and loads the specified Excel sheet (by name) into the specified sheet of the Spread component (by index).

OpenExcel(string, int, string, ExcelOpenFlags)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(string, int, string, ExcelOpenFlags, string)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(string, string)

Opens an Excel file and loads it into the Spread component.

OpenExcel(string, string, string)

Opens an Excel file and loads the specified Excel sheet (by name) into the specified sheet of the Spread component (by name).

OpenExcel(string, string, string, ExcelOpenFlags)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

OpenExcel(string, string, string, ExcelOpenFlags, string)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

RecreateControl()

Forces spread to recreate its content.

Regroup(int, int)

Rearranges the order of grouping based on the movement of the specified column.

RemoveGroup(int, int)

Removes the grouping for the specified column and moves the column to the specified location.

RemovedControl(Control)

Called after a child control is removed from the System.Web.UI.Control.Controls collection of the System.Web.UI.Control object.

Render(HtmlTextWriter)

Renders the Spread component in HTML.

RenderBeginTag(HtmlTextWriter)

Adds the CSS style atttributes to the specified HTML writer.

RenderChildren(HtmlTextWriter)

Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

RenderControl(HtmlTextWriter)

Renders the spreadsheet component to the specified HtmlTextWriter object.

RenderEndTag(HtmlTextWriter)

Appends the CSS style name to the specified HTML writer.

Reset()

Resets the Spread component to its default values, removing all settings and all sheets.

Save(Stream, bool)

Saves the contents of the Spread component to XML in the specified stream.

Save(string, bool)

Saves the contents of the Spread component to XML in the specified file.

SaveChanges()

Saves the changes to the Spread component.

SaveExcel(Stream)

Saves the contents of the Spread component to the specified Excel file in a stream.

SaveExcel(Stream, ExcelSaveFlags)

Saves the contents of the Spread component with the specified parts to the specified Excel file in a stream.

SaveExcel(Stream, ExcelSaveFlags, ExcelWarningList)

Saves the contents of the Spread component to the specified Excel file in a stream, keeping track of warnings.

SaveExcel(Stream, ExcelSaveFlags, ExcelWarningList, string)

Saves the contents of the Spread component to the specified Excel file in a stream, keeping track of warnings.

SaveExcel(Stream, ExcelSaveFlags, string)

Saves the contents of the Spread component with the specified parts to the specified Excel file in a stream.

SaveExcel(Stream, ExcelWarningList)

Saves the contents of the Spread component to the specified Excel file in a stream keeping track of warnings.

SaveExcel(Stream, string)

Saves the contents of the Spread component to the specified Excel file in a stream.

SaveExcel(string)

Saves the contents of the Spread component to Excel in the specified file.

SaveExcel(string, ExcelSaveFlags)

Saves the contents of the Spread component to Excel in the specified file including the specified parts.

SaveExcel(string, ExcelSaveFlags, ExcelWarningList)

Saves the contents of the Spread component with the specified parts to Excel in the specified file keeping track of warnings.

SaveExcel(string, ExcelSaveFlags, ExcelWarningList, string)

Saves the contents of the Spread component with the specified parts to Excel in the specified file keeping track of warnings.

SaveExcel(string, ExcelSaveFlags, string)

Saves the contents of the Spread component to Excel in the specified file including the specified parts.

SaveExcel(string, ExcelWarningList)

Saves the contents of the Spread component to Excel in the specified file keeping track of warnings.

SaveExcel(string, IncludeHeaders)

Saves the contents of the Spread component to Excel in the specified file and whether to include headers.

SaveExcel(string, IncludeHeaders, ExcelWarningList)

Saves the contents of the Spread component to Excel in the specified file and whether to include headers and keeps track of warnings.

SaveExcel(string, string)

Saves the contents of the Spread component to Excel in the specified file.

SaveExcelToResponse()

Saves the contents of the Spread component to a Response object in Excel file format with default settings.

SaveExcelToResponse(string)

Saves the contents of the Spread component to a Response object in Excel file format with the specified file name.

SaveExcelToResponse(string, ExcelSaveFlags)

Saves the contents of the Spread component to a Response object in Excel file format with the specified file name and Excel save options.

SaveExcelToResponse(string, ExcelSaveFlags, string)

Saves the contents of the Spread component to a Response object in Excel file format with the specified file name and Excel save options.

SaveExcelToResponse(string, string)

Saves the contents of the Spread component to a Response object in Excel file format with the specified file name.

SavePdf(SheetView, Stream)

Handles the export (or printing) of the specified sheet to PDF as a stream.

SavePdf(SheetView, Stream, PdfSecurity)

Handles the export (or printing) of the specified sheet to PDF as a stream.

SavePdf(SheetView, string)

Handles the export (or printing) of the specified sheet to PDF as a file.

SavePdf(SheetView, string, PdfSecurity)

Handles the export (or printing) of the specified sheet to PDF as a file.

SavePdf(Stream)

Handles the export (or printing) of all the sheets to PDF as a stream.

SavePdf(Stream, PdfSecurity)

Handles the export (or printing) of all the sheets to PDF as a stream.

SavePdf(int, Stream)

Handles the export (or printing) of the specified sheet to PDF as a stream.

SavePdf(int, Stream, PdfSecurity)

Handles the export (or printing) of the specified sheet to PDF as a stream.

SavePdf(int, string)

Handles the export (or printing) of the specified sheet to PDF as a file.

SavePdf(int, string, PdfSecurity)

Handles the export (or printing) of the specified sheet to PDF as a file.

SavePdf(string)

Handles the export (or printing) of all the sheets to PDF as a file.

SavePdf(string, PdfSecurity)

Handles the export (or printing) of all the sheets to PDF as a file.

SavePdfToResponse()

Saves the contents of the Spread component to a Response object in PDF file format.

SavePdfToResponse(PdfSecurity)

Saves the contents of the Spread component to a Response object in PDF file format.

The password to encrypt pdf file
SavePdfToResponse(int, string, bool)

Saves the contents of the Spread component to a Response object in PDF file format.

SavePdfToResponse(int, string, bool, PdfSecurity)

Saves the contents of the Spread component to a Response object in PDF file format.

SavePdfToResponse(string)

Saves the contents of the Spread component to a Response object in PDF file format.

SavePdfToResponse(string, PdfSecurity)

Saves the contents of the Spread component to a Response object in PDF file format.

SaveViewState()

Saves the view state of the component.

Search(int, int, string, bool, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int, ref int)

Searches the text in the specified range of cells in the specified sheet range for the specified string with the specified criteria.

Search(int, string, bool, bool, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int)

Searches the text in the specified range of cells in the specified sheet
for the specified string with the specified criteria.

Search(int, string, bool, bool, bool, bool, bool, bool, bool, int, int, ref int, ref int)

Searches the text in the specified range of cells in the specified sheet
for the specified string with the specified criteria.

Search(int, string, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int)

Searches the text in the specified range of cells in the specified sheet
for the specified string with the specified criteria.

Search(int, string, bool, bool, bool, bool, int, int, int, int, ref int, ref int)

Searches the text in the specified range of cells in the specified sheet
for the specified string with the specified criteria.

Search(int, string, bool, bool, bool, bool, int, int, ref int, ref int)

Searches the text in the cells in the specified sheet for the specified string with the specified criteria.

SearchHeaders(int, string, bool, bool, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int)

Searches the text in the specified range of header cells in the specified sheet
for the specified string with the specified criteria.

SearchHeaders(int, string, bool, ref int, ref int)

Searches the text in the header cells in the specified sheet
for the specified string with the specified criteria.

SetImage(SpreadImages, string)

Sets the custom image in the specified part of the Spread component interface.

SetProtect(bool, string)

Changes the protect structure setting with the password parameter.

TrackViewState()

Invokes child IStateManager object TrackViewState() method to start tracking.

UpdateView()

Updates the column width and the row height.

Validate(object, int, int)

Tests to see if the value is valid for a cell in the active sheet in the Spread component.

Events

Name Description
ActiveRowChanged

Occurs when the user sets the operation mode to row mode and moves the focus to a new row.

ActiveSheetChanged

Occurs when the user changes the active sheet.

Aggregate

Occurs when the data model aggregates.

AutoFilteredColumn

Occurs when the user is done filtering.

AutoFilteringColumn

Occurs when the user is filtering.

ButtonCommand

Occurs when a user clicks a button cell on a sheet.

CancelCommand

Occurs when the user clicks the Cancel button on the component.

CellClick

Occurs when the user clicks a cell using the left mouse button.

ChildViewCreated

Occurs when the user creates a child sheet.

ColumnHeaderClick

Occurs when the user clicks a cell in the column header using the left mouse button.

CreateButton

Occurs when the user clicks on the Create button.

DeleteColumnCommand

Occurs when the user clicks/touches on the DeleteColumn button on the component and deletes column(s) in the active sheet.

DeleteCommand

Occurs when the user clicks the Delete button on the component.

DeleteRowCommand

Occurs when the user clicks/touches on the DeleteRow button on the component and deletes row(s) in the active sheet.

EditCommand

Occurs when the user clicks the Edit button on the component.

ErrorCommand

Occurs when the use of a command button causes an error.

ExportExcel

Occurs before saving Spread to Excel.

FetchGroupText

Occurs when spread creates the group bar.

Grouped

Occurs when the user is done grouping.

Grouping

Occurs when the user is grouping.

HideColumnCommand

Occurs when the user clicks/touches on the HideColumn button on the component and hides column(s) in the active sheet.

HideRowCommand

Occurs when the user clicks/touches on the HideRow button on the component and hides row(s) in the active sheet.

InsertColumnCommand

Occurs when the user clicks/touches on the InsertColumn button on the component and inserts column(s) in the active sheet.

InsertCommand

Occurs when the user clicks on the Insert button on the component and inserts a new row in the active sheet.

InsertRowCommand

Occurs when the user clicks/touches on the InsertRow button on the component and inserts row(s) in the active sheet.

MenuItemClicked

Occurs when the Spread context menu item is clicked.

PrintAbort

Occurs continually as printing occurs in order to give the user the opportunity to discontinue a print job.

PrintBackground

Occurs before each page is printed.

PrintExternalImage

Represents a defined method that handles the PrintExternalImage event for the Spread component.

PrintExternalImageEnd

Represents a defined method that handles the PrintExternalImageEnd event for the Spread component.

PrintPDF

Occurs before printing spread to PDF.

PrintSheet

Occurs when a sheet is printed.

RowHeaderClick

Occurs when the user clicks a cell in the row header using the left mouse button.

SaveOrLoadSheetState

Occurs when the user saves or loads a view state of a sheet.

SortColumnCommand

Occurs when the user sorts a column.

TopRowChanged

Occurs when the user changes the top row of a sheet.

TouchStripItemClicked

Occurs when the TouchStrip item is clicked.

Ungrouped

Occurs when the user is done grouping.

UnhideColumnCommand

Occurs when the user clicks/touches on the UnhideColumn button on the component and un-hides column(s) in the active sheet.

UnhideRowCommand

Occurs when the user clicks/touches on the UnhideRow button on the component and un-hides row(s) in the active sheet.

UpdateCommand

Occurs when the user clicks the Update button on the component.