Spread ASP.NET 6.0 Product Documentation
FpSpread Class Members
See Also Fields Properties Methods Events Send Feedback

	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 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.

	Name	Description
	About	Gets the read-only string containing version information about the Spread component.
	AccessKey	Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
	ActiveSheetView	Gets the currently selected sheet for the Spread component.
	ActiveSheetViewIndex	Gets or sets the currently selected sheet in the Spread component.
	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.
	AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl object that contains this control. (Inherited from System.Web.UI.Control)
	Attributes	Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from System.Web.UI.WebControls.WebControl)
	BackColor	Overridden. 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.
	BorderColor	Gets or sets the border color of the Web control. (Inherited from System.Web.UI.WebControls.WebControl)
	BorderStyle	Gets or sets the border style of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
	BorderWidth	Gets or sets the border width of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
	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 resize the spread automtic.
	ClientID	Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from System.Web.UI.Control)
	ClientIDMode	Gets or sets the algorithm that is used to generate the value of the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
	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.
	Controls	Overridden. Gets the controls.
	ControlStyle	Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
	ControlStyleCreated	Gets a value indicating whether a System.Web.UI.WebControls.Style object has been created for the System.Web.UI.WebControls.WebControl.ControlStyle property. This property is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
	CssClass	Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from System.Web.UI.WebControls.WebControl)
	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.
	DragColumnCssClass	Gets or sets the CSS class for the column 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 JavaScripts for up-level browsers.
	EnableCrossSheetReference	Gets or sets whether to enable cross-sheet referencing for the Spread component.
	Enabled	Gets or sets a value indicating whether the Web server control is enabled. (Inherited from System.Web.UI.WebControls.WebControl)
	EnableTheming	Gets or sets a value indicating whether themes apply to this control. (Inherited from System.Web.UI.WebControls.WebControl)
	EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from System.Web.UI.Control)
	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.
	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 Groupbar.
	GroupingPolicy	Gets or sets grouping policy to collapse or expand rows when grouping occurs.
	HasAttributes	Gets a value indicating whether the control has attributes set. (Inherited from System.Web.UI.WebControls.WebControl)
	Height	Gets or sets the height of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
	HierarchicalView	Gets or sets whether to display the child sheets in the Spread component hierarchically.
	HierBar	Gets the hierarchy bar information for the component.
	HorizontalScrollBarPolicy	Gets or sets whether and how the Spread component displays the horizontal scroll bar.
	ID	Gets or sets the programmatic identifier assigned to the server control. (Inherited from System.Web.UI.Control)
	IsPrint	Determines whether the FarPoint component creates the print output.
	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.
	NamedStyles	Gets a collection of styles for the Spread component.
	NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same System.Web.UI.Control.ID property value. (Inherited from System.Web.UI.Control)
	Page	Gets a reference to the System.Web.UI.Page instance that contains the server control. (Inherited from System.Web.UI.Control)
	Pager	Gets the page navigation information for the component.
	Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from System.Web.UI.Control)
	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.
	RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from System.Web.UI.Control)
	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 don't 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.
	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/column are selected.
	Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from System.Web.UI.Control)
	SkinID	Gets or sets the skin to apply to the control. (Inherited from System.Web.UI.WebControls.WebControl)
	Style	Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
	SupportsDisabledAttribute	Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's System.Web.UI.WebControls.WebControl.IsEnabled property is false. (Inherited from System.Web.UI.WebControls.WebControl)
	Tab	Gets the sheet name tab information for the component.
	TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from System.Web.UI.Control)
	TemplateSourceDirectory	Gets the virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl that contains the current server control. (Inherited from System.Web.UI.Control)
	TitleInfo	Gets the title information.
	ToolTip	Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
	UIVirtualization	Gets or sets whether to use UI virtualization.
	UniqueID	Gets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
	UseClipboard	Gets or sets whether to access the Clipboard with client-side scripting.
	VerticalScrollBarPolicy	Gets or sets whether and how the Spread component displays the vertical scroll bar.
	ViewStateMode	Gets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control)
	Visible	Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from System.Web.UI.Control)
	WaitMessage	Gets or sets the Wait Message for load on demand.
	Width	Gets or sets the width of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)

	Name	Description
	Adapter	Gets the browser-specific adapter for the control. (Inherited from System.Web.UI.Control)
	ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from System.Web.UI.Control)
	ClientIDSeparator	Gets a character value representing the separator character used in the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
	Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from System.Web.UI.Control)
	HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from System.Web.UI.Control)
	IdSeparator	Gets the character used to separate control identifiers. (Inherited from System.Web.UI.Control)
	IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from System.Web.UI.Control)
	LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by System.Web.UI.Control.ID instead of index. (Inherited from System.Web.UI.Control)
	TagKey	Gets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
	TagName	Gets the name of the control tag. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
	ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from System.Web.UI.Control)
	ViewStateIgnoresCase	Gets a value that indicates whether the System.Web.UI.StateBag object is case-insensitive. (Inherited from System.Web.UI.Control)

	Name	Description
	ApplyStyle	Copies 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)
	ApplyStyleSheetSkin	Applies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
	CancelEdit	Discards the editing values in the Spread component.
	CopyBaseAttributes	Copies 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)
	DataBind	Overloaded. Overridden. Binds a data source to the Spread component.
	FindControl	Overloaded. Finds the control.
	Focus	Sets input focus to a control. (Inherited from System.Web.UI.Control)
	GetColumnIndex	Returns the client column index for the specified column.
	GetEditValue	Gets the postback value of the specified cell on the active sheet in the Spread component.
	GetExcelSheetNames	Overloaded. Gets an array of sheet names from the specified Excel file from a stream.
	GetImage	Gets the image in the component.
	GetMergeCell	Gets the merged cell range at the specified cell.
	GetMergeCells	Gets the merged cell ranges in the specified range.
	GetPageIndex	Returns the page index the specified row is rendered.
	GetRouteUrl	Overloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
	GetRowIndex	Returns the client row index for the specified row.
	GetTabText	Gets the text of the sheet name tab at the specified sheet in the Spread component.
	GetUniqueIDRelativeTo	Returns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
	GoalSeek	Attempt to find value for one cell that will produce desired formula result in another cell.
	GotoPage	Scrolls through the sheet in the component to the specified page.
	HasControls	Determines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
	IsExcelFile	Overloaded. Opens the specified file and determines whether it meets the minimal requirements to be considered an Excel file.
	IsExcelStream	Overloaded. Opens the specified file and determines whether it meets the minimal requirements to be considered an Excel-compatible stream.
	IsStrictMode	Determines whether the component is under strict standards-compliant mode.
	LoadFormulas	Loads formulas that are deserialized but not parsed yet, to be used after all sheets have been created and deserialized.
	MergeStyle	Copies 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)
	Open	Overloaded. Opens a saved Spread XML file and loads it into the Spread component.
	OpenExcel	Overloaded. Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.
	RecreateControl	Force spread to recreate its content.
	Reset	Resets the Spread component to its default values, removing all settings and all sheets.
	ResolveClientUrl	Gets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
	ResolveUrl	Converts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
	Save	Overloaded. Saves the contents of the Spread component to XML in the specified file.
	SaveChanges	Saves the changes to the Spread component.
	SaveExcel	Overloaded. Saves the contents of the Spread component to the specified Excel file in a stream.
	SaveExcelToResponse	Overloaded. Saves the contents of the Spread component to a Response object in Excel file format with default settings.
	SavePdf	Overloaded. Handles the export (or printing) of all the sheets to PDF as a file.
	SavePdfToResponse	Overloaded. Saves the contents of the Spread component to a Response object in PDF file format.
	Search	Overloaded. Searches the text in the cells in the specified sheet for the specified string with the specified criteria.
	SearchHeaders	Overloaded. Searches the text in the header cells in the specified sheet for the specified string with the specified criteria.
	SetImage	Sets the custom image in the specified part of the Spread component interface.
	Validate	Tests to see if the value is valid for a cell in the active sheet in the Spread component.

	Name	Description
	ClearCachedClientID	Sets the cached System.Web.UI.Control.ClientID value to null. (Inherited from System.Web.UI.Control)
	ClearChildControlState	Deletes the control-state information for the server control's child controls. (Inherited from System.Web.UI.Control)
	ClearChildState	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
	ClearChildViewState	Deletes the view-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
	ClearEffectiveClientIDMode	Sets 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)
	CreateChildControls	Overridden. Creates the child controls.
	CreateControlCollection	Creates 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)
	CreateControlStyle	Creates 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)
	DataBindChildren	Binds a data source to the server control's child controls. (Inherited from System.Web.UI.Control)
	EnsureChildControls	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from System.Web.UI.Control)
	EnsureID	Creates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
	GetDesignModeState	Gets design-time data for a control. (Inherited from System.Web.UI.Control)
	Group	Groups the rows in the specified column.
	HasEvents	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from System.Web.UI.Control)
	IsLiteralContent	Determines if the server control holds only literal content. (Inherited from System.Web.UI.Control)
	LoadViewState	Overridden. Loads the view state of the Spread component.
	MoveColumn	Moves the column from one location to another as specified.
	OnBubbleEvent	Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from System.Web.UI.Control)
	OnPrintPDF	Processes the PrintPDF command in the Spread component.
	Regroup	Rearrange the order of grouping based on the movement of the specified column.
	RemoveGroup	Removes the grouping for the specified column and moves the column to the specified location.
	Render	Overridden. Renders the Spread component in HTML.
	ResolveAdapter	Gets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
	SaveViewState	Overridden. Saves the view state of the component.
	SetDesignModeState	Sets design-time data for a control. (Inherited from System.Web.UI.Control)
	TrackViewState	Causes the control to track changes to its view state so they can be stored in the object's System.Web.UI.Control.ViewState property. (Inherited from System.Web.UI.WebControls.WebControl)
	UpdateView	Updates the column width and the row height.

	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 aggregate.
	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.
	DataBinding	Occurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
	DeleteCommand	Occurs when the user clicks the Delete button on the component.
	Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
	EditCommand	Occurs when the user clicks the Edit button on the component.
	ErrorCommand	Occurs when the use of a command button causes an error.
	FetchGroupText	Occurs when spread creates the groupbar.
	Grouped	Occurs when the user is done grouping.
	Grouping	Occurs when the user is grouping.
	Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
	InsertCommand	Occurs when the user clicks on the Insert button on the component and inserts a new row in the active sheet.
	Load	Occurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control)
	PreRender	Occurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
	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 print 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.
	Ungrouped	Occurs when the user is done grouping.
	Unload	Occurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
	UpdateCommand	Occurs when the user clicks the Update button on the component.

Public Constructors

Public Fields

Public Properties

Protected Properties

Public Methods

Protected Methods

Public Events

See Also

Reference

User-Task Documentation