Class IgrSpreadsheet<S, SS, S>

Custom control that displays one or more worksheets.

Type parameters

  • S

  • SS

  • S

Hierarchy

Constructors

constructor

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<IIgrSpreadsheetProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Accessors

ActionExecuted

  • get ActionExecuted(): function
  • set ActionExecuted(ev: function): void

ActionExecuting

  • get ActionExecuting(): function
  • set ActionExecuting(ev: function): void

activeCell

  • Returns or sets the active cell within the selected worksheet.

    Returns SpreadsheetCell

  • Returns or sets the active cell within the selected worksheet.

    Parameters

    Returns void

activeCellChanged

  • get activeCellChanged(): function
  • set activeCellChanged(ev: function): void
  • Invoked when the activeCell of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldValue" argType="string" Gets the previous active cell. eventArgument="ui.newValue" argType="string" Gets the current active cell.

    Returns function

  • Invoked when the activeCell of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldValue" argType="string" Gets the previous active cell. eventArgument="ui.newValue" argType="string" Gets the current active cell.

    Parameters

    Returns void

activePane

  • Returns an object that represents the pane with the focus.

    Returns SpreadsheetPane

  • Returns an object that represents the pane with the focus.

    Parameters

    Returns void

activePaneChanged

  • get activePaneChanged(): function
  • set activePaneChanged(ev: function): void
  • Invoked when the activePane of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActivePane" argType="object" Gets the previous active pane. eventArgument="ui.newActivePane" argType="object" Gets the current active pane. eventArgument="ui.activeCell" argType="string" Gets the active cell of the new active pane or null if there is no active pane. eventArgument="ui.visibleRange" argType="string" Gets the current visible range of the new active pane or null if there is no active pane.

    Returns function

  • Invoked when the activePane of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActivePane" argType="object" Gets the previous active pane. eventArgument="ui.newActivePane" argType="object" Gets the current active pane. eventArgument="ui.activeCell" argType="string" Gets the active cell of the new active pane or null if there is no active pane. eventArgument="ui.visibleRange" argType="string" Gets the current visible range of the new active pane or null if there is no active pane.

    Parameters

    Returns void

activeSelection

  • Returns an object that represents the current selection of the activePane.

    Returns SpreadsheetSelection

  • Returns an object that represents the current selection of the activePane.

    Parameters

    Returns void

activeSelectionCellRangeFormat

  • Returns an object used to get the formatting of the activeCell and where modifications are applied to the entire activeSelection. Any changes made to this object will affect all the objects in the selection. So for example, the Font.Name may return "Arial" because the active cell has that as its resolved font name even though the other cells are using a different font but if you set the Font.Name of this object to "Arial" then all the objects affected by the selection will have their Font.Name updated to that value.

    Returns SpreadsheetCellRangeFormat

activeTable

  • get activeTable(): WorksheetTable
  • set activeTable(v: WorksheetTable): void
  • Returns the ig.excel.WorksheetTable associated with the activeCell of the activeWorksheet.

    Returns WorksheetTable

  • Returns the ig.excel.WorksheetTable associated with the activeCell of the activeWorksheet.

    Parameters

    • v: WorksheetTable

    Returns void

activeTableChanged

  • get activeTableChanged(): function
  • set activeTableChanged(ev: function): void
  • Invoked when the activeTable of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveTable" argType="object" Gets the previous active Table. eventArgument="ui.newActiveTable" argType="object" Gets the current active Table.

    Returns function

  • Invoked when the activeTable of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveTable" argType="object" Gets the previous active Table. eventArgument="ui.newActiveTable" argType="object" Gets the current active Table.

    Parameters

    Returns void

activeWorksheet

  • get activeWorksheet(): Worksheet
  • set activeWorksheet(v: Worksheet): void
  • Returns or sets the Worksheet from the workbook whose content should be displayed within the control.

    Returns Worksheet

  • Returns or sets the Worksheet from the workbook whose content should be displayed within the control.

    Parameters

    • v: Worksheet

    Returns void

activeWorksheetChanged

  • get activeWorksheetChanged(): function
  • set activeWorksheetChanged(ev: function): void
  • Invoked when the activeWorksheet of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveWorksheet" argType="object" Gets the previous active worksheet. eventArgument="ui.oldActiveWorksheetName" argType="string" Gets the name of the previous active worksheet or null if oldActiveWorksheet is null. eventArgument="ui.newActiveWorksheet" argType="object" Gets the current active worksheet. eventArgument="ui.newActiveWorksheetName" argType="string" Gets the name of the new active worksheet or null if newActiveWorksheet is null.

    Returns function

  • Invoked when the activeWorksheet of the Spreadsheet has changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.oldActiveWorksheet" argType="object" Gets the previous active worksheet. eventArgument="ui.oldActiveWorksheetName" argType="string" Gets the name of the previous active worksheet or null if oldActiveWorksheet is null. eventArgument="ui.newActiveWorksheet" argType="object" Gets the current active worksheet. eventArgument="ui.newActiveWorksheetName" argType="string" Gets the name of the new active worksheet or null if newActiveWorksheet is null.

    Parameters

    Returns void

allowAddWorksheet

  • get allowAddWorksheet(): boolean
  • set allowAddWorksheet(v: boolean): void
  • Returns or sets a boolean indicating whether the spreadsheet allows adding worksheets.

    Returns boolean

  • Returns or sets a boolean indicating whether the spreadsheet allows adding worksheets.

    Parameters

    • v: boolean

    Returns void

allowDeleteWorksheet

  • get allowDeleteWorksheet(): boolean
  • set allowDeleteWorksheet(v: boolean): void
  • Returns or sets a boolean indicating whether the spreadsheet allows deleting worksheets.

    Returns boolean

  • Returns or sets a boolean indicating whether the spreadsheet allows deleting worksheets.

    Parameters

    • v: boolean

    Returns void

areGridlinesVisible

  • get areGridlinesVisible(): boolean
  • set areGridlinesVisible(v: boolean): void
  • Returns or sets a boolean indicating if the grid lines are displayed in the selected worksheets.

    Returns boolean

  • Returns or sets a boolean indicating if the grid lines are displayed in the selected worksheets.

    Parameters

    • v: boolean

    Returns void

areHeadersVisible

  • get areHeadersVisible(): boolean
  • set areHeadersVisible(v: boolean): void
  • Returns or sets a boolean indicating if the row and column headers are displayed for the selected worksheets.

    Returns boolean

  • Returns or sets a boolean indicating if the row and column headers are displayed for the selected worksheets.

    Parameters

    • v: boolean

    Returns void

cellEditMode

  • Returns an enumeration used to indicate the current edit mode state.

    Returns SpreadsheetCellEditMode

  • Returns an enumeration used to indicate the current edit mode state.

    Parameters

    Returns void

chartAdapter

  • Returns or sets the object that will provide the chart visualization for display within the Spreadsheet By default charts are not displayed within the spreadsheet. To display charts one should set this property to an instance of a SpreadsheetChartAdapter which is in a separate reference since it relies upon the chart and other data visualization controls.

    Returns SpreadsheetChartAdapterBase

  • Returns or sets the object that will provide the chart visualization for display within the Spreadsheet By default charts are not displayed within the spreadsheet. To display charts one should set this property to an instance of a SpreadsheetChartAdapter which is in a separate reference since it relies upon the chart and other data visualization controls.

    Parameters

    Returns void

contextMenuOpening

  • get contextMenuOpening(): function
  • set contextMenuOpening(ev: function): void

editModeEntered

  • get editModeEntered(): function
  • set editModeEntered(ev: function): void
  • Invoked when the Spreadsheet has started in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has entered edit mode.

    Returns function

  • Invoked when the Spreadsheet has started in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has entered edit mode.

    Parameters

    Returns void

editModeEntering

  • get editModeEntering(): function
  • set editModeEntering(ev: function): void
  • Invoked when the Spreadsheet is about to start in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control is going into edit mode.

    Returns function

  • Invoked when the Spreadsheet is about to start in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control is going into edit mode.

    Parameters

    Returns void

editModeExited

  • get editModeExited(): function
  • set editModeExited(ev: function): void
  • Invoked when the Spreadsheet has ended the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has exited edit mode.

    Returns function

  • Invoked when the Spreadsheet has ended the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.cell" argType="string" Gets the cell for which the control has exited edit mode.

    Parameters

    Returns void

editModeExiting

  • get editModeExiting(): function
  • set editModeExiting(ev: function): void
  • Invoked when the Spreadsheet is about to end the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.acceptChanges" argType="bool" Get or set a boolean indicating whether the changes will be made to the cell's value when edit mode ends. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the edit mode is being forced to exit edit mode in which case it cannot be cancelled. eventArgument="ui.cell" argType="string" Gets the cell for which the control is exiting edit mode. eventArgument="ui.editText" argType="string" Gets the edit text that will be used to update the cell(s).

    Returns function

  • Invoked when the Spreadsheet is about to end the in-place editing of the activeCell. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.acceptChanges" argType="bool" Get or set a boolean indicating whether the changes will be made to the cell's value when edit mode ends. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the edit mode is being forced to exit edit mode in which case it cannot be cancelled. eventArgument="ui.cell" argType="string" Gets the cell for which the control is exiting edit mode. eventArgument="ui.editText" argType="string" Gets the edit text that will be used to update the cell(s).

    Parameters

    Returns void

editModeValidationError

  • get editModeValidationError(): function
  • set editModeValidationError(ev: function): void
  • Invoked when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Get or set the action to take in response to the failed validation. eventArgument="ui.canStayInEditMode" argType="bool" Get a boolean indicating whether the cell is allowed to stay in edit mode. eventArgument="ui.cell" argType="string" Gets the cell for which the control is in edit mode. eventArgument="ui.validationRule" argType="string" Get the rule which failed validation. The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should be taken using the action.Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit.Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt.Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection.

    Returns function

  • Invoked when the Spreadsheet is exiting edit mode and the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Get or set the action to take in response to the failed validation. eventArgument="ui.canStayInEditMode" argType="bool" Get a boolean indicating whether the cell is allowed to stay in edit mode. eventArgument="ui.cell" argType="string" Gets the cell for which the control is in edit mode. eventArgument="ui.validationRule" argType="string" Get the rule which failed validation. The EditModeValidationError is raised while exiting edit mode if the new value for the activeCell is not valid based on the criteria of that cell's ig.excel.DataValidationRule. Since the rule needs to evaluate the value of the cell and potentially other cell's in the Worksheet, the value is first applied to the cell(s) and then is validated. By default if the event is not handled and the showErrorMessageForInvalidValue is true, a message box will be displayed to the end user to determine what action to take. One can handle this event and specify the action that should be taken using the action.Note: The validation rule will not be evaluated if edit mode is being cancelled such as when the user presses Escape to cancel edit.Note: The action will default to AcceptChange if the ShowErrorMessageForInvalidValue of the validationRule is false; otherwise it will default to ShowPrompt.Note: Like Microsoft Excel, only the validation rule of the active cell is considered even if the update is affecting other cells in the selection.

    Parameters

    Returns void

editRangePasswordNeeded

  • get editRangePasswordNeeded(): function
  • set editRangePasswordNeeded(ev: function): void
  • Invoked when the Spreadsheet is performing an operation on a protected Worksheet and there is a single range that may be unlocked to allow the operation to be performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.ranges" argType="array" Get an array of protected range objects that should be unlocked. eventArgument="ui.unprotect" argType="object" Get a parameterless function that may be invoked to unlock the associated ranges.

    Returns function

  • Invoked when the Spreadsheet is performing an operation on a protected Worksheet and there is a single range that may be unlocked to allow the operation to be performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.ranges" argType="array" Get an array of protected range objects that should be unlocked. eventArgument="ui.unprotect" argType="object" Get a parameterless function that may be invoked to unlock the associated ranges.

    Parameters

    Returns void

enterKeyNavigationDirection

  • Returns 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.

    Returns SpreadsheetEnterKeyNavigationDirection

  • Returns 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.

    Parameters

    Returns void

fixedDecimalPlaceCount

  • get fixedDecimalPlaceCount(): number
  • set fixedDecimalPlaceCount(v: number): void
  • Returns or sets the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true

    Returns number

  • Returns or sets the number of decimal places by which a whole number typed in during edit mode should be adjusted when isFixedDecimalEnabled is true

    Parameters

    • v: number

    Returns void

height

  • get height(): string
  • set height(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

hyperlinkExecuting

  • get hyperlinkExecuting(): function
  • set hyperlinkExecuting(ev: function): void

isEnterKeyNavigationEnabled

  • get isEnterKeyNavigationEnabled(): boolean
  • set isEnterKeyNavigationEnabled(v: boolean): void
  • Returns or sets a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed.

    Returns boolean

  • Returns or sets a boolean indicating whether the adjacent cell indicated by the enterKeyNavigationDirection should be navigated to when the enter key is pressed.

    Parameters

    • v: boolean

    Returns void

isFixedDecimalEnabled

  • get isFixedDecimalEnabled(): boolean
  • set isFixedDecimalEnabled(v: boolean): void
  • Returns or sets a boolean indicating whether a fixed decimal place is automatically added when a whole number is entered while in edit mode.

    Returns boolean

  • Returns or sets a boolean indicating whether a fixed decimal place is automatically added when a whole number is entered while in edit mode.

    Parameters

    • v: boolean

    Returns void

isFormulaBarVisible

  • get isFormulaBarVisible(): boolean
  • set isFormulaBarVisible(v: boolean): void
  • Returns or sets a boolean indicating if the formula bar is displayed within the Spreadsheet.

    Returns boolean

  • Returns or sets a boolean indicating if the formula bar is displayed within the Spreadsheet.

    Parameters

    • v: boolean

    Returns void

isInEditMode

  • get isInEditMode(): boolean
  • set isInEditMode(v: boolean): void
  • Returns a boolean indicating if the control is currently editing the value of the activeCell

    Returns boolean

  • Returns a boolean indicating if the control is currently editing the value of the activeCell

    Parameters

    • v: boolean

    Returns void

isInEndMode

  • get isInEndMode(): boolean
  • set isInEndMode(v: boolean): void
  • Returns or 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.

    Returns boolean

  • Returns or 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.

    Parameters

    • v: boolean

    Returns void

isRenamingWorksheet

  • get isRenamingWorksheet(): boolean
  • set isRenamingWorksheet(v: boolean): void
  • Returns a boolean indicating if the user is currently editing the name of the active worksheet.

    Returns boolean

  • Returns a boolean indicating if the user is currently editing the name of the active worksheet.

    Parameters

    • v: boolean

    Returns void

isScrollLocked

  • get isScrollLocked(): boolean
  • set isScrollLocked(v: boolean): void
  • Returns or 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.

    Returns boolean

  • Returns or 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.

    Parameters

    • v: boolean

    Returns void

isUndoEnabled

  • get isUndoEnabled(): boolean
  • set isUndoEnabled(v: boolean): void
  • Returns or sets a boolean indicating whether undo is enabled for the control.

    Returns boolean

  • Returns or sets a boolean indicating whether undo is enabled for the control.

    Parameters

    • v: boolean

    Returns void

nameBoxWidth

  • get nameBoxWidth(): number
  • set nameBoxWidth(v: number): void
  • Returns or sets the width of the name box within the formula bar.

    Returns number

  • Returns or sets the width of the name box within the formula bar.

    Parameters

    • v: number

    Returns void

panes

  • Returns an array of the panes for the activeWorksheet.

    Returns SpreadsheetPane[]

selectedWorksheets

  • get selectedWorksheets(): Worksheet[]
  • set selectedWorksheets(v: Worksheet[]): void
  • Returns or sets an array of the Worksheets whose tabs are selected.

    Returns Worksheet[]

  • Returns or sets an array of the Worksheets whose tabs are selected.

    Parameters

    • v: Worksheet[]

    Returns void

selectionChanged

  • get selectionChanged(): function
  • set selectionChanged(ev: function): void
  • Invoked when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.pane" argType="object" Get the pane for which the selection has changed.

    Returns function

  • Invoked when the selection for a ig.spreadsheet.SpreadsheetPane of the Spreadsheet is changed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.pane" argType="object" Get the pane for which the selection has changed.

    Parameters

    Returns void

selectionMode

  • Returns or sets a value indicating how the selection is updated when interacting with the cells via the mouse or keyboard.

    Returns SpreadsheetCellSelectionMode

  • Returns or sets a value indicating how the selection is updated when interacting with the cells via the mouse or keyboard.

    Parameters

    Returns void

undoManager

  • get undoManager(): UndoManager
  • set undoManager(v: UndoManager): void
  • Returns or sets the UndoManager. Note: this property can not be set to null.

    Returns UndoManager

  • Returns or sets the UndoManager. Note: this property can not be set to null.

    Parameters

    • v: UndoManager

    Returns void

userPromptDisplaying

  • get userPromptDisplaying(): function
  • set userPromptDisplaying(ev: function): void
  • Invoked when the user will be prompted with a message regarding an operation that is being performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the operation that triggered the prompt can be cancelled. eventArgument="ui.displayMessage" argType="bool" Get a boolean indicating if a message will be displayed to the end user. eventArgument="ui.exception" argType="object" Gets the exception for the error, if there was one. eventArgument="ui.message" argType="string" Get or set the message that will be displayed. eventArgument="ui.trigger" argType="string" Get the action that caused the prompt to be displayed.

    Returns function

  • Invoked when the user will be prompted with a message regarding an operation that is being performed. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.canCancel" argType="bool" Get a boolean indicating if the operation that triggered the prompt can be cancelled. eventArgument="ui.displayMessage" argType="bool" Get a boolean indicating if a message will be displayed to the end user. eventArgument="ui.exception" argType="object" Gets the exception for the error, if there was one. eventArgument="ui.message" argType="string" Get or set the message that will be displayed. eventArgument="ui.trigger" argType="string" Get the action that caused the prompt to be displayed.

    Parameters

    Returns void

validationInputMessagePosition

  • get validationInputMessagePosition(): IgPoint
  • set validationInputMessagePosition(v: IgPoint): void
  • Returns or sets the position of the screen tip used to display the input message for the data validation rule associated with the active cell.

    Returns IgPoint

  • Returns or sets the position of the screen tip used to display the input message for the data validation rule associated with the active cell.

    Parameters

    • v: IgPoint

    Returns void

width

  • get width(): string
  • set width(value: string): void
  • Returns string

  • Parameters

    • value: string

    Returns void

workbook

  • get workbook(): Workbook
  • set workbook(v: Workbook): void
  • Returns or sets the workbook whose information is displayed in the control.

    Returns Workbook

  • Returns or sets the workbook whose information is displayed in the control.

    Parameters

    • v: Workbook

    Returns void

workbookDirtied

  • get workbookDirtied(): function
  • set workbookDirtied(ev: function): void
  • Invoked when a change has been made to the workbook that might require a save. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. Note: This event is invoked asynchronously with regards to the change(s) that have occurred. Also some changes alone are not considered to dirty the Workbook even though it does change state on the Workbook or one of its subobjects. An example of that would be a zoom type operation (e.g. changing the magnificationInNormalView).

    Returns function

  • Invoked when a change has been made to the workbook that might require a save. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. Note: This event is invoked asynchronously with regards to the change(s) that have occurred. Also some changes alone are not considered to dirty the Workbook even though it does change state on the Workbook or one of its subobjects. An example of that would be a zoom type operation (e.g. changing the magnificationInNormalView).

    Parameters

    Returns void

zoomLevel

  • get zoomLevel(): number
  • set zoomLevel(v: number): void
  • Returns or sets the magnification of the selected worksheets.

    Returns number

  • Returns or sets the magnification of the selected worksheets.

    Parameters

    • v: number

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IIgrSpreadsheetProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrSpreadsheetProps>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IIgrSpreadsheetProps>, prevState: Readonly<S>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

componentWillUnmount

  • componentWillUnmount(): void
  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrSpreadsheetProps>, nextState: Readonly<S>, nextContext: any): void

containerResized

  • containerResized(): void
  • Notifies the spreadsheet that the container object has been resized.

    Returns void

executeAction

  • Executes the specified action.

    Parameters

    Returns boolean

exportVisualData

  • exportVisualData(): any
  • Returns an object with information about the visual state of the spreadsheet.

    Returns any

flush

  • flush(): void
  • Forces the spreadsheet to synchronously perform any deferred work.

    Returns void

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrSpreadsheetProps>, prevState: Readonly<S>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

initializeContent

  • initializeContent(): void
  • Returns void

render

  • render(): DetailedReactHTMLElement<object, any>
  • Returns DetailedReactHTMLElement<object, any>

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean
  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

styleUpdated

  • styleUpdated(): void
  • Notifies the spreadsheet that style information used for rendering may have been updated.

    Returns void

Static _createFromInternal

  • Parameters

    • internal: any

    Returns IgrSpreadsheet