Spread for ASP.NET 11 Product Documentation
FpSpread Class Members
Fields  Properties  Methods  Events


FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace : FpSpread Class

The following tables list the members exposed by FpSpread.

Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Fields
 NameDescription
Public FieldSpecifies the identifier for the image for the collapse icon in hierarchical displays in the component.  
Public FieldSpecifies the identifier for the image for the expand icon in hierarchical displays in the component.  
Public FieldSpecifies the identifier for the image for the frozen indicator.  
Public FieldSpecifies the identifier for the image for the sort indicator (for ascending sorts) in the component.  
Public FieldSpecifies the identifier for the image for the sort indicator (for descending sorts) in the component.  
Public Fieldstatic (Shared in Visual Basic)Represents the unchanged property of the cell contents.  
Top
Public Properties
 NameDescription
Public PropertyGets the read-only string that contains version information about the Spread component.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets the currently selected sheet for the Spread component.  
Public PropertyGets or sets the currently selected sheet in the Spread component.  
Public PropertyGets or sets whether the user can unlock a cell from the client side.  
Public PropertyGets or sets whether to allow generate data of hidden rows/columns.  
Public PropertyGets or sets whether Spread should support getting or setting a value from any hidden cell in the sheet.  
Public PropertyGets or sets whether to allow the user to resize the headers.  
Public PropertyGets or sets whether to allow incremental loads to the client on demand when the user is scrolling.  
Public Property (Inherited from System.Web.UI.Control)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyOverridden. 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.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets the cells in the client area of the active sheet in the Spread component.  
Public PropertyGets or sets whether to perform automatic re-calculation on the client-side data in support of AJAX applications.  
Public PropertyGets or sets whether to resize the spread automatically.  
Public PropertyGets or sets the maximum height of Spread when the ClientAutoSize property is True.  
Public PropertyGets or sets the maximum width of Spread when the ClientAutoSize property is True.  
Public Property (Inherited from System.Web.UI.Control)
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets the column footers in the Spread component.  
Public PropertyGets the column headers in the Spread component.  
Public PropertyGets the columns in the client area of the active sheet in the Spread component.  
Public PropertyGets the command bar information for the component.  
Public PropertyGets or sets whether to display the command bar at the bottom of the Spread component.  
Public PropertyGets the context menus.  
Public PropertyOverridden. Gets the controls.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets or sets the current page.  
Public PropertyGets or sets the name of the data member that populates the active sheet for the Spread component.  
Public PropertyGets or sets the name of the data source that populates the active sheet for the Spread component.  
Public PropertyGets or sets the unique identifier of the data source for the Spread component.  
Public PropertyGets or sets the name of the method to call to delete data.  
Public PropertyIndicates which mode is used to render content properly.  
Public PropertyGets or sets the CSS class for the column being dragged during grouping.  
Public PropertyGets or sets the CSS class for the row being dragged during grouping.  
Public PropertyGets or sets whether edit mode remains on for any cell in the component when that cell becomes active.  
Public PropertyGets or sets whether the existing text in a cell is selected when the cell enters edit mode.  
Public PropertyGets or sets whether to enable an AJAX call for certain actions.  
Public PropertyGets or sets whether the Spread component can use client-side JavaScript for up-level browsers.  
Public PropertyGets or sets a value that indicates whether to enable the context menu.  
Public PropertyGets or sets whether to enable cross-sheet referencing for the Spread component.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets or sets whether Spread should apply the jQuery theme on the client-side.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets or sets whether the Spread component encodes the values from the data model and the user's input using the HtmlEncode method.  
Public PropertyGets or sets the position of the expand and collapse image in the Spread component.  
Public PropertyGets or sets the color of the border for the focus rectangle.  
Public PropertyGets or sets the style of the border for the focus rectangle.  
Public PropertyCall DynamicDataManager's RegisterControl method against this property to register spread with the DynamicDataManager.  
Public PropertyGets or sets the CSS class for the column headers on the group bar.  
Public PropertyGets or sets grouping policy to collapse or expand rows when grouping occurs.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets or sets the distance between the sorting and filtering indicators and the right edge of the column.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets or sets whether to display the child sheets in the Spread component hierarchically.  
Public PropertyGets the hierarchy bar information for the component.  
Public PropertyGets or sets whether and how the Spread component displays the horizontal scroll bar.  
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets or sets the name of the method to call to insert data.  
Public PropertyDetermines whether the FarPoint component creates the print output.  
Public PropertySpecifies whether Spread allows the user to change the structure of the sheet collection.  
Public PropertyGets or sets the name of the data item type for strongly typed data binding.  
Public PropertyGets or sets the number of rows to load initially to the client.  
Public PropertyGets or sets the number of rows to include in incremental loads on demand.  
Public PropertyGets or sets whether to process the Tab key as a way of advancing to the next control when tabbing from the last cell.  
Public PropertyGets or sets whether to process the Tab key as a way of advancing to the previous control when tabbing from the first cell.  
Public PropertyGets a collection of styles for the Spread component.  
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets or sets whether to perform validation when Spread in non-editing state.  
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets the page navigation information for the component.  
Public PropertyGets or sets a value that indicates whether Spread supports multi-threading.  
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets or sets whether to process the Tab key as a way of advancing to the next active cell in the Spread component.  
Public PropertyGets or sets whether the Spread component should render the styles by using CSS styles or by using in-line style attributes.  
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets 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.  
Public PropertyGets or sets whether the selected range of cells remains highlighted when the component loses the focus.  
Public PropertyGets the row edit template.  
Public PropertyGets the row headers in the Spread component.  
Public PropertyGets the rows in the client area of the active sheet in the Spread component.  
Public PropertyWhen 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.  
Public PropertyGets 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.  
Public PropertyGets or sets the color for the arrows (when active) in the scroll bars in the Spread component.  
Public PropertyGets or sets the base color of the scroll boxes, scroll tracks, and scroll arrows in the Spread component.  
Public PropertyGets or sets the color of the gutter of the scroll bars in the Spread component.  
Public PropertyGets or sets the color of the scroll box and scroll arrows in the Spread component.  
Public PropertyGets 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.  
Public PropertyGets 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.  
Public PropertyGets or sets the color of the track element of the scroll bars in the Spread component.  
Public PropertyGets or sets which types of selections the user can make in the view.  
Public PropertyGets or sets the name of the method to call to read data.  
Public PropertyGets the sheet corner in the Spread component.  
Public PropertyGets a collection of sheets for the Spread component.  
Public PropertyGets or sets whether to display the focus rectangle.  
Public PropertyGets or sets whether to highlight the header cells when the cells in the row or column are selected.  
Public Property (Inherited from System.Web.UI.Control)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets the sheet tab name information for the component.  
Public Property (Inherited from System.Web.UI.Control)
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets the title information.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyGets a TouchInfo object that determines touch behavior for Spread.  
Public PropertyThe TouchStrip collection of Spread.  
Public PropertyGets or sets whether to use UI virtualization.  
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets or sets the name of the method to call to update data.  
Public PropertyGets or sets whether to access the Clipboard with client-side scripting.  
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets or sets the validation error message.  
Public PropertyGets or sets whether and how the Spread component displays the vertical scroll bar.  
Public Property (Inherited from System.Web.UI.Control)
Public Property (Inherited from System.Web.UI.Control)
Public PropertyGets or sets the Wait Message for load on demand.  
Public Property (Inherited from System.Web.UI.WebControls.WebControl)
Top
Protected Properties
Public Methods
 NameDescription
Public Method (Inherited from System.Web.UI.WebControls.WebControl)
Public Method (Inherited from System.Web.UI.Control)
Public MethodDiscards the editing values in the Spread component.  
Public Method (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodOverloaded. Overridden. Binds a data source to the Spread component.  
Public MethodOverloaded. Overridden. 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.  
Public Method (Inherited from System.Web.UI.Control)
Public MethodReturns the client column index for the specified column.  
Public MethodGets the postback value of the specified cell on the active sheet in the Spread component.  
Public Methodstatic (Shared in Visual Basic)Overloaded. Gets an array of sheet names from the specified Excel file from a stream.  
Public MethodGets the image in the component.  
Public MethodGets the merged cell range at the specified cell.  
Public MethodGets the merged cell ranges in the specified range.  
Public MethodReturns the page index the specified row is rendered in.  
Public MethodOverloaded.  (Inherited from System.Web.UI.Control)
Public MethodReturns the client row index for the specified row.  
Public MethodGets the text of the sheet name tab at the specified sheet in the Spread component.  
Public Method (Inherited from System.Web.UI.Control)
Public MethodAttempts to find values for one cell that will produce the desired formula result in another cell.  
Public MethodScrolls through the sheet in the component to the specified page.  
Public Method (Inherited from System.Web.UI.Control)
Public MethodOverloaded. Opens the specified file and determines whether it meets the minimal requirements to be considered an Excel file.  
Public MethodOverloaded. Opens the specified file and determines whether it meets the minimal requirements to be considered an Excel-compatible stream.  
Public MethodDetermines whether the component is under strict standards-compliant mode.  
Public MethodLoads formulas that are deserialized, but not parsed yet, to be used after all sheets have been created and deserialized.  
Public Method (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodOverloaded. Opens a saved Spread XML file and loads it into the Spread component.  
Public MethodOverloaded. Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.  
Public MethodForces spread to recreate its content.  
Public MethodResets the Spread component to its default values, removing all settings and all sheets.  
Public Method (Inherited from System.Web.UI.Control)
Public Method (Inherited from System.Web.UI.Control)
Public MethodOverloaded. Saves the contents of the Spread component to XML in the specified file.  
Public MethodSaves the changes to the Spread component.  
Public MethodOverloaded. Saves the contents of the Spread component to the specified Excel file in a stream.  
Public MethodOverloaded. Saves the contents of the Spread component to a Response object in Excel file format with default settings.  
Public MethodOverloaded. Handles the export (or printing) of the specified sheet to PDF as a stream.  
Public MethodOverloaded. Saves the contents of the Spread component to a Response object in PDF file format.  
Public MethodOverloaded. Searches the text in the cells in the specified sheet for the specified string with the specified criteria.  
Public MethodOverloaded. Searches the text in the header cells in the specified sheet for the specified string with the specified criteria.  
Public MethodSets the custom image in the specified part of the Spread component interface.  
Public MethodChanges the protect structure setting with the password parameter.  
Public MethodTests to see if the value is valid for a cell in the active sheet in the Spread component.  
Top
Protected Methods
 NameDescription
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected MethodOverridden. Creates the child controls.  
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.WebControls.WebControl)
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected MethodGroups the rows in the specified column.  
Protected Method (Inherited from System.Web.UI.Control)
Protected Method (Inherited from System.Web.UI.Control)
Protected MethodOverridden. Loads the view state of the Spread component.  
Protected MethodMoves the column from one location to another as specified.  
Protected MethodMoves the row from one location to another as specified.  
Protected Method (Inherited from System.Web.UI.Control)
Protected MethodRaises the MenuItemClicked event.  
Protected MethodOverloaded. Processes the PrintPDF command in the Spread component.  
Protected MethodProcesses the SaveExcel command in the Spread component.  
Protected MethodRaises the TouchStripItemClicked event.  
Protected MethodRearranges the order of grouping based on the movement of the specified column.  
Protected MethodRemoves the grouping for the specified column and moves the column to the specified location.  
Protected MethodOverridden. Renders the Spread component in HTML.  
Protected MethodOverridden. Outputs the content of a server control's children to a provided System.Web.UI.HtmlTextWriter object, which writes the content to be rendered on the client.  
Protected Method (Inherited from System.Web.UI.Control)
Protected MethodOverridden. Saves the view state of the component.  
Protected Method (Inherited from System.Web.UI.Control)
Protected MethodOverridden. Invokes child IStateManager object TrackViewState() method to start tracking.  
Protected MethodUpdates the column width and the row height.  
Top
Public Events
 NameDescription
Public EventOccurs when the user sets the operation mode to row mode and moves the focus to a new row.  
Public EventOccurs when the user changes the active sheet.  
Public EventOccurs when the data model aggregates.  
Public EventOccurs when the user is done filtering.  
Public EventOccurs when the user is filtering.  
Public EventOccurs when a user clicks a button cell on a sheet.  
Public EventOccurs when the user clicks the Cancel button on the component.  
Public EventOccurs when the user clicks a cell using the left mouse button.  
Public EventOccurs when the user creates a child sheet.  
Public EventOccurs when the user clicks a cell in the column header using the left mouse button.  
Public EventOccurs when the user clicks on the Create button.  
Public Event (Inherited from System.Web.UI.Control)
Public EventOccurs when the user clicks/touches on the DeleteColumn button on the component and deletes column(s) in the active sheet.  
Public EventOccurs when the user clicks the Delete button on the component.  
Public EventOccurs when the user clicks/touches on the DeleteRow button on the component and deletes row(s) in the active sheet.  
Public Event (Inherited from System.Web.UI.Control)
Public EventOccurs when the user clicks the Edit button on the component.  
Public EventOccurs when the use of a command button causes an error.  
Public EventOccurs before saving Spread to Excel.  
Public EventOccurs when spread creates the group bar.  
Public EventOccurs when the user is done grouping.  
Public EventOccurs when the user is grouping.  
Public EventOccurs when the user clicks/touches on the HideColumn button on the component and hides column(s) in the active sheet.  
Public EventOccurs when the user clicks/touches on the HideRow button on the component and hides row(s) in the active sheet.  
Public Event (Inherited from System.Web.UI.Control)
Public EventOccurs when the user clicks/touches on the InsertColumn button on the component and inserts column(s) in the active sheet.  
Public EventOccurs when the user clicks on the Insert button on the component and inserts a new row in the active sheet.  
Public EventOccurs when the user clicks/touches on the InsertRow button on the component and inserts row(s) in the active sheet.  
Public Event (Inherited from System.Web.UI.Control)
Public EventOccurs when the Spread context menu item is clicked.  
Public Event (Inherited from System.Web.UI.Control)
Public EventOccurs continually as printing occurs in order to give the user the opportunity to discontinue a print job.  
Public EventOccurs before each page is printed.  
Public EventRepresents a defined method that handles the PrintExternalImage event for the Spread component.  
Public EventRepresents a defined method that handles the PrintExternalImageEnd event for the Spread component.  
Public EventOccurs before printing spread to PDF.  
Public EventOccurs when a sheet is printed.  
Public EventOccurs when the user clicks a cell in the row header using the left mouse button.  
Public EventOccurs when the user saves or loads a view state of a sheet.  
Public EventOccurs when the user sorts a column.  
Public EventOccurs when the user changes the top row of a sheet.  
Public EventOccurs when the TouchStrip item is clicked.  
Public EventOccurs when the user is done grouping.  
Public EventOccurs when the user clicks/touches on the UnhideColumn button on the component and un-hides column(s) in the active sheet.  
Public EventOccurs when the user clicks/touches on the UnhideRow button on the component and un-hides row(s) in the active sheet.  
Public Event (Inherited from System.Web.UI.Control)
Public EventOccurs when the user clicks the Update button on the component.  
Top
See Also

Reference

FpSpread Class
FarPoint.Web.Spread Namespace

User-Task Documentation

Customizing the Appearance of the Overall Control
Customizing the Interaction of the Overall Component
Customizing Interaction Based on Events