Search
WorkbookView Members
Constructors Properties Methods Events
 


Represents a control that can display Workbook objects.

The following tables list the members exposed by the WorkbookView type.

 Public Constructors

  Name Description

WorkbookView

Initializes a new instance of the WorkbookView class.

 Public Properties

  Name Description

ActiveCell

Gets or sets the currently active cell.

ActiveWorksheet

Gets or sets the currently active worksheet.

AllowAutoFill

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

AllowMoveCells

Gets or 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.

AllowMoveHeaders

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

AllowResizeCells

Gets or sets a value indicating whether users can resize rows and columns by dragging cell borders.

AllowTabEdit

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

AllowTabReorder

Gets or sets a value indicating whether tabs can be rearranged interactively.

AutoFillCopyOnly

Gets or sets whether the auto-fill tool should only copy values, instead of extrapolating new values from the selection.

AutoFillCursor

Gets or 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.

BackColor

Gets or sets the background color of the view.

ColumnHeaderHeight

Gets or sets the height of the column header, or null (Nothing in Visual Basic), to automatically size the column headers.

CounterDiagonalResizeCursor

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

DiagonalResizeCursor

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

DisallowCursor

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

DrawFilledCellBorders

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

HorizontalResizeCursor

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

HorizontalSplitCursor

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

HScrollToolTipFormat

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

HyperlinkCursor

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

IsEditing

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

LicenseKey

Gets or sets the license key of the control.

MoveCursor

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

PointerCursor

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

ResizeColumnToolTipFormat

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

ResizeRowToolTipFormat

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

RowHeaderWidth

Gets or sets the width of the row header, or null (Nothing in Visual Basic), to automatically size the row headers.

ScrollX

Gets or sets the value of the horizontal scrollbar.

ScrollY

Gets or sets the value of the vertical scrollbar.

Selection

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

ShowActiveCell

Gets or sets a value indicating whether to display the active cell.

ShowAutoFilterRange

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

ShowCreateNewTab

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

ShowFormulaBar

Gets or sets a value indicating whether to display the formula bar.

ShowGridLines

Gets or sets a value indicating whether to display the grid lines.

ShowHeaders

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

ShowHiddenHeaderIndicators

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

ShowHorizontalScrollBar

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

ShowResizeHeaderToolTips

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

ShowScrollToolTips

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

ShowSelection

Gets or sets a value indicating whether to display the cell selection.

ShowTabCloseButtons

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

ShowTabNavigationButtons

Gets or sets a value indicating whether the tab navigation buttons.

ShowTabs

Gets or sets a value indicating whether the tabs are visible.

ShowVerticalScrollBar

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

TabAlignment

Gets or sets the tabs alignment.

VerticalResizeCursor

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

VerticalSplitCursor

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

VScrollToolTipFormat

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

Workbook

Gets or sets the Workbook displayed in the view.

 Public Methods

  Name Description

BeginEdit

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

BringIntoView

Scrolls the view to make the specified cell visible.

Copy

Copies the data from the currently selected cells to the clipboard.

Cut

Cuts the data from the currently selected cells to the clipboard.

EndEdit

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

GetCellAt

Overloaded. Gets the cell at the specified coordinates.

Paste

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

ResizeColumnsToFit

Resizes view columns to fit their contents.

ResizeColumnToFit

Resizes a view column to fit its contents.

ResizeRowsToFit

Resizes view rows to fit their contents.

ResizeRowToFit

Resizes a view row to fit its contents.

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.

 Protected Methods

  Name Description

Dispose

Clean up any resources being used.

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.

OnColumnsMoving

Raises the ColumnsMoving event.

OnColumnsResized

Raises the ColumnsResized event.

OnColumnsResizing

Raises the ColumnsResizing event.

OnDrawColumn

Raises the DrawColumn event.

OnDrawRow

Raises the DrawRow 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.

OnLoad

UserControl.OnLoad override.

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.

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.

OnRowsMoving

Raises the RowsMoving event.

OnRowsResized

Raises the RowsResized event.

OnRowsResizing

Raises the RowsResizing 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.

 Public Events

  Name Description

ActiveCellChanged

Raised when the active cell is changed.

ActiveWorksheetChanged

Raised when the currently active worksheet is changed.

CellClicked

Raised when a cell of the active worksheet is clicked.

ColumnClicked

Raised when a column of the active worksheet is clicked.

ColumnGroupCollapsed

Raised when a column group has been collapsed interactively.

ColumnGroupExpanded

Raised when a column group has been expanded interactively.

ColumnOutlineLevelToggled

Raised when a column outline level has been activated interactively.

ColumnsMoved

Raised when one or more columns are moved interactively.

ColumnsMoving

Raised when one or more columns are being moved interactively.

ColumnsResized

Raised when one or more columns are resized interactively.

ColumnsResizing

Raised when one or more columns are being resized interactively.

DrawColumn

Raised to allow custom drawing of view columns.

DrawRow

Raised to allow custom drawing of view rows.

HyperlinkClicked

Raised when a cell containing a hyperlink is clicked.

InplaceEditEnded

Raised when an inplace-edit operation has finished.

InplaceEditEnding

Raised when an in-place edit operation is about to finish, before the in-place editor is closed.

InplaceEditStarted

Raised when an in-place edit operation has started, after the in-place editor is displayed.

InplaceEditStarting

Raised when an in-place edit operation is about to start, before the in-place editor is displayed.

ObjectClicked

Raised when an object of the active worksheet is clicked.

ObjectDeleted

Raised when an object is deleted interactively.

ObjectDeleting

Raised when an object is about to be deleted interactively.

ObjectDeselected

Raised when an object is deselected, either programmatically or interactively.

ObjectModified

Raised when the user completes the modification of an object.

ObjectModifyCancelled

Raised when the user cancels the modification of an object.

ObjectModifying

Raised when the user starts modifying an interactive object.

ObjectSelected

Raised when an object is selected, either programmatically or interactively.

ObjectSelecting

Raised when the user is about to select an object.

ObjectStartModifying

Raised while the user is moving or resizing an interactive object.

RowClicked

Raised when a row of the active worksheet is clicked.

RowGroupCollapsed

Raised when a row group has been collapsed interactively.

RowGroupExpanded

Raised when a row group has been expanded interactively.

RowOutlineLevelToggled

Raised when a row outline level has been activated interactively.

RowsMoved

Raised when one or more rows are moved interactively.

RowsMoving

Raised when one or more rows are being moved interactively.

RowsResized

Raised when one or more rows are resized interactively.

RowsResizing

Raised when one or more rows are being resized interactively.

SelectionChanged

Raised when the current cell selection is changed interactively.

WorksheetAdded

Raised when a new worksheet is added to the view interactively, that is, when the user clicks on the 'Create New Tab' button.

WorksheetRemoved

Raised when a worksheet is removed interactively, that is, when the user clicks the close button of its associated tab.

WorksheetRemoving

Raised when a worksheet is about to be removed interactively, that is, when the user clicks the close button of its associated tab.

WorksheetRenamed

Raised when a worksheet is renamed through in-place edit.

WorksheetRenameFailed

Raised when a worksheet in-place edit failed due to repeating names.

WorksheetTabClicked

Raised when a worksheet tab is clicked with the mouse.

 See Also