Version

SpreadsheetModel Class Members

The following tables list the members exposed by SpreadsheetModel.

Public Constructors
 NameDescription
Public ConstructorSpreadsheetModel ConstructorCreate Spreadsheet  
Public Properties
 NameDescription
Public PropertyActiveCellGets sets the A1 format address of the current active cell within the selected worksheet.  
Public PropertyAllowAddWorksheetGets sets a boolean indicating whether the spreadsheet allows adding worksheets.  
Public PropertyAllowDeleteWorksheetGets sets a boolean indicating whether the spreadsheet allows deleting worksheets.  
Public PropertyAreGridlinesVisibleGets sets a boolean indicating if the grid lines are displayed in the selected worksheets.  
Public PropertyAreHeadersVisibleGets sets a boolean indicating if the row and column headers are displayed for the selected worksheets.  
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyEnterKeyNavigationDirectionReturns or sets an enumeration indicating the direction of the cell adjacent to the activeCell that should be activated when the enter key is pressed. This property is only used if the isEnterKeyNavigationEnabled is set to true. Also, the reverse direction is navigated when Shift + Enter are pressed.  
Public PropertyFixedDecimalPlaceCountGets sets the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true.  
Public PropertyHeightGets sets height of Spreadsheet.  
Public PropertyHtmlAttributesSets custom attributes of the div on which the spreadsheet widget will be created.  
Public PropertyIDSets the ID of the Spreadsheet.  
Public PropertyIsEnterKeyNavigationEnabledGets sets a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed.  
Public PropertyIsFixedDecimalEnabledGets sets a boolean indicating if the formula bar is displayed within the Spreadsheet.  
Public PropertyIsFormulaBarVisibleGets sets a boolean indicating if the formula bar is displayed within the Spreadsheet.  
Public PropertyIsInEndModeGets sets a boolean indicating whether the control is in "End mode". End mode is a mode that affects certain keyboard navigation such as navigating with the arrow keys. For example when in end mode and one presses the right arrow, the activeCell will be changed to be the first cell to the right of the current ActiveCell that has a value(even if the value is ""). If there were no cells to the right with a value then it would activate the right most cell in that row. End mode will end automatically such as when one presses an arrow key.  
Public PropertyIsScrollLockedGets sets a boolean indicating whether the scroll lock key is toggled. This property is used when certain keys are pressed while the control has focus. For example if an arrow key is pressed while the scroll lock is enabled the cell area will be scrolled rather than changing the active cell. Note: This property is not maintained/changed by the control. It is just queried when performing actions that consider whether the scroll lock is enabled.  
Public PropertyIsUndoEnabledGets sets a boolean indicating whether undo is enabled for the control.  
Public PropertyNameBoxWidthGets sets the width of the name box within the formula bar.  
Public PropertySelectionModeGets sets a value indicating how the selection is updated when interacting with the cells via the mouse or keyboard.  
Public PropertyValidationInputMessagePositionReturns or sets the position of the screen tip used to display the input message for the data validation rule associated with the active cell.  
Public PropertyWidthGets sets width of Spreadsheet.  
Public PropertyWorkbookURLReturns or sets the URL of the workbook whose information is displayed in the control.  
Public PropertyZoomLevelGets sets the magnification of the selected worksheets.  
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
Public Methods
 NameDescription
Public MethodAddClientEventAdds javascript function to process client event of widget. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public MethodToJsonSerializes the object to JSON. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected Methods
 NameDescription
Protected MethodCamelizeConverts the provided string to camel case. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodEnsureClientEventsAdds client events to Serializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodGetBoolGets the value of a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetCharSets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDateTimeGets the value of a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDoubleGets the value of a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIEnumerable<T>Gets the value of an IEnumerable property of the model. If the value is null a new IEnumerable of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIntGets the value of an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetJSLiteralSets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetLongGets the value of a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetModel<T>Gets the value of an IModel property of the model. If the value is null a new model of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringGets the value of a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringEnum<T>Gets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValue<T>Gets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValueModel<T>Gets the value of an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromBoolSerializes a bool object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDateTimeSerializes a DateTime object into json Date object. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDoubleSerializes a double object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromFloatSerializes a float object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIDictionarySerializes an IDictionary of objects into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIEnumerableSerializes an IEnumerable object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIntSerializes an int object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromModelStoreSerializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodJsonFromObjectSerializes an arbitrary object in json using the typed serialization methods. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromStringSerializes a string object into json string, escaping all single quotes. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBoolSets a value to a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBrush (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCamelizedStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCharGets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDateTimeSets a value to a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDoubleSets a value to a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIEnumerable<T>Sets a value to an IEnumerable property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIntSets a value to an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetJSLiteralGets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetLongSets a value to a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetModel<T>Sets a value to an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringSets a value to a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetValue<T>Sets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodTransformDataTransforms the data. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodValidValueType<T>Checks type for value of existing property. Returns false as well if non existing property. (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub