Spread Windows Forms 18
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread.Model Namespace / DefaultSheetDataModel Class
Properties Methods Events


In This Topic
    DefaultSheetDataModel Class Members
    In This Topic

    The following tables list the members exposed by DefaultSheetDataModel.

    Public Constructors
     NameDescription
    Public ConstructorDefaultSheetDataModel ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAutoCalculationGets or sets whether the control automatically recalculates each formula in the sheet when the contents of dependent cells change.  
    Public PropertyAutoGenerateColumnsGets or sets whether to generate the columns automatically based on the data source.  
    Public PropertyCanSerializeXmlGets whether the object in its entirety can be rendered with XML without losing any information.  
    Public PropertyChildRelationCountGets the number of the child data relations for a hierarchical display of data.  
    Public PropertyColumnCountOverridden. Gets or sets the number of columns in the model.  
    Public PropertyDataMemberGets or sets the data member (table name) to use for data.  
    Public PropertyDataSourceGets or sets the data source.  
    Public PropertyEnumErrorTextInternal use only. Specifies the enumerator error text.  
    Public PropertyEnumFormulasInternal use only. Specifies the enumerator formulas.  
    Public PropertyEnumNotesInternal use only. Specifies the enumerator notes.  
    Public PropertyEnumRowErrorTextInternal use only. Specifies the enumerator row error text.  
    Public PropertyEnumRowFormulasInternal use only. Specifies the enumerator row formulas.  
    Public PropertyEnumTagsInternal use only. Specifies the enumerator tags.  
    Public PropertyEnumValuesInternal use only. Specifies the enumerator values.  
    Public PropertyIgnoreFormulaGets or sets a value that indicates whether to ignore the formula.  
    Public PropertyItemTypeGets or sets the type of the object in the list for the list data source.  
    Public PropertyIterationGets or sets whether circular references are evaluated.  
    Public PropertyMaximumChangeGets or sets the maximum amount of change below which to stop iterating for caclulations with circular references.  
    Public PropertyMaximumIterationsGets or sets the maximum number of iterations for calculations with circular references.  
    Public PropertyNameGets or sets the name of the data model.  
    Public PropertyNonEmptyColumnCountOverridden. Gets the number of columns in the model that contain data (bound or unbound).  
    Public PropertyNonEmptyRowCountOverridden. Gets the number of rows in the model that contain data (bound or unbound).  
    Public PropertyParentGets or sets the parent data source support object.  
    Public PropertyParentRelationNameGets the name of the data relation being used for a hierarchical display of data.  
    Public PropertyParentRowIndexGets the index of the row in the parent data model associated with this child data model.  
    Public PropertyReferenceStyleGets or sets the cell reference style for cells with formulas.  
    Public PropertyRowCountOverridden. Gets or sets the number of rows in the model.  
    Public PropertyUnionedChangeCellRangeGets or sets whether the changed event occurs for each cell range or for the union range. True fires the event for the union range.  
    Top
    Public Methods
     NameDescription
    Public MethodAddColumnOverloaded. Adds a column to the data model after the last column.  
    Public MethodAddColumnsAdds one or more columns to the data model at the specified position.  
    Public MethodAddCustomNameOverloaded. Adds a named expression to the model for use in formulas.  
    Public MethodAddModelScopeCustomNameAdds a custom name to the model scope.  
    Public MethodAddRowOverloaded. Adds a row to the data model after the last row.  
    Public MethodAddRowsAdds rows to the data model at the specified position.  
    Public MethodAddRowToDataSourceAdds the unbound row to the data source.  
    Public MethodAddUnboundRowsAdds unbound rows to the data model.  
    Public MethodCheckModelScopeNameChecks if the specified name is one of the model scope custom names of this data model and returns the name of the custom name in the data model.  
    Public MethodCheckNameChecks if the specified name is one of the common scope custom names of this data model and returns the name of the custom name in the data model.  
    Public MethodClearRemoves all the data and formulas from the specified range of cells.  
    Public MethodClearCustomFunctionsRemoves all user-defined custom functions from the model.  
    Public MethodClearCustomNamesRemoves all named expressions from the model.  
    Public MethodClearDataRemoves all the data from the specified range of cells.  
    Public MethodClearFormulasRemoves all of the formulas from the specified range of cells.  
    Public MethodClearModelScopeCustomNameRemoves all named expressions from the model scope.  
    Public MethodCompareExpressionGets whether two expressions are equal.  
    Public MethodCopyCopies the data from a range of cells to a specified range of cells.  
    Public MethodDeserializeLoads the object from XML.  
    Public MethodEvaluateExpressionEvaluates the expression in the cell at the specified row and column and returns the resulting object.  
    Public MethodGetArrayOverloaded. Gets an object array from a specified range of cells.  
    Public MethodGetCellErrorTextGets a user-defined note value for the cell of the specified row and column.  
    Public MethodGetChildDataModelGets the data model (ISheetDataModel object) for the specified row and data relation.  
    Public MethodGetChildRelationGets the name of the child data relation at the specified position.  
    Public MethodGetColumnIndexGets the index of the column specified by name.  
    Public MethodGetCustomNameGets a named expression from the model with the specified base index for relative cell references.  
    Public MethodGetCustomNameCommentGets a comment for a common custom name.  
    Public MethodGetCustomNameEnumeratorGets an IEnumerator that enumerates through the names of the named expressions in the model.  
    Public MethodGetDataColumnCaptionGets the column caption at the specified position.  
    Public MethodGetDataColumnFromModelColumnGets the data source column index for the specified column in the model.  
    Public MethodGetDataColumnNameGets the column name at the specified position.  
    Public MethodGetDataColumnTypeGets the column data type at the specified position.  
    Public MethodGetDataRowGets the view of a specified row of data.  
    Public MethodGetDataRowFromModelRowGets the data source row index for the specified row in the model.  
    Public MethodGetDataTableGets the data table associated with this model.  
    Public MethodGetDataViewOverloaded. Gets the DataView object associated with this model.  
    Public MethodGetFormulaGets the formula, as a string value, for the cell of the specified row and column.  
    Public MethodGetItemReturns the IEditableObject from a row that is data bound to a DataView or ListSource.  
    Public MethodGetModelColumnFromDataColumnGets the column in the model for the specified data source column.  
    Public MethodGetModelRowFromDataRowGets the row in the model for the specified data source row.  
    Public MethodGetModelScopeCustomNameGets a named expression from the model with the specified base index for relative cell references.  
    Public MethodGetModelScopeCustomNameCommentGets the comment from a custom name.  
    Public MethodGetModelScopeNameEnumeratorGets an IEnumerator that enumerates through the names of the named expressions in the model.  
    Public MethodGetNonEmptyErrorTextsColumnCountGets the number of columns that contain notes.  
    Public MethodGetNonEmptyErrorTextsRowCountGets the number of rows that contain notes.  
    Public MethodGetNonEmptyNotesColumnCountGets the number of columns that contain notes.  
    Public MethodGetNonEmptyNotesRowCountGets the number of rows that contain notes.  
    Public MethodGetNoteOverridden. Gets a user-defined note value for the cell of the specified row and column.  
    Public MethodGetObjectDataSerializes the DefaultSheetDataModel to the SerializationInfo object.  
    Public MethodGetRowErrorTextGets a user-defined error value for the cell of the specified row.  
    Public MethodGetTagOverridden. Gets an application-defined tag value for the cell of the specified row and column.  
    Public MethodGetUnboundValueGets the unbound value for the cell for the specified row and column.  
    Public MethodGetValueOverridden. Gets the value of the cell for the specified row and column.  
    Public MethodGoalSeekAttempts to find a value for one cell that produces the desired formula result in another cell.  
    Public MethodIsColumnBoundDetermines whether the specified column is bound to a data source column.  
    Public MethodIsEditableOverridden. Determines whether the value in the cell of the specified row and column can be edited.  
    Public MethodIsEmptyOverridden. Determines whether the data model is empty.  
    Public MethodIsRowBoundDetermines whether the specified row is bound to a data source row.  
    Public MethodIsRowUsedSpecifies whether the row uses a formula, tag, or note.  
    Public MethodLoadFormulasLoads formulas that are deserialized, but not parsed yet, to be used after all sheets have been created and deserialized.  
    Public MethodModifyCustomNameChanges the name of the shared custom name.  
    Public MethodModifyModelScopeCustomNameModifies the name of a model scope custom name.  
    Public MethodMoveMoves the data from a range of cells to the specified location.  
    Public MethodNextNonEmptyColumnFormulaReturns the next non-empty column with a formula.  
    Public MethodNextNonEmptyColumnInRowOverridden. Gets the index of the next column in a specified row that contains data.  
    Public MethodNextNonEmptyRowReturns the index of the next row that has data.  
    Public MethodParseFormulaParses the string value and returns the expression for the cell at the specified row and column.  
    Public MethodPreviousNonEmptyColumnInRowOverloaded. Gets the previous non-empty column in the row.  
    Public MethodPreviousNonEmptyRowOverloaded. Gets the previous nonempty row.  
    Public MethodRecalculateEvaluates the formulas in the sheet that have changed since the last calculation cycle.  
    Public MethodRecalculateAllEvaluates all the formulas in the entire sheet (including those that have not changed since the last calculation cycle).  
    Public MethodRemoveColumnRemoves a column at the specified position.  
    Public MethodRemoveColumnsRemoves one or more columns starting with the column at the specified position.  
    Public MethodRemoveCustomNameRemoves a named expression from the model.  
    Public MethodRemoveModelScopeCustomNameRemoves a custom name in the model scope.  
    Public MethodRemoveRowRemoves a row at the specified position.  
    Public MethodRemoveRowsRemoves one or more rows, starting with the specified row.  
    Public MethodResumeFormulaParsingResumes parsing of formulas and parses all formulas set while parsing was suspended.  
    Public MethodSerializeOverloaded. Saves the object to XML.  
    Public MethodSetArrayOverloaded. Sets an object array into a specified range of cells.  
    Public MethodSetCellErrorTextSets a user-defined note value for the cell at the specified row and column.  
    Public MethodSetCustomNameCommentSets a comment for a common custom name.  
    Public MethodSetFormulaSets 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.  
    Public MethodSetModelDataColumnOverloaded. Binds a model column to a specified data source column.  
    Public MethodSetModelScopeCustomNameCommentSets a custom name comment.  
    Public MethodSetNoteOverridden. Sets a user-defined note value for the cell at the specified row and column.  
    Public MethodSetRowErrorTextInternal method to set row expression without triggering auto calculation.  
    Public MethodSetTagOverridden. Sets an application-defined tag value for the cell of the specified row and column.  
    Public MethodSetValueOverridden. Sets the value for the cell of the specified row and column.  
    Public MethodSuspendFormulaParsingSuspends parsing of formulas.  
    Public MethodSwapSwaps the specified ranges of cells.  
    Public MethodUnparseFormulaGets the formula, as a string value, from the specified expression for the cell at the specified row and column.  
    Top
    Protected Methods
     NameDescription
    Protected MethodFireChangedOverloaded. Overridden. Raises the Changed event.  
    Protected MethodGetListSourceReturns the IList data source for this model or null if the data source is not an IList.  
    Protected MethodOnAggregateRaises the Changed event, and permits derived classes to handle the event without attaching a delegate.  
    Protected MethodOnChangedOverridden. Raises the Changed event, and permits derived classes to handle the event without attaching a delegate.  
    Top
    Public Events
     NameDescription
    Public EventAggregateOccurs when the data model aggregates.  
    Public EventCellErrorTextChangedOccurs when the user makes a change to the model that affects the data of the sheet.  
    Public EventChangedOccurs when the user makes a change to the model that affects the data of the sheet. (Inherited from FarPoint.Win.Spread.Model.BaseSheetDataModel)
    Public EventCustomNameChangedOccurs when the custom name of the data model changes.  
    Public EventNameChangedOccurs when the name of the data model changes.  
    Public EventNameChangingOccurs when the name of the data model is changing.  
    Public EventReferenceStyleChangedOccurs when the reference style of the data model changes.  
    Public EventRowErrorTextChangedOccurs when the user makes a change to the model that affects the data of the sheet.  
    Top
    See Also

    Reference

    DefaultSheetDataModel Class
    FarPoint.Win.Spread.Model Namespace