Spread WinForms 15
Demos
Blog
Support
Pricing
Free Trial
Spread Windows Forms 15.0
FarPoint.Excel Assembly
/
FarPoint.Excel Namespace
/
OfficeArtFSP Class
/ Read Method
Collapse All
Expand All
Language Filter: All
Language Filter: Multiple
Language Filter: Visual Basic
Language Filter: Visual Basic (Declaration)
Language Filter: Visual Basic (Usage)
Language Filter: C#
Visual Basic (Declaration)
Visual Basic (Usage)
C#
In This Topic
Overload List
See Also
Spread Windows Forms 15.0 Product Documentation
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
Using Windows Regional Settings or Options
Using Satellite Assemblies for Languages
Understanding the Spread Wizard
Starting the Spread Wizard
Using the Spread Wizard
Getting More Practice
Finding the Documentation
Getting Technical Support
Tutorial: Creating a Checkbook Register
Adding Spread to the Checkbook Project
Setting Up the Rows and Columns of the Register
Setting the Cell Types of the Register
Adding Formulas to Calculate Balances
Developer's Guide
Understanding the Product
Product Overview
Shortcut Objects
Underlying Models
Formatted versus Unformatted Data
Cell Types
Key Features
Working with the Component
Adding NuGet Package in Spread Windows Forms
Migrate .NET Framework Project to .NET Core 3.1/.NET 5 Platform
Adding a Component to a Visual Studio 2019 Project
Adding a Component to a Visual Studio 2015 or 2017 Project
Adding a Component to a Visual Studio 2013 Project
Setting the Properties
Using Verbs in the Properties Window
Using Smart Tags Drop-Down
Working with Collection Editors
Adding Support for High DPI Settings
Spreadsheet Objects
Understanding Parts of the Component
Object Parentage
Resetting Parts of the Interface
Improving Performance by Suspending the Layout
Ways to Improve Performance
Allowing User Functionality
Allowing the User to Zoom the Display of the Component
Working with Scroll Bars
Customizing the Scroll Bars
Customizing the Position in the Display
Customizing Scroll Bar Tips
Adding a Status Bar
Customizing Viewports
Customizing Split Boxes
Working With Slicers
Sheets
Working with the Active Sheet
Working with Multiple Sheets
Customizing the Sheet Name Tabs
Adding a Sheet
Removing a Sheet
Showing or Hiding a Sheet
Moving a Sheet
Selecting Multiple Sheets
Copying and Inserting a Sheet
Adding a Title and Subtitle to a Sheet
Placing Child Controls on a Sheet
Displaying a Footer for Columns or Groups
Adding a Tag to a Sheet
Working with 1-Based Indexing
Customizing Clipboard Operation Options
Rows and Columns
Customizing the Number of Rows or Columns
Adding a Row or Column
Removing a Row or Column
Showing or Hiding a Row or Column
Setting the Row Height or Column Width
Resizing the Row or Column to Fit the Data
Allowing the User to Resize Rows or Columns
Using Auto Row Height
Setting Fixed (Frozen) Rows or Columns
Moving Rows or Columns
Creating Alternating Rows
Setting up Preview Rows
Input Data in Rows or Columns
Rows or Columns That Have Data
Adding a Tag to a Row or Column
Headers
Understanding Headers
Showing or Hiding Headers
Setting the Height or Width of Header
Setting the Header Text
Customizing Header Label Text
Customizing the Default Header Labels
Customizing the Appearance of Headers
Customizing the Style of Header Cells
Customizing the Header Grid Lines
Adding a Gradient to Header Cells
Auto Expand Row Headers
Creating a Header with Multiple Rows or Columns
Creating a Span in a Header
Customizing the Sheet Corner Appearance
General Style of the Sheet Corner
Text Display in the Sheet Corner
Table Display in the Sheet Corner
Customizable Cell in the Sheet Corner
Cell Spans in the Sheet Corner
Header Count Synchronization in the Sheet Corner
Drawing (Rendering) Style
Cells
Working with the Active Cell
Adding Hyperlink in a Cell
Creating a Range of Cells
Managing Data on a Sheet
Placing and Retrieving Data
Handling Data Using Sheet Methods
Handling Data Using Cell Properties
Moving Data on a Sheet
Copying Data on a Sheet
Repeatedly Filling a Range of Cells with Copied Cells
Swapping Data on a Sheet
Removing Data from a Sheet
Creating Data Type for Custom Objects
Displaying Cell Data
Resizing the Data to Fit the Cell
Allowing Cell Data to Overflow
Aligning Cell Contents
Resizing a Cell to Fit the Data
Creating a Span of Cells
Allowing Cells to Merge Automatically
Adding a Note to a Cell
Adding a Tag to a Cell
Displaying Text Tips in a Cell
Working with Pattern and Gradient Fill Effects
Inserting Cells
Setting Rich Text in a Cell
Adding a Comment to a Cell
Cell Types
Understanding Cell Type Basics
Understanding How Cell Types Work
Understanding How Cell Types Display and Format Data
Understanding How Cell Type Affects Model Data
Working with Editable Cell Types
Setting a General Cell
Setting a Text Cell
Setting a Date-Time Cell
Customizing the Pop-Up Date-Time Control
Setting a GcCharMask Cell
Setting a GcDateTime Cell
Setting a GcMask Cell
Setting a GcNumber Cell
Setting a GcTextBox Cell
Setting a GcTimeSpan Cell
Setting a Number Cell
Setting a Currency Cell
Setting a Mask Cell
Setting a Percent Cell
Setting a Regular Expression Cell
Setting a Rich Text Cell
Working with Graphical Cell Types
Setting a Barcode Cell
Setting a Button Cell
Setting a Check Box Cell
Setting a Color Picker Cell
Setting a Combo Box Cell
Allowing a Combo Box Cell to Handle a Double Click
Setting a Hyperlink Cell
Setting an Image Cell
Setting a List Box Cell
Setting a Multiple-Column Combo Box Cell
Setting a Multiple Option Cell
Setting a Progress Indicator Cell
Setting a Slider Cell
Understanding Additional Features of Cell Types
Allowing the Display of Buttons in a Cell
Displaying Spin Buttons
Limiting Values for a Numeric Cell
Customizing the Pop-Up Calculator Control
Customizing Automatic Completion (Type Ahead)
Working with a SubEditor
Creating a Custom Cell Type
Data Binding
Binding to Data
Binding Spread to an External Data Set
Binding a Cell Range in Spread to an External Data Source
Binding a Cell Range in Spread as a Data Source to an External Control
Binding a Combo Box to a DataReader
Customizing Data Binding
Adding an Unbound Column to a Bound Sheet
Customizing Column and Field Binding
Customizing Cell Types for Bound Sheets
Customizing Column Headers for Bound Sheets
Adding to Bound Data
Adding a Row to a Bound Sheet
Adding an Unbound Row to a Bound Sheet
Working with Hierarchical Data Display
Creating a Hierarchical Display Manually
Creating Custom Hierarchy Icons
Tutorial: Binding to a Corporate Database (Visual Studio 2013 or later)
Customizing the Sheet Appearance
Customizing the Dimensions of the Component
Customizing the Individual Sheet Appearance
Setting the Background Colors for a Sheet
Coloring a Cell
Setting a Background Image for a Sheet
Setting a Background Image to a Cell
Customizing the Appearance of a Cell
Customizing the Outline of the Component
Displaying Grid Lines on a Sheet
Creating and Customizing Cell Borders
Creating a Complex Border with Multiple Lines
Customizing the Overall Component Appearance
Setting the Component to the Original Appearance
Applying a Skin to the Component
Creating a Custom Skin for a Component
Applying a Skin to a Sheet
Creating a Custom Skin for a Sheet
Saving and Loading a Skin
Saving a Skin
Loading a Skin
Creating and Applying a Style for Cells
Using Conditional Formatting of Cells
Creating Conditional Formatting with Rules
Color Scale Rules
Data Bar Rule
Icon Set Rule
Highlighting Rules
Top, Bottom, or Average Rules
Setting up Conditional Formatting of a Cell
Customizing the Display of the Pointer
Customizing the User Interface Images
Using XP Themes with the Component
Customizing the Renderers
Handling Right-to-Left Layouts
Customizing Painting of Parts of the Component
Text Rendering with GDI
Applying Theme to Customize the Appearance
Customizing Interaction in Cells
Using Edit Mode and Focus
Understanding Edit Mode in a Cell
Locking a Cell
Customizing User Selection and Deselection of Data
Specifying What the User Can Select
Customizing the Selection Appearance
Working with Selections
Hiding the Selection When Focus is Lost
Working with Deselections
Using Drag Operations to Fill Cells
Filling Cells with Drag and Drop
Filling Cells with Drag and Fill
Filling Cells with Drag and Move
Using Validation
Using Validation in Cells
Using a Cell Comparison Validator
Using a Character Format Validator
Using a String Comparison Validator
Using a Value Comparison Validator
Using an Encoding Validator
Using the Exclude List Validator
Using the Include List Validator
Using a Pair Validator
Using the Range Validator
Using a Regular Expression Validator
Using a Required Field Validator
Using a Required Type Validator
Using a Surrogate Character Validator
Using a Text Length Validator
Validating User Input
Customizing the User Error Messages
Displaying Error Icons in Cells or Rows
Using Visible Indicators in the Cell
Locating the Pointer Using HitTest
Returning Information for a Clicked Cell
Preventing a Cell from Receiving Focus
Customizing the Focus Indicator for a Cell
Customizing Undo and Redo Actions
Customizing Interaction Based on Events
Adding a Context Menu to a Component
Tables
Adding a Table
Using Table Filters
Resizing a Table
Sorting a Table
Setting Table Styles
Binding a Table
Adding a Table Formula
Understanding Structured References
Using Operators and Special Items
Understanding Structured Reference Syntax Rules
Using Structured References
Understanding the Underlying Models
Finding More Details on the Sheet Models
Understanding the Sheet Model Classes and Interfaces
Understanding the Data Model
Understanding the Axis Model
Understanding the Selection Model
Understanding the Span Model
Understanding the Style Model
Creating a Custom Sheet Model
Understanding the Optional Interfaces
Customizing Row or Column Interaction
Managing Sorting of Rows of User Data
Allowing the User to Automatically Sort Rows
Using Automatic Sorting
Sorting Rows, Columns, or Ranges
Setting the Appearance of Sort Indicators
Managing Cell Range Sorting
Managing Filtering of Rows of User Data
Allowing the User to Filter Rows
Setting the Appearance of Filtered Rows
Customizing Simple Filtering
Understanding Simple Row Filtering
Customizing the Filter List
Defining the Contents of the Filter Item List
Defining the Order of the Items in the Filter Item List
Setting the Appearance of the Display of the Filter Item List
Creating a Custom Filter
Customizing Enhanced Filtering
Adding a Custom Sort Dialog
Customizing the Filter Bar
Setting the Appearance of Filter Indicators
Using Custom Filter Indicator Images
Showing or Hiding Filter Indicators
Determining Which Header Row Displays the Indicators
Managing Cell Range Filtering
Managing Grouping of Rows of User Data
Allowing the User to Group Rows
Using Grouping
Setting the Appearance of Grouped Rows
Customizing the Group Bar
Creating a Custom Group
Interoperability of Grouping with Other Features
Managing Outlines (Range Groups) of Rows and Columns
Using an Outline (Range Group) of Rows or Columns
Customizing the Appearance of an Outline (Range Group)
Interoperability of Outlines with Other Features
Customizing User Searching of Data
Allowing the User to Perform a Standard Search
Allowing the User to Perform an Advanced Search
Searching for Data with Code
Formulas in Cells
Placing a Formula in Cells
Displaying Formula in Cells
Specifying a Cell Reference in a Formula
Specifying a Sheet Reference in a Formula
Specifying an External Reference in a Formula
Using a Circular Reference in a Formula
Nesting Functions in a Formula
Recalculating and Updating Formulas Automatically
Finding a Value Using GoalSeek
Allowing the User to Enter Formulas
Creating and Using a Custom Name
Creating and Using a Custom Function
Creating and Using a Visual Function
Creating and Using External Variable
Using External Variables with Text Box Control
Using the Array Formula
Working With Dynamic Array Formulas
Working with the Formula Text Box
Setting up the Formula Provider
Setting up the Name Box
Using Language Package
Available Language Packages for WinForms
Creating and Using a Custom Language Package
Accessing Data from Header or Footer
Auto Format Formulas
Managing External Reference
Precedents and Dependents
Sparklines
Add Sparklines Using Methods
Specifying Horizontal and Vertical Axes
Customizing Markers and Points
Working with Sparklines
Add Sparklines using Formulas
Column, Line, and Winloss Sparkline
Area Sparkline
BoxPlot Sparkline
Bullet Sparkline
Cascade Sparkline
Gauge KPI Sparkline
Hbar and Vbar Sparkline
Histogram Sparkline
Image Sparkline
Month and Year Sparkline
Pareto Sparkline
Pie Sparkline
Scatter Sparkline
Spread Sparkline
Stacked Sparkline
Vari Sparkline
Keyboard Interaction
Underlying Keystroke Processing
Factors of Keyboard Map Usage
Default Keyboard Navigation
Default Keyboard Maps
Default Map for Normal and WhenFocused
Default Map for Normal and WhenAncestorOfFocused
Default Map for ReadOnly and WhenFocused
Default Map for ReadOnly and WhenAncestorOfFocused
Default Map for ReadOnly and WhenAncestorOfFocused
Default Map for RowMode and WhenAncestorOfFocused
Default Map for SingleSelect and WhenFocused
Default Map for SingleSelect and WhenAncestorOfFocused
Default Map for MultiSelect and WhenFocused
Default Map for MultiSelect and WhenAncestorOfFocused
Default Map for ExtendedSelect and WhenFocused
Default Map for ExtendedSelect and WhenAncestorOfFocused
Deactivating the Default Keyboard Map
Changing the Default Keyboard Map
Using Input Maps with Action Maps
Customizing the Input Maps
Changing an Input Map for a Child View
Saving and Loading Map Files
Using Excel-compatible Keyboard Shortcuts
Using the Excel Compatibility Input Maps
Default Map for Excel Compatibility
Events from User Actions
Clicking Actions
Selecting Actions
Entering Data Actions
Sheet-Level Actions
Interactivity Actions
Shape Actions
Print Actions
File Operations
Saving Data to a File
Saving to a Spread XML File
Saving to an Excel File
Saving to a Text File
Storing Excel Summary and View
Saving to an HTML Table
Saving Spreadsheet Data to Simple XML
Opening Existing Files
Opening a Spread XML File
Opening an Excel File
Opening a Custom Text File
Opening a Spread COM File
Using Serialization
Implementing a Serializer Class
Parsing Formulas in Custom XML Deserialization
Storing Excel Summary and View
Printing
Specifying What to Print
Printing an Entire Sheet
Printing to PDF
Printing a Child View of a Hierarchical Display
Printing Particular Pages
Printing the Portion of the Sheet with Data
Printing a Range of Cells on a Sheet
Printing an Area of the Sheet
Printing a Sheet with Cell Notes
Printing a Sheet with Shapes
Printing in Duplex Mode
Customizing the Appearance of the Printing
Understanding the Printing Options
Customizing the Print Job Settings
Customizing the Printed Page Layout
Customizing the Printed Page Header or Footer
Customizing the Print Preview Dialog
Repeating Rows or Columns on Printed Pages
Adding a Page Break
Adding a Watermark to a Printed Page
Optimizing the Printing
Optimizing the Printing Using Rules
Optimizing the Printing Using Size
Displaying Dialogs for Users
Displaying a Print Dialog for the User
Displaying an Abort Message for the User
Providing a Preview of the Printing
Chart Control
Understanding Charts
Chart User Interface Elements
Chart Object Model
Chart Types and Views
Plot Types
Y Plot Types
Bar Charts
Area 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
XY Bubble Charts
XY Point Charts
XY Line Charts
XY Stripe Charts
XYZ Plot Types
XYZ Point Charts
XYZ Line Charts
XYZ Surface Charts
XYZ Stripe Charts
Pie Plot Types
Doughnut Charts
Pie Charts
Polar Plot Types
Polar Point Charts
Polar Line Charts
Polar Area Charts
Polar Stripe Charts
Radar Plot Types
Radar Point Charts
Radar Line Charts
Radar Area Charts
Radar Stripe Charts
Data Plot Types
Plot area
Series
Walls
Axis
Chart Line Style
Elevation and Rotation
Lighting, Shapes, and Borders
Labels
Legends
Creating Charts
Using the Chart Control on sheet
Allowing the User to Change the Chart
Saving or Loading a Chart
Using the Chart Control
Save/Load Chart Control
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 different types of plots
Connecting to Data
Using a Bound Data Source
Using an UnBound Data Source
Binding with cell range
Advanced chart settings
Fill Effects
View Type
Customizing Drawing
Working with Shapes in Code
Creating Camera Shapes
Allowing the User to Draw with a Tablet PC
Working With Shapes (Enhanced Shape Engine)
Creating Enhanced Camera Shape
Touch Support with the Component
Understanding Touch Messages
Using a Touch Keyboard
Using the Touch Menu Bar
Using Touch Support
Using Touch Support with AutoFit
Using Touch Support with Cell Notes
Using Touch Support with Charts
Using Touch Support with Clipboard Operations
Using Touch Support with Drag and Fill
Using Touch Support with Drop-Down Elements
Using Touch Support with Editable Cells
Using Touch Support with InputMan Cells
Using Touch Support with Filtering
Using Touch Support with Range Grouping
Using Touch Support with Grouping
Using Touch Support when Moving Columns or Rows
Using Touch Support when Resizing Columns or Rows
Using Touch Support with Scrolling
Using Touch Support with Selections
Using Touch Support with Shapes
Using Touch Support when Sorting
Using Touch Support with Viewports
Using Touch Support with the Tab Strip
Using Touch Support with Zooming
Spread Designer Guide
Introduction
Overview of Spread Designer Features
Starting Spread Designer
Getting Started Designing
Understanding Applied Settings
Simple Example Using Spread Designer
Running Spread Designer Stand Alone
Spread Designer User Interface
Spread Designer Menus
File Menu
Home Menu
Insert Menu
Page Layout Menu
Data Menu
View Menu
Settings Menu
Help Menu
Context Menu
Sheet Context Menu
Table Context Menu
Spread Designer Toolbars
General Toolbar
Cell Types Toolbar
Formatting Toolbar
Formula Bar
Drawing Toolbar
Spread Designer Data Area
Spread Designer Property Window
Spread Designer Status Bar
Formula Bar
Spread Designer Dialogs
Cell Type Dialog
BarCode Tab
Button Tab
Check Box Tab
Color Picker Tab
Combo Box Tab
Currency Tab
Date-Time Tab
General Tab
Background Tab
Hyperlink Tab
Image Tab
Label Tab
ListBox Tab
Mask Tab
MultiColumnComboBox Tab
MultiOption Tab
Number Tab
Percent Tab
Progress Tab
Regular Expression Tab
Rich Text Tab
Slider Tab
Text Tab
GcTextBox Tab
GcMask Tab
GcCharMask Tab
GcDateTime Tab
GcTimeSpan Tab
GcNumber Tab
GcComboBox Tab
Conditional Formatting Dialog
Custom File Options Dialog
Go To Cell Dialog
Name Manager Dialog
Row Height or Column Width Dialog
Row or Column Insert or Delete Dialogs
Shape Properties Dialog
Shape Shadow Properties Dialog
Sheet Settings Dialog
General tab
Colors tab
Headers tab
Grid Lines tab
Calculations tab
Font tab
Sheet Print Settings Dialog
General tab
SmartPrint Tab
Output tab
Header/Footer tab
Pagination tab
Margins tab
Sort Dialog
Spread Settings Dialog
Edit tab
Scroll Bars Tab
General Tab
Split Box Tab
View Tab
Unhide Specific Row or Column Dialogs
Zoom Dialog
Spread Designer Editors
Alternating Row Collection Editor
Border Editor
Cells, Columns, and Rows Editor
Formula Editor
Formatter and Editor
Focus Indicator Editor
DefaultGroupFooter Editor
GroupInfo Collection Editor
Header Editor
Footer Editor
SheetSkin Editor
SheetView Collection Editor
Shortcut Collection Editor
SmartPrintRule Collection Editor
SpreadChart Collection Editor
SpreadSkin Editor
Named Style Editor
TabStrip Editor
InputMap Editor
Designing in the Data Area
Selecting an Item in the Spread Designer
Selecting an Individual Cell
Selecting the Cells with Data
Selecting a Contiguous Range of Cells
Selecting a Row of Cells
Selecting a Column of Cells
Selecting a Sheet of Cells
Selecting an Entire FpSpread Component
Setting Properties in Spread Designer
Setting Sheet Properties in Spread Designer
Setting Row Properties in Spread Designer
Setting Column Properties in Spread Designer
Setting Cell Properties in Spread Designer
Setting Table Properties in Spread Designer
Entering a Formula in Spread Designer
Adding and Customizing Sheets
Working with the Design
Resetting and Clearing Design Work
Printing a Sheet from Spread Designer
Previewing a Sheet in Spread Designer
Saving and Opening Design Files
Applying the Design to the Form
Designing Shapes
Understanding the Built-in Shapes
Things to Do with Any Shape
Adding a Shape to a Sheet
Editing the Points of a Shape
Changing the Appearance of a Shape
Rotating a Shape
Resizing a Shape
Moving a Shape
Adding Hyperlink to a Shape
Adding a Drop Shadow
Locking a Shape
Using Keys with Shapes
Customizing Particular Shapes
Customizing Text as a Shape
Customizing a Polygon
Customizing a Line as an Arrow
Advanced Topics for Shapes
Creating a Custom Compound Shape
Using Shapes with Maps
Using Pictures in Shapes
Using the Chart Designer
Adding Charts
Opening the Chart Designer
Chart Collection Editors
LabelArea Collection Editor
LegendArea Collection Editor
PlotArea Collection Editor
Light Collection Editor
Series Collection Editor
Chart Designer Toolbar
Assembly Reference
FarPoint.CalcEngine Assembly
FarPoint.Excel Assembly
FarPoint.PDF Assembly
FarPoint.Win Assembly
FarPoint.Win.Chart Assembly
FarPoint.Win.Spread Assembly
FarPoint.Win.Spread.Design Assembly
GrapeCity.CalcEngine Assembly
GrapeCity.Spreadsheet Assembly
GrapeCity.Win.PluginInputMan Assembly
Import and Export Reference
Excel-Formatted Files Import
Workbook Settings Imported
Chart Settings Imported
Sheet Settings Imported
Row and Column Settings Imported
Cell Settings Imported
Border Styles Substituted
Formula Settings Imported
Print Settings Imported
Excel-Formatted Files Export
Component and Sheet Settings Exported
Chart Settings Exported
Row and Column Settings Exported
Cell Settings Exported
Cell-Type Settings Exported
Print Settings Exported
Version Comparison Reference
Object Import from Spread COM
Borders Imported from Spread COM Files
Cell Types Imported from Spread COM Files
Formulas Imported from Spread COM Files
Other Settings Imported from Spread COM Files
Differences in Behavior and Operation
General Differences in Product Design
Inherent Differences Based on Platform
Mapping Actions of COM in .NET
Spread COM File Member Equivalents
Spread COM Property Equivalents in .NET
Spread COM Method Equivalents in .NET
Spread COM Event Equivalents in .NET
Read Method (OfficeArtFSP)
In This Topic
Overload List
See Also
Overload List
Overload
Description
Read
See Also
Reference
OfficeArtFSP Class
OfficeArtFSP Members