Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrSpreadsheetProps

Hierarchy

Hierarchy

  • IIgrSpreadsheetProps

Properties

Properties

Optional ActionExecuted

ActionExecuted?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Invoked when an action is executed on the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Gets the action that was executed.

      Parameters

      Returns void

Optional ActionExecuting

ActionExecuting?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Invoked when an action is about to be executed by the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.action" argType="string" Gets the action that is about to be executed.

      Parameters

      Returns void

Optional activeCell

activeCell?: SpreadsheetCell

Returns or sets the active cell within the selected worksheet.

Optional activeCellChanged

activeCellChanged?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional activePane

activePane?: SpreadsheetPane

Returns an object that represents the pane with the focus.

Optional activePaneChanged

activePaneChanged?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional activeSelection

activeSelection?: SpreadsheetSelection

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

Optional activeTable

activeTable?: WorksheetTable

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

Optional activeTableChanged

activeTableChanged?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional activeWorksheet

activeWorksheet?: Worksheet

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

Optional activeWorksheetChanged

activeWorksheetChanged?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional allowAddWorksheet

allowAddWorksheet?: string | boolean

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

Optional allowAsyncCalculations

allowAsyncCalculations?: string | boolean

Returns or sets a boolean indicating whether the spreadsheet allows adding worksheets. Note: if this property is set to false and the current workbook is performing async calculations, the spreadsheet will cancel them.

Optional allowDeleteWorksheet

allowDeleteWorksheet?: string | boolean

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

Optional areGridlinesVisible

areGridlinesVisible?: string | boolean

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

Optional areHeadersVisible

areHeadersVisible?: string | boolean

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

Optional cellEditMode

cellEditMode?: SpreadsheetCellEditMode

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

Optional chartAdapter

chartAdapter?: 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.

Optional children

children?: ReactNode

Optional contextMenuOpening

contextMenuOpening?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Invoked when a contextmenu is being opened for the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.menuArea" argType="string" Get the area for which the menu is being displayed.

      Parameters

      Returns void

Optional editModeEntered

editModeEntered?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional editModeEntering

editModeEntering?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional editModeExited

editModeExited?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional editModeExiting

editModeExiting?: ((s, e) => void)

Type declaration

    • (s, e): 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).

      Parameters

      Returns void

Optional editModeValidationError

editModeValidationError?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional editRangePasswordNeeded

editRangePasswordNeeded?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional enterKeyNavigationDirection

enterKeyNavigationDirection?: 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.

Optional fixedDecimalPlaceCount

fixedDecimalPlaceCount?: string | 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

Optional height

height?: string

Optional hyperlinkExecuting

hyperlinkExecuting?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Invoked when a hyperlink is being followed in the Spreadsheet. eventArgument="evt" argType="event" jQuery event object. eventArgument="ui.owner" argType="object" Gets a reference to the spreadsheet widget. eventArgument="ui.hyperlink" argType="object" Get the hyperlink to be executed.

      Parameters

      Returns void

Optional isEnterKeyNavigationEnabled

isEnterKeyNavigationEnabled?: string | 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.

Optional isFixedDecimalEnabled

isFixedDecimalEnabled?: string | 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.

Optional isFormulaBarVisible

isFormulaBarVisible?: string | boolean

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

Optional isInEditMode

isInEditMode?: string | boolean

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

Optional isInEndMode

isInEndMode?: string | 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.

Optional isPerformingAsyncCalculations

isPerformingAsyncCalculations?: string | boolean

Returns a boolean indicating if the current workbook is performing asynchronous calculations.

Optional isRenamingWorksheet

isRenamingWorksheet?: string | boolean

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

Optional isScrollLocked

isScrollLocked?: string | 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.

Optional isUndoEnabled

isUndoEnabled?: string | boolean

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

Optional nameBoxWidth

nameBoxWidth?: string | number

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

Optional selectedWorksheets

selectedWorksheets?: Worksheet[]

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

Optional selectionChanged

selectionChanged?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional selectionMode

selectionMode?: SpreadsheetCellSelectionMode

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

Optional undoManager

undoManager?: UndoManager

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

Optional userPromptDisplaying

userPromptDisplaying?: ((s, e) => void)

Type declaration

    • (s, e): 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.

      Parameters

      Returns void

Optional validationInputMessagePosition

validationInputMessagePosition?: string | 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.

Optional width

width?: string

Optional workbook

workbook?: Workbook

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

Optional workbookDirtied

workbookDirtied?: ((s, e) => void)

Type declaration

    • (s, e): 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).

      Parameters

      Returns void

Optional zoomLevel

zoomLevel?: string | number

Returns or sets the magnification of the selected worksheets.