ig.spreadsheet.SpreadsheetAction

Enumeration used to identify an action to be taken by the Spreadsheet

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_web.js
infragistics.xml.js
infragistics.dv_interactivity.js
infragistics.dv_core.js
infragistics.documents.core_core.js
infragistics.excel_core.js
infragistics.ext_ui.js
infragistics.undo.js
  • activateAndSelectNextWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    103

    Activates and selects the next visible Worksheet after the activeWorksheet

  • activateAndSelectPreviousWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    104

    Activates and selects the previous visible Worksheet before the activeWorksheet

  • activateNextOutOfViewWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    110

    Activates the visible worksheet that is the last partially visible worksheet tab in view or next visible worksheet if the last visible item is fully in view.

  • activateNextPane

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    1

    Activates the next SpreadsheetPane if there are multiple panes and they are not frozen.

  • activateNextWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    101

    Activates the next visible Worksheet after the activeWorksheet

  • activatePreviousOutOfViewWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    109

    Activates the visible worksheet that is before the first worksheet tab in view.

  • activatePreviousPane

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    0

    Activates the previous SpreadsheetPane if there are multiple panes and they are not frozen.

  • activatePreviousWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    102

    Activates the previous visible Worksheet before the activeWorksheet

  • addNewWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    99

    Adds a new Worksheet after the current active worksheet and activates it.

  • addTableColumn

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    175

    Adds one column to the end of the activeTable Note, the selection must be completely within the table and only 1 worksheet may be selected.

  • addTableRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    177

    Adds one row at the end of the activeTable. Note, the selection must be completely within the table and not intersect with the header row and only 1 worksheet may be selected.

  • alignHorizontalCenter

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    127

    Changes the horizontal alignment of the cell formats for the current selection switching between Center and General.

  • alignHorizontalJustify

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    128

    Changes the horizontal alignment of the cell formats for the current selection switching between Justify and General.

  • alignHorizontalLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    129

    Changes the horizontal alignment of the cell formats for the current selection switching between Left and General.

  • alignHorizontalRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    130

    Changes the horizontal alignment of the cell formats for the current selection switching between Right and General.

  • alignVerticalBottom

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    133

    Changes the vertical alignment of the cell formats for the current selection to Bottom.

  • alignVerticalMiddle

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    132

    Changes the vertical alignment of the cell formats for the current selection to Middle.

  • alignVerticalTop

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    131

    Changes the vertical alignment of the cell formats for the current selection to Top.

  • autoFitColumnWidth

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    94

    Updates the WorksheetColumn.width based on the size of the content in the columns associated with the activeSelection so that it will be resized based on the size of the contents.

  • autoFitRowHeight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    93

    Updates the WorksheetRow.height to be -1 for rows associated with the activeSelection so that it will be resized based on the size of the contents.

  • cancelRenameWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    172

    Exits the renaming of a worksheet without committing the changes to the name

  • cellAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    8

    Navigates to the cell above the active cell.

  • cellBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    9

    Navigates to the cell below the active cell.

  • cellInNextSelectionRange

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    81

    Activates the first cell in the next cell range of the SpreadsheetSelection

  • cellInPreviousSelectionRange

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    82

    Activates the first cell in the previous cell range of the SpreadsheetSelection

  • cellInSelectionAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    4

    Navigates to the cell above within the selection if multiple cells are selected otherwise navigates to the cell above.

  • cellInSelectionBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    5

    Navigates to the cell below within the selection if multiple cells are selected otherwise navigates to the cell below.

  • cellInSelectionLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    3

    Navigates to the previous cell within the selection if multiple cells are selected otherwise navigates to the cell to the left.

  • cellInSelectionRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    2

    Navigates to the next cell within the selection if multiple cells are selected otherwise navigates to the cell to the right.

  • cellInTableLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    200

    Navigates to the previous cell within the activeCell unless the active cell is within the total row.

  • cellInTableRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    199

    Navigates to the next cell within the activeTable unless the active cell is within the totql row.

  • cellLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    7

    Navigates to the cell to the left of the active cell.

  • cellPageAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    19

    Scrolls up one page and activates a cell in the same column and relative visible row.

  • cellPageBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    18

    Scrolls down one page and activates a cell in the same column and relative visible row.

  • cellPageLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    21

    Scrolls left one page and activates a cell in the same row and relative visible column.

  • cellPageRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    20

    Scrolls right one page and activates a cell in the same row and relative visible column.

  • cellRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    6

    Navigates to the cell to the right of the active cell.

  • cellWithDataAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    12

    Navigates to the cell above the active cell that has data or the first cell in the column if there are none with data.

  • cellWithDataBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    13

    Navigates to the cell below the active cell that has data or the last cell in the column if there are none with data.

  • cellWithDataLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    10

    Navigates to the cell to the left of the active cell that has data or the first cell in the row if there are none with data.

  • cellWithDataRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    11

    Navigates to the cell to the right of the active cell that has data or the last cell in the row if there are none with data.

  • circleInvalidData

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    170

    Checks the validity of all the cells in the current activeWorksheet based on their associated DataValidationRule if it has one.

  • clearAllFilterAndSort

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    188

    Clears all the filter and sort settings for the SpreadsheetSelection.activeCell of the activeSelection. If the active cell is within the activeTable then the filter and sort information of the table is cleared. If the cell is not within a table the Worksheet.filterSettings sort and filtering are cleared even if the cell is not within its region. The command is not available when there are multiple worksheets selected or if the active cell is in an area that does not have any sorting or filtering.

  • clearContents

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    79

    Clears the value of the selected cells.

  • clearFilter

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    189

    Clears the filter for the column associated with the SpreadsheetSelection.activeCell of the activeSelection. The command is not available when there are multiple worksheets selected or if the active cell is within a column that does not have any filtering. This command may also be executed with a string containing the A1 format cell address of the target cell for the operation.

  • clearFormats

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    158

    Resets the cell format for the cells associated with the selection including the row and column cell format for rows and columns that are entirely selected.

  • clearHyperlinks

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    166

    Removes hyperlinks from the selected cells without removing the formatting.

  • clearValidationCircles

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    171

    Clears any invalidation circles that are cached for the current activeWorksheet

  • commitRenameWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    173

    Attempts to exit the renaming of a worksheet and committing the changes to the name.

  • convertTableToRange

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    184

    Removes the activeTable and converts it to a normal range of cells.

  • copy

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    149

    Copies the information from the selection to the clipboard.

  • cut

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    148

    Copies the information from the selection to the clipboard and clears the contents.

  • decreaseFontSize

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    126

    Decreases the size of the font for the cell format of the current selection based on the current state of the active cell.

  • decreaseIndentation

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    124

    Decreases the Indent of the cell format of the current selection based on the current state of each cell and potentially changing other properties such as horizontal alignment to one that supports indentation.

  • deleteCells

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    157

    Deletes the cells associated with the current selection and shifts the cells based on where data is in adjacent cells.

  • deleteCellsShiftLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    154

    Deletes the cells associated with the current selection and shifts the cells that exist on the right of the selection to the left.

  • deleteCellsShiftUp

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    155

    Deletes the cells associated with the current selection and shifts the cells that exist below of the selection upward.

  • deleteColumns

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    146

    Removes columns associated with the current selection.

  • deleteRows

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    144

    Removes rows associated with the current selection.

  • deleteTableColumns

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    178

    Deletes one or more columns in the activeTable based on the current selection. Note, the selection must be completely within the table and only 1 worksheet may be selected.

  • deleteTableRows

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    179

    Deletes one or more rows in the activeTable based on the current selection. Note, the selection must be completely within the table and not intersect with the header row and only 1 worksheet may be selected.

  • deleteWorksheets

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    114

    Removes the selected worksheets from the associated Workbook.

  • edgeCellWithDataAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    16

    Navigates to the farthest contiguous cell with data above the active cell. If the active cell has no data or the cell above does not have data, it will navigate to the start of the next cell that has data in that direction or the first cell in the column if there are no more cells with data.

  • edgeCellWithDataBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    17

    Navigates to the farthest contiguous cell with data below the active cell. If the active cell has no data or the cell below does not have data, it will navigate to the start of the next cell that has data in that direction or the last cell in the column if there are no more cells with data.

  • edgeCellWithDataLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    14

    Navigates to the farthest contiguous cell with data to the left of the active cell. If the active cell has no data or the cell to the left does not have data, it will navigate to the start of the next cell that has data in that direction or the first cell in the row if there are no more cells with data.

  • edgeCellWithDataRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    15

    Navigates to the farthest contiguous cell with data to the right of the active cell. If the active cell has no data or the cell to the right does not have data, it will navigate to the start of the next cell that has data in that direction or the last cell in the row if there are no more cells with data.

  • enterEditMode

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    73

    Starts in place editing of the activeCell starting with the current value

  • enterEditModeAndClearValue

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    74

    Starts in place editing of the activeCell starting with an empty value

  • enterEndMode

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    36

    Changes the isInEndMode to true

  • enterKeyNavigation

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    87

    The cell adjacent to the active cell in the direction indicated by the enterKeyNavigationDirection should be activated.

  • exitEditModeAndCreateArrayFormula

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    77

    Ends edit mode of the activeCell and updates all the cells within the selection with an array formula from current edit value.

  • exitEditModeAndDiscardChanges

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    78

    Ends edit mode of the activeCell and discards any changes made while editing.

  • exitEditModeAndUpdateActiveCell

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    75

    Ends edit mode of the activeCell and updates the active cell's value based on the current edit value.

  • exitEditModeAndUpdateSelectedCells

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    76

    Ends edit mode of the activeCell and updates all the cells within the selection with the cell's value based on the current edit value.

  • exitEndMode

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    37

    Changes the isInEndMode to false

  • filterByCellColor

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    192

    Similar to FilterByCellValue except the filter is based on the resolved background color of the active cell.

  • filterByCellFontColor

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    193

    Similar to FilterByCellValue except the filter is based on the resolved text/font color of the active cell.

  • filterByCellIcon

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    194

    Similar to FilterByCellValue except the filter is based on the resolved icon of the active cell.

  • filterByCellValue

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    191

    Filters the data region based on the current value of the SpreadsheetSelection.activeCell of the activeSelection. If the active cell is within the activeTable then the filter for the column associated with the active cell is set to the new filter. If the cell is within the WorksheetFilterSettings.region of the Worksheet.filterSettings then the filter for the column of that region associated with the active cell is set to the new filter. Otherwise a new region is created for the Worksheet.filterSettings based on the selection and the filter is created for that column.

  • firstCellInRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    30

    Navigates to the first cell in the row

  • firstCellInView

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    31

    Navigates to the upper left cell in view.

  • firstCellInViewWithinSelection

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    71

    Changes the activeCell to be the upper left most cell in view within the active selection range.

  • firstCellInWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    32

    Navigates to the first cell in the Worksheet.

  • firstScrollableCellInRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    33

    Navigates to the cell of the first scrollable column in the row. This is the same as FirstCellInRow unless there are frozen panes and then the first scrollable column is based on the number of frozen column.

  • firstScrollableCellInWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    34

    Navigates to the cell for the first scrollable row and column in the Worksheet. This is the same as FirstCellInView unless there are frozen panes and then the first scrollable row and column are based on the number of frozen rows and columns.

  • firstUnlockedCell

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    167

    Navigates to the leftmost unlocked cell of the topmost row.

  • freezeFirstColumn

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    137

    Changes the DisplayOptions of the active worksheet so that the first currently visible column will be frozen at the left and the right area can scroll from the next column until the last column.

  • freezeFirstRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    136

    Changes the DisplayOptions of the active worksheet so that the first currently visible row will be frozen at the top and the bottom area can scroll from the next row until the last row.

  • hideColumns

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    89

    Sets the RowColumnBase.hidden to true for the columns associated with the activeSelection.

  • hideRows

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    91

    Sets the RowColumnBase.hidden to true for the rows associated with the activeSelection.

  • increaseFontSize

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    125

    Increases the size of the font for the cell format of the current selection based on the current state of the active cell.

  • increaseIndentation

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    123

    Increases the Indent of the cell format of the current selection based on the current state of each cell and potentially changing other properties such as horizontal alignment to one that supports indentation.

  • insertCells

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    156

    Inserts cells based on the current selection and shifts the cells based on where data is in adjacent cells.

  • insertCellsShiftDown

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    153

    Inserts cells before the cells associated with the current selection shifting the existing cells down.

  • insertCellsShiftRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    152

    Inserts cells before the cells associated with the current selection shifting the existing cells to the right.

  • insertColumns

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    147

    Inserts columns before the columns associated with the current selection. If multiple columns are selected then multiple columns will be inserted.

  • insertNewWorksheets

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    100

    Inserts a new Worksheet for each selected Worksheet before the active worksheet and activates the first new sheet.

  • insertRows

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    145

    Inserts rows before the rows associated with the current selection. If multiple rows are selected then multiple rows will be inserted.

  • insertTableColumns

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    174

    Inserts one or more columns in the activeTable based on the current selection width relative to the left edge of the selection. Note, the selection must be completely within the table and only 1 worksheet may be selected.

  • insertTableRows

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    176

    Inserts one or more rows in the activeTable based on the current selection height relative to the top edge of the selection. Note, the selection must be completely within the table and not intersect with the header row and only 1 worksheet may be selected.

  • lastCellInView

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    35

    Navigates to the lower right cell in view.

  • lastCellInViewWithinSelection

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    72

    Changes the activeCell to be the lower right most cell in view within the active selection range.

  • lastUnlockedCell

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    168

    Navigates to the rightmost unlocked cell of the bottommost row.

  • lastUsedCell

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    38

    Navigates to the last row and column for which data or formatting have been provided.

  • lastUsedCellInRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    39

    Navigates the column of the end of the used range but stays within the current row of the active cell.

  • mergeCells

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    96

    Merges the selected cells into one cell.

  • mergeCellsAcross

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    95

    Merge the selected cells in one row into one cell.

  • mergeCellsAndCenter

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    97

    Combine and center the contents of the selected cells into a new larger cell.

  • openHyperlink

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    164

    Executes the hyperlink associated with the selection when a single cell is selected.

  • paste

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    150

    Updates the selection based on the information in the clipboard.

  • pickFromDropDownList

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    202

    Displays a list of the string values of the adjacent cells above and below the activeCell

  • reapplyFilterAndSort

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    190

    Reapplies the filter and sort settings for the SpreadsheetSelection.activeCell of the activeSelection. If the active cell is within the activeTable then the filter and sort information of the table is reapplied. If the cell is not within a table the Worksheet.filterSettings sort and filtering are repplied even if the cell is not within its region. The command is not available when there are multiple worksheets selected or if the active cell is within a table that does not have any sorting or filtering.

  • redo

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    85

    Used to re-execute the last change operation that was undo, if possible.

  • removeColumnScrollRegionSplit

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    138

    Removes the vertical split and sets the LeftPaneWidth of the UnfrozenPaneSettings to 0.

  • removeHyperlinks

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    165

    Removes hyperlinks associated with the selected cells.

  • removeRowScrollRegionSplit

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    140

    Removes the horizontal split and sets the TopPaneHeight of the UnfrozenPaneSettings to 0.

  • removeScrollRegionSplits

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    142

    Removes both the horizontal and vertical splits so that there is only a single scrolling region remaining.

  • renameWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    113

    Enters edit mode on the tab associated with the active worksheet.

  • resetNameBoxWidth

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    169

    Resets the NameBoxWidth to its default value.

  • scrollDown

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    25

    Scrolls the active pane's row scroll region down by 1 row.

  • scrollLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    22

    Scrolls the active pane's column scroll region left by 1 column.

  • scrollNextWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    105

    Increments the WorkbookWindowOptions.firstVisibleTabIndex to the next visible worksheet

  • scrollPageAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    28

    Scrolls the active pane's row scroll region up by the size of the viewable area.

  • scrollPageBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    29

    Scrolls the active pane's row scroll region down by the size of the viewable area.

  • scrollPageLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    26

    Scrolls the active pane's column scroll region left by the size of the viewable area.

  • scrollPageRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    27

    Scrolls the active pane's column scroll region right by the size of the viewable area.

  • scrollPreviousWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    106

    Decrements the WorkbookWindowOptions.firstVisibleTabIndex to the previous visible worksheet

  • scrollRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    23

    Scrolls the active pane's column scroll region right by 1 column.

  • scrollToFirstWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    107

    Scrolls the tab area such that the first visible worksheet tab is in view

  • scrollToLastWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    108

    Scrolls the tab area such that the last visible worksheet tab is in view

  • scrollUp

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    24

    Scrolls the active pane's row scroll region up by 1 row.

  • selectActiveCellOnly

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    84

    Changes the selection such that it only contains the ActiveCell.

  • selectAllCells

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    67

    Replaces the selection range containing the active cell with a selection range that encompasses the entire worksheet.

  • selectAllWorksheets

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    111

    Selects all the visible worksheet tabs within the workbook

  • selectCellAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    43

    Selects from the active cell to the cell above the active cell.

  • selectCellBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    44

    Selects from the active cell to the cell below the active cell.

  • selectCellLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    42

    Selects from the active cell to the cell to the left of the active cell.

  • selectCellPageAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    54

    Scrolls up one page and selects from the active cell to a cell in the same column and relative visible row.

  • selectCellPageBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    53

    Scrolls down one page and selects from the active cell to a cell in the same column and relative visible row.

  • selectCellPageLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    56

    Scrolls left one page and selects from the active cell to a cell in the same row and relative visible column.

  • selectCellPageRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    55

    Scrolls right one page and selects from the active cell to a cell in the same row and relative visible column.

  • selectCellRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    41

    Selects from the active cell to the cell to the right of the active cell.

  • selectCellWithDataAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    47

    Selects from the active cell to the cell above the active cell that has data or the first cell in the column if there are none with data.

  • selectCellWithDataBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    48

    Selects from the active cell to the cell below the active cell that has data or the last cell in the column if there are none with data.

  • selectCellWithDataLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    45

    Selects from the active cell to the cell to the left of the active cell that has data or the first cell in the row if there are none with data.

  • selectCellWithDataRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    46

    Selects from the active cell to the cell to the right of the active cell that has data or the last cell in the row if there are none with data.

  • selectColumns

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    66

    Replaces the selection range containing the active cell with a selection range that encompasses the columns for that range.

  • selectCurrentArray

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    80

    Selects the region associated with an array formula that is applied to the active cell.

  • selectCurrentRegion

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    40

    Selects the cells adjacent to the active cell that have data or selects the entire worksheet if the current region is already selected or the current cell range selection isn't contained within the calculated current region.

  • selectEdgeCellWithDataAbove

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    51

    Selects from the active cell to the farthest contiguous cell with data above the active cell. If the active cell has no data or the cell above does not have data, it will navigate to the start of the next cell that has data in that direction or the first cell in the column if there are no more cells with data.

  • selectEdgeCellWithDataBelow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    52

    Selects from the active cell to the farthest contiguous cell with data below the active cell. If the active cell has no data or the cell below does not have data, it will navigate to the start of the next cell that has data in that direction or the last cell in the column if there are no more cells with data.

  • selectEdgeCellWithDataLeft

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    49

    Selects from the active cell to the farthest contiguous cell with data to the left of the active cell. If the active cell has no data or the cell to the left does not have data, it will navigate to the start of the next cell that has data in that direction or the first cell in the row if there are no more cells with data.

  • selectEdgeCellWithDataRight

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    50

    Selects from the active cell to the farthest contiguous cell with data to the right of the active cell. If the active cell has no data or the cell to the right does not have data, it will navigate to the start of the next cell that has data in that direction or the last cell in the row if there are no more cells with data.

  • selectEntireTableColumn

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    181

    Selects the cells of the entire columns in the activeTable based on the portion of the active range of the current selection that intersects with the table.

  • selectFirstCellInRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    57

    Selects from the active cell to the first cell in the row

  • selectFirstCellInView

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    58

    Selects from the active cell to the upper left cell in view.

  • selectFirstCellInWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    59

    Selects from the active cell to the first cell in the Worksheet.

  • selectFirstScrollableCellInRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    60

    Selects from the active cell to the cell of the first scrollable column in the row. This is the same as FirstCellInRow unless there are frozen panes and then the first scrollable column is based on the number of frozen column.

  • selectFirstScrollableCellInWorksheet

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    61

    Selects from the active cell to the cell for the first scrollable row and column in the Worksheet. This is the same as FirstCellInView unless there are frozen panes and then the first scrollable row and column are based on the number of frozen rows and columns.

  • selectLastCellInView

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    62

    Selects from the active cell to the lower right cell in view.

  • selectLastUsedCell

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    63

    Selects from the active cell to the last row and column for which data or formatting have been provided.

  • selectLastUsedCellInRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    64

    Selects from the active cell the column of the end of the used range but stays within the current row of the active cell.

  • selectRows

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    65

    Replaces the selection range containing the active cell with a selection range that encompasses the rows for that range.

  • selectTableColumnData

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    180

    Selects the data area of the columns in the activeTable based on the portion of the active range of the current selection that intersects with the table. If the intersection includes the header or footer rows then the operation is the same as SelectEntireTableColumn

  • selectTableRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    182

    Selects the cells of the entire rows in the activeTable based on the portion of the active range of the current selection that intersects with the table.

  • selectVisibleCellsOnly

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    83

    Chnages the selection such that it only does not contain any hidden rows or columns.

  • shiftEnterKeyNavigation

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    88

    The cell adjacent to the active cell in the reverse of the direction indicated by the enterKeyNavigationDirection should be activated.

  • showCellDropDown

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    201

    Displays the dropdown associated with the activeCell which may be things such as the filter menu dropdown, the list of values from the cell's list type data validation, a list of formulas for a cell in the total row of a table, etc.

  • showCustomSortDialog

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    203

    Displays the custom sort dialog for the worksheet sort region

  • showFormatCellsDialog

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    198

    Displays the format cells dialog for the current selection.

  • snapColumnScrollRegionSplit

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    139

    Adjusts the width of the left row scroll region such that it is aligned to the edge of a column.

  • snapRowScrollRegionSplit

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    141

    Adjusts the height of the top row scroll region such that it is aligned to the edge of a row.

  • snapScrollRegionSplits

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    143

    Adjusts the height of the top and left scrolling regions such that they are aligned to the edge or a row and column respectively.

  • sortAscending

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    187

    This causes an ascending sort for the current selection. The exact changes will depend on whether the current selection is within the activeTable. If the selection is within a table then the column associated with the SpreadsheetSelection.activeCell is sorted ascending. If the selection is not within a table then the data range associated with the selection is sorted ascending via the Worksheet.sortSettings. The command is not available if the selection intesects table and non-table cells and cannot be performed if there are multiple selection ranges. This command may also be executed with a string containing the A1 format cell address of the target cell for the operation.

  • sortByCellColor

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    195

    Sorts the data region based on the current background color of the SpreadsheetSelection.activeCell of the activeSelection. If the active cell is within the activeTable then the sort for the column associated with the active cell is set to the new sort condition. If the cell is within the WorksheetFilterSettings.region of the Worksheet.filterSettings then the sort for the column of that region associated with the active cell is set to the new sort condition. Otherwise the Worksheet.sortSettings is updated based on the selection and the sort condition is created for that column. This command may also be executed with a string containing the A1 format cell address of the target cell for the operation.

  • sortByCellFontColor

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    196

    Similar to SortByCellColor except the sort condition is based on the resolved text/font color of the active cell.

  • sortByCellIcon

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    197

    Similar to SortByCellColor except the sort condition is based on the resolved icon of the active cell.

  • sortDescending

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    186

    This causes a descending sort for the current selection. The exact changes will depend on whether the current selection is within the activeTable. If the selection is within a table then the column associated with the SpreadsheetSelection.activeCell is sorted descending. If the selection is not within a table then the data range associated with the selection is sorted descending via the Worksheet.sortSettings. The command is not available if the selection intesects table and non-table cells and cannot be performed if there are multiple selection ranges. This command may also be executed with a string containing the A1 format cell address of the target cell for the operation.

  • switchToAddToSelectionMode

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    70

    Changes the selectionMode to AddToSelection.

  • switchToExtendSelectionMode

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    69

    Changes the selectionMode to ExtendSelection.

  • switchToNormalSelectionMode

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    68

    Changes the selectionMode to Normal.

  • toggleBold

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    119

    Changes the bold state of the cell format of the current selection based on the bold state of the active cell.

  • toggleCellEditMode

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    151

    Used while in edit mode to change the cellEditMode and switch between the modes that control how the arrow keys are handled.

  • toggleDoubleUnderline

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    161

    Changes the underline state of the cell format of the current selection based on the underline state of the active cell.

  • toggleFilter

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    185

    This command turns on or off filtering for the current selection. The exact changes will depend on whether the current selection is within the activeTable. If within a table and the WorksheetTable.isFilterUIVisible is false, this will ensure the WorksheetTable.isHeaderRowVisible and WorksheetTable.isFilterUIVisible are true; otherwise it will invoke WorksheetTable.clearFilters and set the WorksheetTable.isFilterUIVisible is false. Outside of a table, the property affects the Worksheet.filterSettings. If there is a filtered region then the command invokes the WorksheetFilterSettings.clearFilters and then clears/removes the region; otherwise it set the worksheet filter region to a region relative to the selection. The command is not available if the selection intesects table and non-table cells and cannot be performed if there are mulitple selection ranges.

  • toggleFreezePanes

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    135

    Changes the DisplayOptions of the active worksheet to add or remove frozen areas. If the worksheet currently has frozen areas then they will be removed. If the worksheet currently has unfrozen splits then they will be converted to frozen splits. Otherwise it will create frozen areas based on the current active cell.

  • toggleItalic

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    120

    Changes the italic state of the cell format of the current selection based on the italic state of the active cell.

  • toggleShowFormulasInCells

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    159

    Changes the DisplayOptions.showFormulasInCells of the selected worksheets.

  • toggleSplitPanes

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    134

    Changes the DisplayOptions of the active worksheet to add or remove resizable split areas that are separately scrollable. If the worksheet currently has split areas then the splits will be removed. If the worksheet has frozen areas they will be converted to splits. Otherwise it will create split areas based on the current active cell.

  • toggleStrikeThrough

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    121

    Changes the strikethrough state of the cell format of the current selection based on the strikethrough state of the active cell.

  • toggleSubscript

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    163

    Changes the subscript state of the cell format of the current selection based on the subscript state of the active cell.

  • toggleSuperscript

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    162

    Changes the superscript state of the cell format of the current selection based on the superscript state of the active cell.

  • toggleTableTotalRow

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    183

    Changes the visibility of the total row in the activeTable.

  • toggleUnderline

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    160

    Changes the underline state of the cell format of the current selection based on the underline state of the active cell.

  • toggleWrapText

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    122

    Changes the wrap state of the cell format of the current selection based on the wrap state of the active cell.

  • undo

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    86

    Used to reverse the last change operation.

  • unhideColumns

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    90

    Sets the RowColumnBase.hidden to false for the columns associated with the activeSelection.

  • unhideRows

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    92

    Sets the RowColumnBase.hidden to false for the rows associated with the activeSelection.

  • unmergeCells

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    98

    Split the current cell in multiple cells

  • unselectWorksheets

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    112

    Clears the selected worksheet tabs such that only the active tab is selected.

  • zoomIn

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    115

    Changes the magnification of the currently selected Worksheet of the Spreadsheet to a higher value in increments of 10%

  • zoomOut

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    116

    Changes the magnification of the currently selected Worksheet of the Spreadsheet to a lower value in increments of 10%

  • zoomTo100

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    118

    Changes the magnification of the currently selected Worksheet of the Spreadsheet to 100%

  • zoomToSelection

    Type:
    ig.spreadsheet.SpreadsheetAction
    Default:
    117

    Changes the magnification of the currently selected Worksheet to display the currently selected cells.

The current widget has no events.
The current widget has no public methods.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.