FarPoint.Web.Spread.Model.DefaultSheetDataModel

DefaultSheetDataModel Class

Represents the full (concrete) implementation of the ISheetDataModel interface for a data model for a sheet, which represents tabular data on a sheet.

Inheritance

object

BaseSheetDataModel

DefaultSheetDataModel

Implements

ICustomFunctionSupport

ICustomFunctionSupport2

IEditableObjectSupport

IOptimizedEnumerationSupport3

IOptimizedEnumerationSupport2

IOptimizedEnumerationSupport

IClearDataSupport

IClearFormulasSupport

IOptimizedEnumerationSupport7

ISheetDataModel

IDataSourceSupport2

IDataSourceSupport

IObjectExpressionSupport

IReceiveRowsVisibleStateChangedNotificationSupport

ISerializeSupport2

ISerializeSupport

Namespace: FarPoint.Web.Spread.Model

Assembly: FarPoint.Web.Spread.dll

Syntax

public class DefaultSheetDataModel : BaseSheetDataModel, INonEmptyCells, IChartSupport, IArraySupport, IChildModelSupport, IDataKeySupport, IRangeSupport, IExpressionSupport, IExpressionSupport2, ICalculationSupport, IIterationSupport, ICustomFunctionSupport, ICustomFunctionSupport2, ICustomNameSupport, ICustomNameSupport2, ISerializable, ICanSerializeXml, ISerializeData, IUnboundRowSupport, IEditableObjectSupport, IAggregationSupport, INameSupport2, INameSupport, IItemTypeSupport, IOptimizedEnumerationSupport3, IOptimizedEnumerationSupport2, IOptimizedEnumerationSupport, IClearDataSupport, IClearFormulasSupport, IOptimizedEnumerationSupport7, ISheetDataModel, IDataSourceSupport2, IDataSourceSupport, IObjectExpressionSupport, IReceiveRowsVisibleStateChangedNotificationSupport, ISerializeSupport2, ISerializeSupport

Public Class DefaultSheetDataModel
    Inherits BaseSheetDataModel
    Implements INonEmptyCells, IChartSupport, IArraySupport, IChildModelSupport, IDataKeySupport, IRangeSupport, IExpressionSupport, IExpressionSupport2, ICalculationSupport, IIterationSupport, ICustomFunctionSupport, ICustomFunctionSupport2, ICustomNameSupport, ICustomNameSupport2, ISerializable, ICanSerializeXml, ISerializeData, IUnboundRowSupport, IEditableObjectSupport, IAggregationSupport, INameSupport2, INameSupport, IItemTypeSupport, IOptimizedEnumerationSupport3, IOptimizedEnumerationSupport2, IOptimizedEnumerationSupport, IClearDataSupport, IClearFormulasSupport, IOptimizedEnumerationSupport7, ISheetDataModel, IDataSourceSupport2, IDataSourceSupport, IObjectExpressionSupport, IReceiveRowsVisibleStateChangedNotificationSupport, ISerializeSupport2, ISerializeSupport

Constructors

Name	Description
DefaultSheetDataModel()	Creates a default data model with zero rows and columns.
DefaultSheetDataModel(ICalcResolver)	Creates a default data model with the specified resolver.
DefaultSheetDataModel(IList, Type)	Creates a default data model with the specified data set (IList object).
DefaultSheetDataModel(IListSource, Type)	Creates a default data model with the specified data set (IListSource object).
DefaultSheetDataModel(DataSet)	Creates a default data model with the specified data set.
DefaultSheetDataModel(DataSet, string)	Creates a default data model with the specified data set.
DefaultSheetDataModel(DataTable)	Creates a default data model with the specified data table.
DefaultSheetDataModel(int, int)	Creates a default data model with the specified number of rows and columns.
DefaultSheetDataModel(SerializationInfo, StreamingContext)	Creates a new DefaultSheetDataModel from the SerializationInfo object.

Properties

Name	Description
AutoCalculation	Gets or sets whether the control automatically recalculates each formula in the sheet when the contents of dependent cells change.
AutoGenerateColumns	Gets or sets whether to generate the columns automatically based on the data source.
CanSerializeXml	Gets whether the object in its entirety can be rendered with XML without losing any information.
ChildRelationCount	Gets the number of the child data relations for a hierarchical display of data.
ColumnCount	Gets or sets the number of columns in the model.
DataKeyField	Gets or sets a row identifier.
DataMember	Gets or sets the data member (table name) to use for data.
DataSource	Gets or sets the data source.
EnumFormulas	Internal use only. Specifies the enumerator formulas.
EnumNotes	Internal use only. Specifies the enumerator notes.
EnumRowFormulas	Internal use only. Specifies the enumerator row formulas.
EnumTags	Internal use only. Specifies the enumerator tags.
EnumValues	Internal use only. Specifies the enumerator values.
IgnoreDataSourceViewChanged	Gets or sets whether to ignore the DataSourceViewChanged event.
IgnoreFormula	Gets or sets a value that indicates whether to ignore the formula.
ItemType	Gets or sets the type of the object in the list for the list data source.
Iteration	Gets or sets whether circular references are evaluated.
MaximumChange	Gets or sets the maximum amount of change below which to stop iterating for caclulations with circular references.
MaximumIterations	Gets or sets the maximum number of iterations for calculations with circular references.
Name	Gets or sets the name of the data model.
NonEmptyColumnCount	Gets the number of columns in the model that contain data (bound or unbound).
NonEmptyRowCount	Gets the number of rows in the model that contain data (bound or unbound).
Parent	Gets or sets the parent data source support object.
ParentRelationName	Gets the name of the data relation being used for a hierarchical display of data.
ParentRowIndex	Gets the index of the row in the parent data model associated with this child data model.
ReferenceStyle	Gets or sets the cell reference style for cells with formulas.
RowCount	Gets or sets the number of rows in the model.
UseRowIndex	Gets whether the GetKey method generates a key for a row.

Methods

Name	Description
AddColumn()	Adds a column to the data model after the last column.
AddColumn(int)	Adds a column to the data model at the specified position.
AddColumns(int, int)	Adds one or more columns to the data model at the specified position.
AddCustomFunction(FunctionInfo)	Adds a new user-defined custom function to the model for use in formulas.
AddCustomName(string, Expression)	Adds a named expression to the model for use in formulas.
AddCustomName(string, string, int, int)	Adds a named expression to the model for use in formulas.
AddRow()	Adds a row to the data model after the last row.
AddRow(int)	Adds a row to the data model at the specified position.
AddRowToDataSource(int, bool)	Adds the unbound row to the data source.
AddRows(int, int)	Adds rows to the data model at the specified position.
AddUnboundRows(int, int)	Adds unbound rows to the data model.
Clear(int, int, int, int)	Removes all the data and formulas from the specified range of cells.
ClearCustomFunctions()	Removes all user-defined custom functions from the model.
ClearCustomNames()	Removes all named expressions from the model.
ClearData(int, int, int, int)	Removes all the data from the specified range of cells.
ClearFormulas(int, int, int, int)	Removes all of the formulas from the specified range of cells.
CompareExpression(Expression, Expression)	Gets whether two expressions are equal.
Copy(int, int, int, int, int, int)	Copies the data from a range of cells to a specified range of cells.
CreateDataSourceSelectArguments(DataSourceView)	Internal use only.
Deserialize(XmlNodeReader)	Loads the object from XML.
EvaluateExpression(int, int, Expression)	Evaluates the expression in the cell at the specified row and column and returns the resulting object.
FireChanged(int, int)	Raises the Changed event.
FireChanged(int, int, int, int)	Raises the Changed event.
FireChanged(int, int, int, int, SheetDataModelEventType)	Raises the Changed event.
GetAggregationResult(int, int, int, int, AggregationType, string)	Calculates the value based on the aggregation type and formats the value with the aggregation format.
GetAggregationType(int)	Gets the AggregationType, as a string value, at the specified column.
GetArray(int, int, int, int)	Gets an object array from a specified range of cells.
GetArray(int, int, int, int, bool)	Gets an object array from a specified range of cells.
GetChildDataModel(int, string)	Gets the data model (ISheetDataModel object) for the specified row and data relation.
GetChildRelation(int)	Gets the name of the child data relation at the specified position.
GetColumnIndex(string)	Gets the index of the column specified by name.
GetCustomFunction(string)	Gets a user-defined custom function from the model.
GetCustomFunctionEnumerator()	Gets an IEnumerator that enumerates through the names of the custom functions in the model.
GetCustomName(string)	Gets a named expression from the model.
GetCustomName(string, int, int)	Gets a named expression from the model with the specified base index for relative cell references.
GetCustomNameEnumerator()	Gets an IEnumerator that enumerates through the names of the named expressions in the model.
GetDataColumnCaption(int)	Gets the column caption at the specified position.
GetDataColumnFromModelColumn(int)	Gets the data source column index for the specified column in the model.
GetDataColumnName(int)	Gets the column name at the specified position.
GetDataColumnType(int)	Gets the column data type at the specified position.
GetDataRow(int)	Gets the view of a specified row of data.
GetDataRowFromModelRow(int)	Gets the data source row index for the specified row in the model.
GetDataTable()	Gets the data table associated with this model.
GetDataView()	Gets the DataView object associated with this model.
GetDataView(bool)	Gets the DataView object associated with this model.
GetExpression(int, int)	Gets the formula, as an expression value, for the cell of the specified row and column.
GetFormula(int, int)	Gets the formula, as a string value, for the cell of the specified row and column.
GetItem(int)	Returns the IEditableObject from a row that is data bound to a DataView or ListSource.
GetKey(int)	Gets a key for the specified row or column.
GetListSource()	Returns the IList data source for this model or null if the data source is not an IList.
GetModelColumnFromDataColumn(int)	Gets the column in the model for the specified data source column.
GetModelRowFromDataRow(int)	Gets the row in the model for the specified data source row.
GetNonEmptyNotesColumnCount()	Gets the number of columns that contain notes.
GetNonEmptyNotesRowCount()	Gets the number of rows that contain notes.
GetNote(int, int)	Gets a user-defined note value for the cell of the specified row and column.
GetObjectData(SerializationInfo, StreamingContext)	Serializes the DefaultSheetDataModel to the SerializationInfo object.
GetTag(int, int)	Gets an application-defined tag value for the cell of the specified row and column.
GetUnboundValue(int, int)	Gets the unbound value for the cell for the specified row and column.
GetValue(int, int)	Gets the value of the cell for the specified row and column.
GoalSeek(int, int, DefaultSheetDataModel, int, int, double)	Attempts to find a value for one cell that produces the desired formula result in another cell.
IsColumnBound(int)	Determines whether the specified column is bound to a data source column.
IsEditable(int, int)	Determines whether the value in the cell of the specified row and column can be edited.
IsEmpty()	Determines whether the data model is empty.
IsRowBound(int)	Determines whether the specified row is bound to a data source row.
IsRowUsed(int)	Determines whether the specified row is not empty.
LoadFormulas(bool)	Loads formulas that are deserialized, but not parsed yet, to be used after all sheets have been created and deserialized.
Move(int, int, int, int, int, int)	Moves the data from a range of cells to the specified location.
NextNonEmptyColumnInRow(int, int)	Gets the index of the next column in a specified row that contains data.
NextNonEmptyRow(int)	Gets the index of the next non-empty row after the specified row index.
OnAggregate(AggregateArgs)	Raises the Changed event, and permits derived classes to handle the event without attaching a delegate.
OnChanged(SheetDataModelEventArgs)	Raises the Changed event, and permits derived classes to handle the event without attaching a delegate.
OnDataSourceViewChanged(object, EventArgs)	Internal use only. Occurs when the data source view has changed.
ParseFormula(int, int, string)	Parses the string value and returns the expression for the cell at the specified row and column.
Recalculate()	Evaluates the formulas in the sheet that have changed since the last calculation cycle.
RecalculateAll()	Evaluates all the formulas in the entire sheet (including those that have not changed since the last calculation cycle).
RemoveColumn(int)	Removes a column at the specified position.
RemoveColumns(int, int)	Removes one or more columns starting with the column at the specified position.
RemoveCustomFunction(string)	Removes a user-defined custom function from the model.
RemoveCustomName(string)	Removes a named expression from the model.
RemoveRow(int)	Removes a row at the specified position.
RemoveRows(int, int)	Removes one or more rows, starting with the specified row.
Serialize(XmlTextWriter)	Saves the object to XML.
Serialize(XmlTextWriter, bool)	Saves the object to XML and specifies whether to save the data source and bound data.
Serialize2(XmlTextWriter)	Saves the object to XML.
SetAggregationType(int, AggregationType)	Sets the AggregationType, as an enumeration value, at the specified column. If you pass null, it clears the AggregationType from that column.
SetArray(int, int, object[,])	Sets an object array into a specified range of cells.
SetArray(int, int, object[,], bool)	Sets an object array into a specified range of cells.
SetExpression(int, int, Expression)	Sets the formula, as an expression value, for the cell of the specified row and column.
SetFormula(int, int, string)	Sets the formula, as a string value, for the cell of the specified row and column. If you pass null, it clears the expression from that cell.
SetModelDataColumn(int, int)	Binds the model column to a specified data source column.
SetModelDataColumn(int, string)	Binds a model column to a specified data source column.
SetNote(int, int, string)	Sets a user-defined note value for the cell at the specified row and column.
SetTag(int, int, object)	Sets an application-defined tag value for the cell of the specified row and column.
SetValue(int, int, object)	Sets the value for the cell of the specified row and column.
Swap(int, int, int, int, int, int)	Swaps the specified ranges of cells.
UnparseFormula(int, int, Expression)	Gets the formula, as a string value, from the specified expression for the cell at the specified row and column.

Events

Name	Description
Aggregate	Occurs when the data model aggregates.
NameChanged	Occurs when the name of the data model changes.
NameChanging	Occurs when the name of the data model is changing.

DefaultSheetDataModel Class
Constructors
Properties
Methods
Events