Search
WorkbookView Methods
 


 Public Methods

  Name Description

addViewListener

 

beginEdit

Initiates in-place edit of the specified in-place editable object.

bringIntoView

Overloaded.  

cancelDrag

Cancels any drag or select interactions currently performed by user.

copy

Overloaded.  

cut

Overloaded.  

endEdit

Completes the in-place editing operation, previously started by a call to beginEdit, and accepts or cancel the change.

freezePanes

Overloaded.  

getActiveBorderPen

Gets the Pen used to draw borders of current active cell.

getActiveCell

Gets the currently active cell.

getActiveWorksheet

Gets the currently active worksheet.

getAllowAutoFill

Gets a value indicating whether to display the auto-fill handle at the bottom-right side of the selection.

getAllowMoveCells

Gets a value indicating whether the user can interactively move cells around the worksheet, by pressing near the edge of the currently selected cells with the mouse and dragging.

getAllowMoveHeaders

Gets a value indicating whether the user can interactively move the worksheet headers, by selecting the entire column or row and dragging.

getAllowResizeHeaders

Gets a value indicating whether the user can interactively resize the worksheet headers.

getAllowTabEdit

Gets a value indicating whether tabs can be in-place edited.

getAllowTabReorder

Gets a value indicating whether tabs can be rearranged interactively.

getArrowActions

Gets what action should be performed by left/right arrow buttons in tab strip.

getAutoFillCursor

Gets the mouse cursor shown to the user if the mouse is over the auto fill handle or the user is currently performing an auto fill operation.

getAutoFillSkipMerged

Gets whether auto-fill should skip cells spanned by a merged cell.

getBackColor

Gets the background color of the view.

getCellAt

Overloaded. Gets the cell at a specified coordinates.

getColumnHeaderHeight

Gets the height of the column header.

getCounterDiagonalResizeCursor

Gets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.

getDiagonalResizeCursor

Gets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.

getDisallowCursor

Gets the mouse cursor shown to the user when an object cannot be created at a given location.

getDrawFilledCellBorders

Gets a value indicating whether to draw the default grid lines for cells with set background.

getFirstVisibleFrozenColumn

Gets the leftmost visible frozen column.

getFirstVisibleFrozenRow

Gets the topmost visible frozen row.

getFormulasInClipboard

 

getFrozenColumnCount

Gets the number of frozen columns in the view.

getFrozenRowCount

Gets the number of frozen rows in the view.

getHorizontalResizeCursor

Gets the mouse cursor shown to the user if dragging would resize an object horizontally.

getHorizontalSplitCursor

Gets the mouse cursor shown to the user if dragging would resize rows.

getHScrollToolTipFormat

Gets the format of the tooltip that is displayed when the view is scrolled horizontally.

getHyperlinkCursor

Gets the mouse cursor shown to the user if the mouse is over a cell containing a hyperlink.

getLicenseKey

Gets the license key of the control.

getMaxTabSize

Gets the maximum size of tabs representing worksheets in the tab strip. Default value is 100.

getMoveCursor

Gets the mouse cursor shown to the user if the pointed object can be modified.

getPasteToMerged

Gets how to handle pasting data into merged cells.

getPointerCursor

Gets the mouse cursor shown to the user when no modification is performed.

getResizeColumnToolTipFormat

Gets the format of the tooltip that is displayed when a column is resized interactively.

getResizeRowToolTipFormat

Gets the format of the tooltip that is displayed when a row is resized interactively.

getRowHeaderWidth

Gets the width of the row header.

getScrollX

Gets the value of the horizontal scrollbar.

getScrollY

Gets the value of the vertical scrollbar.

getSelection

Gets an object that can be used to manipulate the selection in the view.

getSelectionType

Gets the selection type

getShowActiveCell

Gets a value indicating whether to display the active cell.

getShowAutoFilterRange

Gets a value indicating whether to display the range affected by the autofilter.

getShowCreateNewTab

Gets a value indicating whether to display the 'Create New Tab' button.

getShowFormulaBar

Gets a value indicating whether to display the formula bar.

getShowGridLines

Gets a value indicating whether to display the grid lines.

getShowHeaders

Gets a value indicating whether to display the row and column headers.

getShowHiddenHeaderIndicators

Gets a value indicating whether to display indicators for hidden row and column headers.

getShowHorizontalScrollBar

Gets a value indicating whether to display the horizontal scroll bar.

getShowResizeHeaderToolTips

Gets a value indicating whether to display tooltips when the user resizes row or column headers.

getShowScrollToolTips

Gets a value indicating whether to display tooltips when scrolling with the thumb.

getShowSelection

Gets a value indicating whether to display the cell selection.

getShowTabCloseButtons

Gets a value indicating whether to display a close button for each tab.

getShowTabNavigationButtons

Gets a value indicating whether the tab navigation buttons.

getShowTabs

Gets a value indicating whether the tabs are visible.

getShowVerticalScrollBar

Gets a value indicating whether to display the vertical scroll bar.

getTabAlignment

Gets the tabs alignment.

getValidateOnPaste

Gets a value indicating whether to validate pasted data

getVerticalResizeCursor

Gets the mouse cursor shown to the user if dragging would resize an object vertically.

getVerticalSplitCursor

Gets the mouse cursor shown to the user if dragging would resize columns.

getVScrollToolTipFormat

Gets the format of the tooltip that is displayed when the view is scrolled vertically.

getWorkbook

Gets the Workbook displayed in the view.

isEditing

Gets a value indicating whether there is currently an in-place editing operation in progress within the view.

isFocusOnCell

Gets if keyboard focus is currently on a cell.

paste

Pastes the data from the clipboard inside the currently selected cells.

removeViewListener

 

requestFocus

 

resizeColumnsToFit

Resizes view columns to fit their contents.

resizeColumnToFit

Resizes a view column to fit its contents.

resizeRowsToFit

Overloaded.  

resizeRowToFit

Resizes a view row to fit its contents.

setActiveBorderPen

Sets the Pen used to draw borders of current active cell.

setActiveCell

Sets the currently active cell.

setActiveWorksheet

Sets the currently active worksheet.

setAllowAutoFill

Sets a value indicating whether to display the auto-fill handle at the bottom-right side of the selection.

setAllowMoveCells

Sets a value indicating whether the user can interactively move cells around the worksheet, by pressing near the edge of the currently selected cells with the mouse and dragging.

setAllowMoveHeaders

Sets a value indicating whether the user can interactively move the worksheet headers, by selecting the entire column or row and dragging.

setAllowResizeHeaders

Sets a value indicating whether the user can interactively resize the worksheet headers.

setAllowTabEdit

Sets a value indicating whether tabs can be in-place edited.

setAllowTabReorder

Sets a value indicating whether tabs can be rearranged interactively.

setArrowActions

Sets what action should be performed by left/right arrow buttons in tab strip.

setAutoFillCursor

Sets the mouse cursor shown to the user if the mouse is over the auto fill handle or the user is currently performing an auto fill operation.

setAutoFillSkipMerged

Sets whether auto-fill should skip cells spanned by a merged cell.

setBackColor

Sets the background color of the view.

setColumnHeaderHeight

Sets the height of the column header, or null, to automatically size the column headers.

setCounterDiagonalResizeCursor

Sets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.

setDiagonalResizeCursor

Sets the mouse cursor shown to the user if dragging would resize an object both vertically and horizontally.

setDisallowCursor

Sets the mouse cursor shown to the user when an object cannot be created at a given location.

setDrawFilledCellBorders

Sets a value indicating whether to draw the default grid lines for cells with set background.

setFirstVisibleFrozenColumn

Sets the leftmost visible frozen column.

setFirstVisibleFrozenRow

Sets the topmost visible frozen row.

setFocusOnCell

Sets if keyboard focus is currently on a cell.

setFormulasInClipboard

 

setFrozenColumnCount

Sets the number of frozen columns in the view.

setFrozenRowCount

Sets the number of frozen rows in the view.

setHorizontalResizeCursor

Sets the mouse cursor shown to the user if dragging would resize an object horizontally.

setHorizontalSplitCursor

Sets the mouse cursor shown to the user if dragging would resize rows.

setHScrollToolTipFormat

Sets the format of the tooltip that is displayed when the view is scrolled horizontally.

setHyperlinkCursor

Sets the mouse cursor shown to the user if the mouse is over a cell containing a hyperlink.

setLicenseKey

Sets the license key of the control.

setMaxTabSize

Sets the maximum size of tabs representing worksheets in the tab strip.

setMoveCursor

Gets the mouse cursor shown to the user if the pointed object can be modified.

setPasteToMerged

Sets how to handle pasting data into merged cells.

setPointerCursor

Sets the mouse cursor shown to the user when no modification is performed.

setResizeColumnToolTipFormat

Sets the format of the tooltip that is displayed when a column is resized interactively.

setResizeRowToolTipFormat

Sets the format of the tooltip that is displayed when a row is resized interactively.

setRowHeaderWidth

Sets the width of the row header, or null, to automatically size the row headers.

setScrollX

Sets the value of the horizontal scrollbar.

setScrollY

Sets the value of the vertical scrollbar.

setSelectionType

Sets the selection type

setShowActiveCell

Sets a value indicating whether to display the active cell.

setShowAutoFilterRange

Sets a value indicating whether to display the range affected by the autofilter.

setShowCreateNewTab

Gets a value indicating whether to display the 'Create New Tab' button.

setShowFormulaBar

Sets a value indicating whether to display the formula bar.

setShowGridLines

Sets a value indicating whether to display the grid lines.

setShowHeaders

Sets a value indicating whether to display the row and column headers.

setShowHiddenHeaderIndicators

Sets a value indicating whether to display indicators for hidden row and column headers.

setShowHorizontalScrollBar

Sets a value indicating whether to display the horizontal scroll bar.

setShowResizeHeaderToolTips

Sets a value indicating whether to display tooltips when the user resizes row or column headers.

setShowScrollToolTips

Sets a value indicating whether to display tooltips when scrolling with the thumb.

setShowSelection

Sets a value indicating whether to display the cell selection.

setShowTabCloseButtons

Sets a value indicating whether to display a close button for each tab.

setShowTabNavigationButtons

Sets a value indicating whether the tab navigation buttons.

setShowTabs

Sets a value indicating whether the tabs are visible.

setShowVerticalScrollBar

Sets a value indicating whether to display the vertical scroll bar.

setTabAlignment

Sets the tabs alignment.

setValidateOnPaste

Sets a value indicating whether to validate pasted data

setVerticalResizeCursor

Sets the mouse cursor shown to the user if dragging would resize an object vertically.

setVerticalSplitCursor

Sets the mouse cursor shown to the user if dragging would resize columns.

setVScrollToolTipFormat

Sets the format of the tooltip that is displayed when the view is scrolled vertically.

setWorkbook

Sets the Workbook displayed in the view.

toGlobalX

Converts the specified measure, relative to the left side of the specified cell, to a measure, relative to the left side of the entire worksheet.

toGlobalY

Converts the specified measure, relative to the top side of the specified cell, to a measure, relative to the top side of the entire worksheet.

toLocalX

Converts the specified measure, relative to the left side of the worksheet, to a measure, relative to the left side of the specified cell.

toLocalY

Converts the specified measure, relative to the top side of the worksheet, to a measure, relative to the top side of the specified cell.

unfreezePanes

Unfreezes any frozen columns or rows.

 Protected Methods

  Name Description

onActivatingCell

Raises the activatingCell event.

onActiveCellChanged

Raises the ActiveCellChanged event.

onActiveWorksheetChanged

Raises the activeWorksheetChanged event.

onCellClicked

Raises the cellClicked event.

onColumnClicked

Raises the columnClicked event.

onColumnGroupCollapsed

Raises the columnGroupCollapsed event.

onColumnGroupExpanded

Raises the columnGroupExpanded event.

onColumnOutlineLevelToggled

Raises the columnOutlineLevelToggled event.

onColumnsMoved

Raises the columnsMoved event.

onColumnsResized

Raises the columnsResized event.

onDrawCell

Raises the drawCell event.

onDrawColumn

Raises the drawColumn event.

onDrawRow

Raises the drawRow event.

onDropDownValueSelected

Raises the WorkbookViewListener.dropDownValueSelected event.

onHyperlinkClicked

Raises the hyperlinkClicked event.

onInplaceEditEnded

Raises the inplaceEditEnded event.

onInplaceEditEnding

Raises the inplaceEditEnding event.

onInplaceEditStarted

Raises the inplaceEditStarted event.

onInplaceEditStarting

Raises the inplaceEditStarting event.

onObjectClicked

Raises the objectClicked event.

onObjectDeleted

Raises the objectDeleted event.

onObjectDeleting

Raises the objectDeleting event.

onObjectDeselected

Raises the objectDeselected event.

onObjectModified

Raises the objectModified event.

onObjectModifyCancelled

Raises the objectModifyCancelled event.

onObjectModifying

Raises the objectModifying event.

onObjectSelected

Raises the objectSelected event.

onObjectSelecting

Raises the objectSelecting event.

onObjectStartModifying

Raises the objectStartModifying event.

onPropertyChanged

Raises the PropertyChanged event.

onQueryDropDownList

Raises the WorkbookViewListener.queryDropDownList event.

onRowClicked

Raises the rowClicked event.

onRowGroupCollapsed

Raises the rowGroupCollapsed event.

onRowGroupExpanded

Raises the RowGroupExpanded event.

onRowOutlineLevelToggled

Raises the rowOutlineLevelToggled event.

onRowsMoved

Raises the rowsMoved event.

onRowsResized

Raises the rowsResized event.

onSelectionChanged

Raises the selectionChanged event.

onWorksheetAdded

Raises the worksheetAdded event.

onWorksheetRemoved

Raises the worksheetRemoved event.

onWorksheetRemoving

Raises the worksheetRemoving event.

onWorksheetRenamed

Raises the worksheetRenamed event.

onWorksheetRenameFailed

Raises the worksheetRenameFailed event.

onWorksheetTabClicked

Raises the worksheetTabClicked event.

 See Also