Spread ASP.NET 18
FarPoint.Web.Spread Assembly / FarPoint.Web.Spread Namespace / FpSpread Class


In This Topic
    FpSpread Class Methods
    In This Topic

    For a list of all members of this type, see FpSpread members.

    Public Methods
     NameDescription
    Public MethodApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Public MethodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
    Public MethodCancelEditDiscards the editing values in the Spread component.  
    Public MethodCopyBaseAttributesCopies the properties not encapsulated by the System.Web.UI.WebControls.WebControl.Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Public MethodDataBindOverloaded. Overridden. Binds a data source to the Spread component.  
    Public Methodstatic (Shared in Visual Basic)FindControlOverloaded. Finds the control.  
    Public MethodFocusSets input focus to a control. (Inherited from System.Web.UI.Control)
    Public MethodGetColumnIndexReturns the client column index for the specified column.  
    Public MethodGetEditValueGets the postback value of the specified cell on the active sheet in the Spread component.  
    Public Methodstatic (Shared in Visual Basic)GetExcelSheetNamesOverloaded. Gets an array of sheet names from the specified Excel file.  
    Public MethodGetImageOverloaded. Gets the image in the component.  
    Public MethodGetMergeCellGets the merged cell range at the specified cell.  
    Public MethodGetMergeCellsGets the merged cell ranges in the specified range.  
    Public MethodGetPageIndexReturns the page index the specified row is rendered in.  
    Public MethodGetRouteUrlOverloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
    Public MethodGetRowIndexReturns the client row index for the specified row.  
    Public MethodGetTabTextGets the text of the sheet name tab at the specified sheet in the Spread component.  
    Public MethodGetUniqueIDRelativeToReturns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
    Public MethodGoalSeekAttempts to find values for one cell that will produce the desired formula result in another cell.  
    Public MethodGotoPageScrolls through the sheet in the component to the specified page.  
    Public MethodHasControlsDetermines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
    Public MethodIsExcelFileOverloaded. Opens the specified file and determines whether it meets the minimal requirements to be considered an Excel file.  
    Public MethodIsExcelStreamOverloaded. Opens the specified file and determines whether it meets the minimal requirements to be considered an Excel-compatible stream.  
    Public MethodIsStrictModeDetermines whether the component is under strict standards-compliant mode.  
    Public MethodLoadFormulasLoads formulas that are deserialized, but not parsed yet, to be used after all sheets have been created and deserialized.  
    Public MethodMergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Public MethodOpenOverloaded. Opens a saved Spread XML file and loads it into the Spread component.  
    Public MethodOpenExcelOverloaded. Opens an Excel file and loads it into the Spread component.  
    Public MethodRecreateControlForces spread to recreate its content.  
    Public Methodstatic (Shared in Visual Basic)RegisterCssReference  
    Public MethodRegisterExternalScriptBlockOverloaded. Registers the external script block that is loaded by Spread after each Ajax call.  
    Public MethodRegisterExternalStartupScriptBlockRegisters the external startup script block that is executed by Spread after each Ajax call.  
    Public Methodstatic (Shared in Visual Basic)RemoveReadOnlyMsgFromControlCollectionRemove the internal _readOnlyErrorMesg field of the ControlCollection class that throws an exception each time Spread tries to add a control to the collection.  
    Public MethodRenderWebPartRenders the spreadsheet component to the specified HtmlTextWriter object; for use in the RenderWebPart method of a Web part object.  
    Public MethodResetResets the Spread component to its default values, removing all settings and all sheets.  
    Public MethodResolveClientUrlGets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
    Public MethodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
    Public Methodstatic (Shared in Visual Basic)RestoreReadOnlyMsgFromControlCollectionRestores the internal _readOnlyErrorMesg field of the ControlCollection class.  
    Public MethodResumeCheckProtectedStructureResume check the protected structure  
    Public MethodSaveOverloaded. Saves the contents of the Spread component to XML in the specified file.  
    Public MethodSaveChangesSaves the changes to the Spread component.  
    Public MethodSaveExcelOverloaded. Saves the contents of the Spread component to the specified Excel file in a stream.  
    Public MethodSaveExcelToResponseOverloaded. Saves the contents of the Spread component to a Response object in Excel file format with default settings.  
    Public MethodSavePdfOverloaded. Handles the export (or printing) of all the sheets to PDF as a file.  
    Public MethodSavePdfToResponseOverloaded. Saves the contents of the Spread component to a Response object in PDF file format.  
    Public MethodSearchOverloaded. Searches the text in the cells in the specified sheet for the specified string with the specified criteria.  
    Public MethodSearchHeadersOverloaded. Searches the text in the header cells in the specified sheet for the specified string with the specified criteria.  
    Public MethodSetImageOverloaded. Sets the custom image in the specified part of the Spread component interface.  
    Public MethodSetProtectChanges the protect structure setting with the password parameter.  
    Public MethodSetTraceDataOverloaded. Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from System.Web.UI.Control)
    Public MethodSuspendCheckProtectedStructureSuspend from check the protected structure  
    Public MethodValidateTests to see if the value is valid for a cell in the active sheet in the Spread component.  
    Top
    Protected Methods
     NameDescription
    Protected MethodAfterSaveToSessionInternal use only.  
    Protected MethodBeforeCallLoadViewStateOfBaseInternal use only.  
    Protected MethodBeforeLoadFromSessionInternal use only.  
    Protected MethodBeginRenderTracingBegins design-time tracing of rendering data. (Inherited from System.Web.UI.Control)
    Protected MethodClearCachedClientIDSets the cached System.Web.UI.Control.ClientID value to a null reference (Nothing in Visual Basic). (Inherited from System.Web.UI.Control)
    Protected MethodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from System.Web.UI.Control)
    Protected MethodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
    Protected MethodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
    Protected MethodClearEffectiveClientIDModeSets the System.Web.UI.Control.ClientIDMode property of the current control instance and of any child controls to System.Web.UI.ClientIDMode.Inherit. (Inherited from System.Web.UI.Control)
    Protected MethodCreateChildControlsOverridden. Creates the child controls.  
    Protected MethodCreateControlCollectionCreates a new System.Web.UI.ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from System.Web.UI.Control)
    Protected MethodCreateControlStyleCreates the style object that is used internally by the System.Web.UI.WebControls.WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
    Protected MethodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from System.Web.UI.Control)
    Protected MethodEndRenderTracingEnds design-time tracing of rendering data. (Inherited from System.Web.UI.Control)
    Protected MethodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from System.Web.UI.Control)
    Protected MethodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
    Protected MethodFireInitInternalInternal use only.  
    Protected MethodGetDesignModeStateGets design-time data for a control. (Inherited from System.Web.UI.Control)
    Protected MethodGetExcelFileContentInternal use only.  
    Protected MethodGetIEVersionInternal use only.  
    Protected MethodGetPage_PreRenderCompleteEventHandlerInternal use only.  
    Protected MethodGetPdfFileResultOverloaded. Internal use only  
    Protected MethodGroupGroups the rows in the specified column.  
    Protected MethodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from System.Web.UI.Control)
    Protected MethodIsLiteralContentDetermines if the server control holds only literal content. (Inherited from System.Web.UI.Control)
    Protected MethodLoadViewStateOverridden. Loads the view state of the Spread component.  
    Protected MethodMoveColumnMoves the column from one location to another as specified.  
    Protected MethodMoveRowMoves the row from one location to another as specified.  
    Protected MethodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from System.Web.UI.Control)
    Protected MethodOnMenuItemClickedRaises the MenuItemClicked event.  
    Protected MethodOnPrintPDFOverloaded. Processes the PrintPDF command in the Spread component.  
    Protected MethodOnSaveExcelProcesses the SaveExcel command in the Spread component.  
    Protected MethodOnTouchStripItemClickedRaises the TouchStripItemClicked event.  
    Protected MethodRegisterRequiresPostBackInternal use only  
    Protected MethodRegroupRearranges the order of grouping based on the movement of the specified column.  
    Protected MethodRemoveGroupRemoves the grouping for the specified column and moves the column to the specified location.  
    Protected MethodRenderOverridden. Renders the Spread component in HTML.  
    Protected MethodRenderChildrenOverridden. 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 MethodResetRequiresPostBackInternal use only.  
    Protected MethodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
    Protected MethodSaveViewStateOverridden. Saves the view state of the component.  
    Protected MethodSetDesignModeStateSets design-time data for a control. (Inherited from System.Web.UI.Control)
    Protected MethodTrackViewStateOverridden. Invokes child IStateManager object TrackViewState() method to start tracking.  
    Protected MethodUpdateViewUpdates the column width and the row height.  
    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