Spread ASP.NET 18
Demos
Blog
Support
Pricing
Download
Spread ASP.NET 18
Spread for ASP.NET 18 Product Documentation
/
Client-Side Scripting Reference
/
Scripting Members
/ Classes
Collapse All
Expand All
In This Topic
Spread for ASP.NET 18 Product Documentation
Developer's Guide
Getting Started
Handling Installation
Installing the Product
Licensing a Trial Project after Installation
End-User License Agreement
Creating a Build License
Handling Redistribution
Product Requirements
Handling Variations In Windows Settings
Working with the Component
Adding a Component to a Web Site using Visual Studio 2019
Adding a Component to a Web Site using Visual Studio 2015 or 2017
Adding JavaScript IntelliSense for Visual Studio 2015 or 2017
Understanding Browser Support
Understanding Parts of the Component Interface
Working with Collection Editors
Working with Web Parts
Working with Windows Azure
Working with Microsoft ASP.NET MVC 5
Working with Microsoft ASP.NET MVC 3
Copying Shared Assemblies to Local Folder
Working with Strongly Typed Data Controls
Getting More Practice
Understanding Procedures in the Documentation
Getting Technical Support
Understanding the Spread Wizard
Starting the Spread Wizard
Using the Spread Wizard
Tutorial: Creating a Checkbook Register
Adding Spread to the Checkbook Project
Adding Spread to a Project
Setting Up the Rows and Columns of the Register
Setting the Cell Types of the Register
Adding Formulas to Calculate Balances
Understanding the Product
Product Overview
Features Overview
AJAX Support
ASP.NET AJAX Extenders
Built-In Functions
Cell Types
Chart Control
Client-Side Scripting
Conditional Formatting
Context Menu
Corner Customization
Customized Appearance (Skins)
Data Binding
Floating Images
Footers for Columns or Groups
Formula Extender Control
Frozen Rows and Columns
Goal Seeking
Grouping
Headers with Multiple Columns and Rows
Hierarchical Display
Import and Export Capabilities
Load on Demand
Multiple-Line Columns
Multiple Sheets
PDF Support
Printing
Row Filtering
Row Preview
Row Template Editor
Searching Features
Sorting Capabilities
Spannable Cells
Sparklines
Spread Designer
Spread Wizard
Theme Roller
Title and Subtitle
Touch Support
Validation Controls
Concepts Overview
Shortcut Objects
Object Parentage
Underlying Models
Cell Types
SheetView versus FpSpread
Formatted versus Unformatted Data
Zero-Based Indexing
Client-Side Scripting
Maintaining State
Namespaces Overview
Working with the Spread Designer
Starting the Spread Designer
Understanding the Spread Designer Interface
Spread Designer Menus
File Menu
Home Menu
Insert Menu
Data Menu
View Menu
Settings Menu
Chart Tools Menu
Sparklines Menu
Spread Designer Toolbars
Spread Designer Editors
Alternating Rows Editor
Cells, Columns, and Rows Editor
ContextMenu Collection Editor
DataKey Names (String Collection) Editor
Formula Editor
GroupInfo Collection Editor
Header Editor
NamedStyle Collection Editor
Row Template Editor
SheetSkin Editor
SheetView Collection Editor
Spread Designer Context Menus
Using the Spread Designer
Customizing Sheets, Rows, and Columns in Spread Designer
Customizing Cells in Spread Designer
Adding Formulas to Cells
Saving and Opening Design Files
Applying Changes and Closing Spread Designer
Customizing User Interaction
Customizing Interaction with the Overall Component
Displaying Scroll Bars
Displaying Scroll Bar Text Tips
Customizing the Scroll Bar Colors
Allowing Load on Demand
Customizing Interaction Based on Events
Handling the Tab Key
Customizing the Graphical Interface
Searching for Data with Code
Adding a Context Menu
Using the Formula Extender Control
Working with AJAX
Enabling AJAX support
Using ASP.NET AJAX Extenders
Customizing the Toolbars
Customizing the Command Bar on the Component
Customizing the Command Buttons
Changing the Command Button Images
Hiding a Specific Command Button
Working with the SaveExcel button on the CommandBar
Displaying the Sheet Names
Customizing Page Navigation
Customizing Page Navigation Buttons on the Client
Customizing the Hierarchy Bar
Customizing Interaction with Rows and Columns
Allow the User to Move Columns
Allowing the User to Move Rows
Allowing the User to Resize Rows or Columns
Freezing Rows and Columns
Setting up Row Edit Templates
Setting up Preview Rows
Managing Filtering of Rows of User Data
Creating Filtered Rows and Setting the Appearance
Customizing Simple Filtering of Rows of User Data
Using Row Filtering
Customizing the List of Filter Items
Creating a Completely Custom Filter
Using Enhanced Filtering
Using the Filter Bar
Customizing Grouping of Rows of User Data
Using Grouping
Allowing the User to Group Rows
Setting the Appearance of Grouped Rows
Customizing the Group Bar
Creating a Custom Group
Compatibility with Other Features
Customizing Sorting of Rows of User Data
Allowing User Sorting
Customizing Interaction with Cells
Adding a Note to a Cell
Adding a Tag to a Cell
Locking a Cell
Using Conditional Formatting in Cells
Creating Conditional Formatting with Rules
Color Scale Rules
Data Bar Rule
Highlighting Rules
Icon Set Rule
Top or Average Rules
Conditional Formatting of Cells
Customizing Selections of Cells
Specifying What the User Can Select
Working with Selections of Cells
Customizing the Appearance of Selections
Managing Printing
Printing a Spreadsheet
Adding Headers and Footers to Printed Pages
Customizing the Appearance
Customizing the Appearance of the Overall Component
Customizing the Dimensions of the Component
Customizing the Outline of the Component
Customizing the Default Initial Appearance
Resetting Parts of the Interface
Using the jQuery Theme Roller with Spread
Customizing the Appearance of the Sheet
Working with the Active Sheet
Working with Multiple Sheets
Adding a Sheet
Removing a Sheet
Showing or Hiding a Sheet
Setting the Background Color of the Sheet
Adding a Title and Subtitle to a Sheet
Customizing the Page Size (Rows to Display)
Displaying Grid Lines on the Sheet
Customizing the Sheet Corner
Displaying a Footer for Columns or Groups
Adding an Image to the Sheet
Creating a Skin for Sheets
Applying a Skin to a Sheet
Customizing the Appearance of Rows and Columns
Customizing the Number of Rows or Columns
Adding a Row or Column
Removing a Row or Column
Showing or Hiding Rows or Columns
Setting the Row Height or Column Width
Setting the Top Row to Display
Creating Alternating Rows
Creating Row Templates (Multiple-Line Columns)
Customizing the Appearance of Headers
Customizing the Style of Header Cells
Showing or Hiding Headers
Customizing the Default Header Labels
Customizing Header Label Text
Setting the Size of Header Cells
Customizing the Header Empty Areas
Creating a Header with Multiple Rows or Columns
Creating a Span in a Header
Customizing the Appearance of a Cell
Working with the Active Cell
Customizing the Colors of a Cell
Aligning Cell Contents
Customizing Cell Borders
Customizing the Margins and Spacing of the Cell
Creating and Applying a Custom Style for Cells
Assigning a Cascading Style Sheet to a Cell
Creating a Range of Cells
Spanning Cells
Allowing Cells to Merge Automatically
Using Sparklines
Adding a Sparkline to a Cell
Customizing Markers and Pointers
Specifying Horizontal and Vertical Axes
Working with Sparklines
Customizing with Cell Types
Understanding How Cell Types Work
Understanding Cell Type Basics
Understanding How Cell Types Display Data
Understanding How Cell Type Affects Model Data
Determining the Cell Type of a Cell
Working with Editable Cell Types
Setting a Currency Cell
Limiting Values for a Currency Cell
Setting a Date-Time Cell
Displaying a Calendar in a Date-Time Cell
Displaying a Number Pad in Number Cells
Setting a Double Cell
Setting a General Cell
Setting an Integer Cell
Setting a Percent Cell
Setting a Regular Expression Cell
Setting a Text Cell
Working with Graphical Cell Types
Setting a Button Cell
Setting a Check Box Cell
Setting a Combo Box Cell
Setting a Hyperlink Cell
Setting an Image Cell
Setting a Label Cell
Setting a List Box Cell
Setting a Multiple-Column Combo Box Cell
Setting a Radio Button List Cell
Setting a Tag Cloud Cell
Working with ASP.NET AJAX Extender Cell Types
Setting an Automatic-Completion Cell
Setting a Calendar Cell
Setting a Combo Box Cell
Setting a Filtered Text Cell
Setting a Masked Edit Cell
Setting a Mutually Exclusive Check Box Cell
Setting a Numeric Spin Cell
Setting a Rating Cell
Setting a Slider Cell
Setting a Slide Show Cell
Setting a Text Box with Watermark Cell
Using Validation Controls
Managing Data Binding
Data Binding Overview
Binding to a Data Source
Binding to a Range
Model Data Binding in ASP.NET 4.5
Setting the Cell Types for Bound Data
Displaying Data as a Hierarchy
Handling Row Expansion
Adding an Unbound Row
Limiting Postbacks When Updating Bound Data
Tutorial: Binding to a Corporate Database
Managing Data in the Component
Saving Data to the Server
Placing and Retrieving Data
Handling Data Using Sheet Methods
Handling Data Using Cell Properties
Server-Side Scripting
Understanding Effects of Client-Side Validation
Understanding Postback and Page Load Events
Understanding the Effect of Mode on Events
Managing Formulas
Setting Calculation Culture
Placing a Formula in Cells
Specifying a Cell Reference Style in a Formula
Using a Circular Reference in a Formula
Nesting Functions in a Formula
Finding a Value with Goal Seeking
Recalculating and Updating Formulas Automatically
Creating a Custom Function
Creating a Custom Name
Using the Formula Extender Control
Managing File Operations
Saving Data to a File
Saving to a Spread XML File
Saving to an Excel File
Saving to a Text File
Saving to an HTML File
Saving to a PDF File
Saving to PDF Methods
Setting PDF Security Options
Setting PrintInfo Class Properties
Setting Smart Print Options
Setting Headers and Footers
Opening Existing Files
Opening a Spread XML File
Opening an Excel-Formatted File
Opening a Text File
Using Sheet Models
Understanding the Models
Understanding How the Models Work
Customizing Models
Understanding the Axis Model
Understanding the Data Model
Understanding the Selection Model
Understanding the Span Model
Understanding the Style Model
Understanding the Optional Interfaces
Creating a Custom Sheet Model
Maintaining State
State Overview
Saving Data to the View State
Saving Data to the Session State
Saving Data to an SQL Database
Loading Data for Each Page Request
Working with the Chart Control
Understanding and Customizing Charts
Chart User Interface Elements
Chart Types and Views
Plot Types
Y PlotTypes
Area Charts
Bar Charts
Box Whisker Charts
Funnel Charts
Histogram Charts
Line Charts
Market Data (High-Low) Charts
Pareto Charts
Point Charts
Stripe Charts
Waterfall Charts
XY Plot Types
Bubble Charts
Line Charts
Point Charts
Stripe Charts
XYZ Plot Types
Point Charts
Line Charts
Surface Charts
Stripe Charts
Pie Plot Types
Doughnut Charts
Pie Charts
Polar Plot Types
Point Charts
Line Charts
Area Charts
Stripe Charts
Radar Plot Types
Point Charts
Line Charts
Area Charts
Stripe Charts
Data Plot Types
Series
Walls
Axis and Other Lines
Fill Effects
Elevation and Rotation
Lighting, Shapes, and Borders
Size - Height, Width, and Depth
Labels
Legends
Creating Charts
Creating Plot Types
Creating a Y Plot
Creating an XY Plot
Creating an XYZ Plot
Creating a Pie Plot
Creating a Polar Plot
Creating a Radar Plot
Creating a Sunburst Chart
Creating a Treemap Chart
Combining Plot Types
Connecting to Data
Using a Bound Data Source
Using an Unbound Data Source
Using Raw Data Versus Represented Data
Using the Chart Designer
Opening the Chart Designer
Creating a Chart Control
Using the Chart Collection Editors
LabelArea Collection Editor
LegendArea Collection Editor
PlotArea Collection Editor
Light Collection Editor
Series Collection Editor
Using the Spread Designer
Using the Chart Control
Creating the Chart Control
Rendering or Saving the Chart Control to an Image
Loading or Saving the Chart Control to XML
Using the Chart Control in Spread
Creating the Chart Control with Code
Binding the Chart Control with Spread
Moving and Resizing the Chart Control in Spread
Selecting the Chart Control in Spread
Setting the Chart Control Border in Spread
Setting the Chart View Type
Using the Chart Context Menu
Using Touch Support with the Component
Understanding Touch Support
Understanding Touch Gestures
Using Touch Support
Using the Touch Menu Bar
Using Touch Support with AutoFit
Using Touch Support with Charts
Using Touch Support with Editable Cells
Using Touch Support with Filtering
Using Touch Support with Grouping
Using Touch Support when Moving Columns
Using Touch Support when Moving Rows
Using Touch Support when Resizing Columns or Rows
Using Touch Support with Scrolling
Using Touch Support with Selections
Using Touch Support with Sorting
Assembly Reference
FarPoint.CalcEngine Assembly
FarPoint.Excel Assembly
FarPoint.Web.Chart Assembly
FarPoint.Web.Spread Assembly
FarPoint.Web.Spread.Extender Assembly
Client-Side Scripting Reference
Scripting Overview
Using Client-Side Scripting
Typical Uses of Scripting
Background on HTC Files and Scripting
Handling Invalid Client-Side Entries
Mapping an Event to a Client-Side Script
Using Attributes
Using a Client Scripting Method
Developing a Custom HTC File
Validating Date on the Client
Formatting Percent Value on the Client
Some Simple Uses of Client Scripting
Getting the Value of a Cell
Doing a Quick Validation Before Postback
Finding the Cell Under the Cursor
Retrieving the Text in Headers
Locking a Column
Scripting Members
Properties
ActiveCol
ActiveRow
TapToAddSelection
Methods
Add
AddKeyMap
AddSelection
CallBack
Cancel
Cells
Clear
ClearSelection
Columns
Copy
CopyLikeExcel
CutLikeExcel
Delete
Edit
EndEdit
ExpandRow
GetActiveChart
GetActiveChildSheetView
GetActiveCol
GetActiveRow
GetCellByRowCol
GetChildSpread
GetChildSpreads
GetColByKey
GetColCount
GetColKeyFromCol
GetCurrentPageIndex
GetFormula
GetHiddenCellValue
GetHiddenValue
GetLeftColIndex
GetLocked
GetPageCount
GetParentRowIndex
GetParentSpread
GetRowByKey
GetRowCount
GetRowKeyFromRow
GetSelectedRange
GetSelectedRanges
GetSheetColIndex
GetSheetRowIndex
GetSpread
GetTitleInfo
GetTopRowIndex
GetTotalRowCount
GetValue
HideMessage
Insert
IsValid
LoadData
MoveToFirstColumn
MoveToLastColumn
MoveToNextCell
MoveToNextRow
MoveToPrevCell
MoveToPrevRow
Next
Paste
PasteLikeExcel
Prev
Print
PrintPDF
RemoveKeyMap
ResumeLayout
Rows
ScrollTo
SetActiveCell
SetActiveChart
SetBackColor
SetColWidth
SetForeColor
SetFormula
SetHiddenCellValue
SetHiddenValue
SetLocked
SetSelectedRange
SetValue
ShowMessage
SizeToFit
SortColumn
StartEdit
SuspendLayout
Update
UpdatePostBackData
Events
ActiveCellChanged
ActiveCellChanging
AutoFilteredColumn
AutoFilteringColumn
CallBackStart
CallBackStopped
CellClicked
CellDoubleClicked
ColumnDragMove
ColumnDragMoveCompleted
ColWidthChanged
ContextMenuClosed
ContextMenuOpened
ContextMenuOpening
CopyData
DataChanged
EditStart
EditStopped
ErrorMessageShown
LoadRowsStart
LoadRowsStopped
MenuClicked
RowDragMove
RowDragMoveCompleted
RowHeightChanged
Scroll
SelectionChanged
TouchStripClosed
TouchStripOpened
TouchStripOpening
Classes
ContextMenu
MenuItem
TouchStrip
TouchStripItem
Import and Export Reference
Excel-Formatted File Import
Chart Settings Imported
Sheet Settings Imported
Row and Column Settings Imported
Cell Settings Imported
Border Styles Substituted
Print Settings Imported
Other Excel Settings Imported
Excel-Formatted File Export
Chart Settings Exported
Sheet Settings Exported
Row and Column Settings Exported
Cell Settings Exported
Cell Type Settings Exported
Print Settings Exported
Colors Exported
Classes
In This Topic
The following table lists the client-side classes.
Class
Summary
ContextMenu
Provides options to disable menu items.
MenuItem
Creates menu items.
TouchStrip
Creates the touch strip.
TouchStripItem
Creates touch strip menu items.
