Spread Windows Forms 17
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / SpreadView Class
Fields Properties Methods


In This Topic
    SpreadView Class Members
    In This Topic

    The following tables list the members exposed by SpreadView.

    Public Constructors
     NameDescription
    Public ConstructorSpreadView ConstructorCreates a new view for the spreadsheet display.  
    Top
    Public Fields
     NameDescription
    Public FieldCollapseImageSpecifies the index, 2, for the image for the collapse icon in a hiearchical display.  
    Public FieldCollapseImageDisabledSpecifies the index, 3, for the image for the disabled collapse icon in a hiearchical display.  
    Public FieldEditingRowSelectorSpecifies the index, 19, for the image for the row editing indicator.  
    Public FieldEnhancedFilterActiveSpecifies the index, 28, for the image for the enhanced active filter indicator.  
    Public FieldEnhancedFilterActiveDisabledSpecifies the index, 29, for the image for the enhanced disabled active filter indicator.  
    Public FieldEnhancedFilterInactiveSpecifies the index, 30, for the image for the enhanced inactive filter indicator.  
    Public FieldEnhancedFilterInactiveDisabledSpecifies the index, 31, for the image for the enhanced disabled inactive filter indicator.  
    Public FieldEnhancedFilterSortAscendingSpecifies the index, 20, for the image for the enhanced ascending filter sort indicator.  
    Public FieldEnhancedFilterSortAscendingDisabledSpecifies the index, 21, for the image for the enhanced disabled ascending filter sort indicator.  
    Public FieldEnhancedFilterSortDescendingSpecifies the index, 24, for the image for the enhanced descending filter sort indicator.  
    Public FieldEnhancedFilterSortDescendingDisabledSpecifies the index, 25, for the image for the enhanced disabled descending filter sort indicator.  
    Public FieldEnhancedSortAscendingSpecifies the index, 22, for the image for the enhanced ascending sort indicator.  
    Public FieldEnhancedSortAscendingDisabledSpecifies the index, 23, for the image for the enhanced disabled ascending sort indicator.  
    Public FieldEnhancedSortDescendingSpecifies the index, 26, for the image for the enhanced descending sort indicator.  
    Public FieldEnhancedSortDescendingDisabledSpecifies the index, 27, for the image for the enhanced disabled descending sort indicator.  
    Public FieldExpandImageSpecifies the index, 0, for the image for the expand icon in a hiearchical display.  
    Public FieldExpandImageDisabledSpecifies the index, 1, for the image for the disabled expand icon in a hiearchical display.  
    Public FieldFilterActiveSpecifies the index, 10, for the image for the active filter indicator.  
    Public FieldFilterActiveDisabledSpecifies the index, 11, for the image for the disabled active filter indicator.  
    Public FieldFilterBarFilterActiveSpecifies the index, 16, for the image for the active filterbar indicator.  
    Public FieldFilterBarFilterDateTimeSpecifies the index, 18, for the image for the filterbar calendar indicator.  
    Public FieldFilterBarFilterInactiveSpecifies the index, 17, for the image for the inactive filterbar indicator.  
    Public FieldFilterInactiveSpecifies the index, 8, for the image for the inactive filter indicator.  
    Public FieldFilterInactiveDisabledSpecifies the index, 9, for the image for the disabled inactive filter indicator.  
    Public FieldRowSelectorImageSpecifies the index, 14, for the image for the row selector.  
    Public FieldRowSelectorImageDisabledSpecifies the index, 15, for the image for the disabled row selector.  
    Public FieldSortAscendingImageSpecifies the index, 4, for the image for the ascending sort indicator.  
    Public FieldSortAscendingImageDisabledSpecifies the index, 5, for the image for the disabled ascending sort indicator.  
    Public FieldSortDescendingImageSpecifies the index, 6, for the image for the descending sort indicator.  
    Public FieldSortDescendingImageDisabledSpecifies the index, 7, for the image for the disabled descending sort indicator.  
    Public FieldSortUnsortedImageSpecifies the index, 12, for the image for the unsorted sort indicator.  
    Public FieldSortUnsortedImageDisabledSpecifies the index, 13, for the image for the disabled unsorted sort indicator.  
    Top
    Protected Fields
     NameDescription
    Protected Fieldstatic (Shared in Visual Basic)tabButtonThemeInternal use only.  
    Protected Fieldstatic (Shared in Visual Basic)tabThemeInternal use only.  
    Top
    Public Properties
     NameDescription
    Public PropertyActiveSheetIndexGets or sets the active sheet in the view.  
    Public PropertyAllowCellContentFloatGets or sets whether to allow the cell content to float.  
    Public PropertyAllowCellOverflowGets or sets whether data can overflow into adjacent empty cells in the view.  
    Public PropertyAllowColumnMoveGets or sets whether to allow the user to move columns.  
    Public PropertyAllowColumnMoveMultipleGets or sets whether to allow the user to move multiple columns.  
    Public PropertyAllowDragDropGets or sets whether to allow the user to drag and drop a range of cells in the view.  
    Public PropertyAllowDragFillGets or sets whether to allow the user to drag and fill cells with the contents of a cell or cells in the view.  
    Public PropertyAllowEditorReservedLocationsGets or sets whether cell editor reserved mouse locations are allowed.  
    Public PropertyAllowEditOverflowGets or sets whether data can overflow into adjacent empty cells while edit mode is on in a cell in the view.  
    Public PropertyAllowRowMoveGets or sets whether to allow the user to move rows.  
    Public PropertyAllowRowMoveDataAllowAddNewGets or sets a value that indicates whether to allow moving the add new row or asterisk row.  
    Public PropertyAllowRowMoveMultipleGets or sets whether to allow the user to move multiple rows.  
    Public PropertyAllowSheetMoveGets or sets whether sheets can be moved by dragging and dropping the sheet tab.  
    Public PropertyAllowUndoGets or sets whether to allow the user to undo edit operations.  
    Public PropertyAllowUserFormulasGets or sets whether to allow the user to enter formulas in a cell in the view.  
    Public PropertyAllowUserZoomGets or sets whether to allow the user to scale the view using the Ctrl key and the mouse wheel.  
    Public PropertyAutoClipboardGets or sets whether to allow shortcut keys for Clipboard actions in the view.  
    Public PropertyAutoFitColumnOptionsGets or sets the behavior of automatic fit when double-clicking the right edge of the column header.  
    Public PropertyAutoFitRowOptionsGets or sets the behavior of automatic fit when double-clicking the bottom edge of the row header.  
    Public PropertyAutoImeModeGets or sets whether to use the CharacterSet property on non-edit mode cells.  
    Public PropertyBorderCollapseGets or sets whether adjacent cell borders are collapsed into a single line in the view.  
    Public PropertyBoundsGets the size and location of the view.  
    Public PropertyButtonDrawModeGets or sets whether to display buttons in button and combo box cells in the view.  
    Public PropertyCellNoteIndicatorRendererGets or sets the cell note indicator renderer.  
    Public PropertyCellNoteIndicatorVisibleGets or sets whether the cell note indicator appears in cells in the view.  
    Public PropertyCellSpanSelectionPolicyGets or sets the selection model to use when working with a span.  
    Public PropertyClipboardOptionsGets or sets whether headers and the filter bar are included with data in Clipboard actions in the view.  
    Public PropertyClipboardPasteToFillGets or sets whether a single cell copied to the Clipboard fills the range when pasted from the Clipboard to the component.  
    Public PropertyColumnSplitBoxAlignmentGets or sets the alignment of the column split box relative to the horizontal scroll bar in the view.  
    Public PropertyColumnSplitBoxPolicyGets or sets when to display the column split box in the view.  
    Public PropertyCustomFillSeriesListGets the custom list for drag fill in series mode.  
    Public PropertyDragFillDataOnlyGets or sets a value that indicates whether the drag fill action copies data only.  
    Public PropertyEditingControlGets the contol editing the active cell, or null if the control is not in edit mode.  
    Public PropertyEditModeGets or sets whether the active cell in the view is in edit mode.  
    Public PropertyEditModePermanentGets or sets whether edit mode remains on for any cell in the view when that cell becomes active.  
    Public PropertyEditModeReplaceGets or sets whether the existing text in a cell in the view is selected when the cell enters edit mode.  
    Public PropertyEnableDragFillMenuGets or sets a value to show drag fill button and drag fill context menu.  
    Public PropertyErrorIconRendererGets or sets the renderer for the error icon.  
    Public PropertyFocusRendererGets or sets a renderer for drawing the focus rectangle in the view.  
    Public PropertyHorizontalScrollBarGets the horizontal scroll bar.  
    Public PropertyHorizontalScrollBarHeightGets or sets the height of horizontal scroll bars in the view.  
    Public PropertyHorizontalScrollBarPolicyGets or sets when to display the horizontal scroll bars in the view.  
    Public PropertyHorizontalScrollBarSmallChangeGets or sets the small increment for the horizontal scrollbar.  
    Public PropertyInterfaceRendererGets or sets the interface renderer.  
    Public PropertyLeftTabGets or sets the left most sheet tab in the tab strip in the view.  
    Public PropertyMoveActiveOnFocusGets or sets whether the location of the active cell in the view moves when the user moves the focus to the view using the mouse.  
    Public PropertyOwnerGets the Spread component that owns this view.  
    Public PropertyParentGets the parent (SpreadView object) of the view.  
    Public PropertyRangeDragFillModeGets or sets the mode the user can use to drag and fill cells in the component using the contents of a cell or cells.  
    Public PropertyRetainSelectionBlockGets or sets whether the selected range of cells in the view remains highlighted when the view loses the focus.  
    Public PropertyRowSplitBoxAlignmentGets or set the alignment of the row split box relative to the vertical scroll bar in the view.  
    Public PropertyRowSplitBoxPolicyGets or sets when to display the row split box in the view.  
    Public PropertyScrollBarMaxAlignGets or sets the scroll bar alignment with the last row and column of the spreadsheet in the view.  
    Public PropertyScrollBarShowMaxGets or sets whether the user can use the scroll box to scroll through all the columns and rows in the view, or just a limited number of them.  
    Public PropertyScrollBarTrackPolicyGets or sets how the control scrolls the sheet when the user moves the scroll box.  
    Public PropertyScrollTipPolicyGets or sets whether scroll tips appear when the user moves the scroll box.  
    Public PropertySelectionBlockOptionsGets or sets which types of selections the user can make in the view.  
    Public PropertySelectionRendererGets or sets a renderer for drawing selections in the view.  
    Public PropertySheetsGets the sheets in the view.  
    Public PropertyShowCellErrorsGets or sets whether to allow the user to display a cell error using an icon or sticky note for cells in the view.  
    Public PropertyShowDragBandOnMovingGets or sets whether the drag band is displayed when moving a row or column.  
    Public PropertyShowRowErrorsGets or sets whether to allow the user to display a row error using an icon or sticky note for cells in the view.  
    Public PropertySkinGets or sets the skin for the spread.  
    Public PropertySpreadScaleModeGets or sets whether Spread controls automatic scaling with a different system dpi; Spread only supports one dimension so the application should use AutoScaleMode.Dpi for correct scaling, or else scale using the application width.  
    Public PropertySuspendAnimationsGets or sets whether animations, such as an animated focus renderer, in the view are suspended.  
    Public PropertyTabStripInsertTabGets or sets whether the special insert tab is present on the tab strip.  
    Public PropertyTabStripInsertTabImageGets or sets the tabstrip insert-tab image.  
    Public PropertyTabStripPlacementGets or sets the location of the tab strip in the view.  
    Public PropertyTabStripPolicyGets or sets the display policy for the tab strip in the view.  
    Public PropertyTabStripRatioGets or sets the width of the tab strip in the view expressed as a percentage of the overall horizontal width of the control.  
    Public PropertyTextTipAppearanceGets or sets the appearance of text tips in the view.  
    Public PropertyTextTipDelayGets or sets the time (in milliseconds) the control waits before displaying the text tip for the cell or header under the pointer in the view.  
    Public PropertyTextTipPolicyGets or sets whether to display text tips and the location of the tips in the view.  
    Public PropertyUndoManagerGets or sets the undo manager for the SpreadView.  
    Public PropertyVerticalScrollBarGets the vertical scroll bar.  
    Public PropertyVerticalScrollBarPolicyGets or sets when to display the vertical scroll bars in the view.  
    Public PropertyVerticalScrollBarSmallChangeGets or sets the small increment for the vertical scrollbar.  
    Public PropertyVerticalScrollBarWidthGets or sets the width of vertical scroll bars in the view.  
    Public PropertyVisualStylesGets or sets whether to use visual styles when rendering objects in the control.  
    Top
    Public Methods
     NameDescription
    Public MethodAddViewportOverloaded. Adds a row or column of viewports.  
    Public MethodCancelCellEditingCancels cell editing in the view.  
    Public MethodCancelFilterBarEditingCancels cell editing in the filter bar.  
    Public MethodExpandRowExpands or collapses the specified parent row, which shows or hides the child view in a hierarchical display.  
    Public MethodGetActionMapGets the action map.  
    Public MethodGetActiveColumnViewportIndexOverloaded. Gets the index of the active viewport column.  
    Public MethodGetActiveRowViewportIndexOverloaded. Gets the index of the active viewport row.  
    Public MethodGetActiveWorkbookGets the active view (SpreadView object).  
    Public MethodGetCellFromPixelOverloaded. Gets the row and column indexes of the cell at the specified pointer location.  
    Public MethodGetCellRectangleGets the rectangle of the cell.  
    Public MethodGetChildWorkbooksGets all child views (SpreadView objects) that have been created.  
    Public MethodGetColumnFooterCellRectangleGets the rectangle of the cell in the column footer.  
    Public MethodGetColumnHeaderCellFromPixelOverloaded. Gets the row and column indexes of the column header cell at the specified pointer location.  
    Public MethodGetColumnHeaderCellRectangleGets the rectangle of the cell in the column header.  
    Public MethodGetColumnHeaderRectangleGets the rectangle of the column header.  
    Public MethodGetColumnRangeGroupHeightGets the height of the column range group.  
    Public MethodGetColumnSplitBarRectangleGets the rectangle of the column split bar.  
    Public MethodGetColumnSplitBoxRectangleGets the rectangle of the column split box.  
    Public MethodGetColumnViewportCountOverloaded. Gets the number of viewport columns in the active sheet.  
    Public MethodGetColumnViewportIndexFromXGets the index of the viewport column for the specified coordinate for the active sheet.  
    Public MethodGetCursorGets the pointer displayed over a specific area in the view.  
    Public MethodGetFilterBarHeaderRectangleGets the rectangle of the column header.  
    Public MethodGetFilterBarRectangleGets the rectangle of the filter bar.  
    Public MethodGetFloatCellReturns the floating cell range for the specified cell.  
    Public MethodGetFloatCellsReturns all floating cell ranges for the view.  
    Public MethodGetHorizontalScrollBarRectangleGets the rectangle of the horizontal scroll bar.  
    Public MethodGetImageGets the graphic image used in the specified part of the user interface.  
    Public MethodGetInputMapOverloaded. Gets the input map defined for the specified focus mode for the view.  
    Public MethodGetInputMapWhenChildHasFocusGets the input map for the view for when a child object has focus.  
    Public MethodGetInputMapWhenShapeHasFocusGets the input map for the view for when a shape has focus.  
    Public MethodGetMaximumCellOverflowWidthGets the maximum cell overflow width in pixels for cells in the view.  
    Public MethodGetMergeCellReturns the merged cell range for the specified cell.  
    Public MethodGetMergeCellsReturns all merged cell ranges for the view.  
    Public MethodGetObjectDataSaves the view to the SerializationInfo object.  
    Public MethodGetRootWorkbookGets the top view (SpreadView object).  
    Public MethodGetRowHeaderCellFromPixelOverloaded. Gets the row and column indexes of the row header cell at the specified pointer location.  
    Public MethodGetRowHeaderCellRectangleGets the rectangle of the cell in the row header.  
    Public MethodGetRowHeaderRectangleGets the rectangle of the row header.  
    Public MethodGetRowRangeGroupWidthGets the width of the row range group.  
    Public MethodGetRowSplitBarRectangleGets the rectangle of the row split bar.  
    Public MethodGetRowSplitBoxRectangleGets the rectangle of the row split box.  
    Public MethodGetRowViewportCountOverloaded. Gets the number of viewport rows in the active sheet.  
    Public MethodGetRowViewportIndexFromYGets the index of the viewport row for the specified coordinate for the active sheet.  
    Public MethodGetSheetTabRectangleGets the rectangle of the tab associated with a sheet for the view.  
    Public MethodGetSheetViewGets the active sheet view.  
    Public MethodGetSpreadViewGets the view at the specified sheet and viewport.  
    Public MethodGetTabSplitBoxRectangleGets the rectangle of the split box on the tab strip.  
    Public MethodGetTabStripRectangleGets the rectangle of the tab strip.  
    Public MethodGetVerticalScrollBarRectangleGets the rectangle of the vertical scroll bar.  
    Public MethodGetViewportBottomRowOverloaded. Gets the row after the last row of the specified viewport for the active sheet.  
    Public MethodGetViewportHeightOverloaded. Gets the height of the specified viewport row for the active sheet.  
    Public MethodGetViewportLeftColumnOverloaded. Gets the index of the left most column of the specified viewport column.  
    Public MethodGetViewportLeftOffsetGets the offset of the view port from a particular column to the left.  
    Public MethodGetViewportPreferredHeightOverloaded. Gets the maximum height for the viewport row.  
    Public MethodGetViewportPreferredWidthOverloaded. Gets the maximum width for the viewport column.  
    Public MethodGetViewportRectangleGets the rectangle of the viewport.  
    Public MethodGetViewportRightColumnOverloaded. Gets the column after the rightmost column of the specified viewport for the active sheet.  
    Public MethodGetViewportTopOffsetGet offset of the view port from a particular row to the top.  
    Public MethodGetViewportTopRowOverloaded. Gets the index of the top row of the specified viewport row.  
    Public MethodGetViewportWidthOverloaded. Gets the width of the specified viewport column for the active sheet.  
    Public MethodGetViewportXGets the left coordinate of the specified viewport column for the active sheet.  
    Public MethodGetViewportYGets the top coordinate of the specified viewport row for the active sheet.  
    Public MethodGoalSeekAttempts to find a value for one cell that will produce the desired formula result in another cell.  
    Public MethodHitTestReturns information about the given location.  
    Public MethodInvalidateOverloaded. Invalidates the SpreadView and causes it to repaint.  
    Public MethodLoadXmlInputMapFileOverloaded. Loads the XML input map file using the specified operation mode.  
    Public MethodLoadXmlInputMapFileWhenChildHasFocusOverloaded. Loads the XML input map file when the child has focus.  
    Public MethodLoadXmlInputMapFileWhenShapeHasFocusOverloaded. Loads the XML input map file when the shape has focus.  
    Public MethodOnInkNotationExitOccurs when exiting ink notation.  
    Public MethodOnInkNotationSaveOccurs when saving from ink notation.  
    Public MethodRemoveViewportOverloaded. Removes a row or column of viewports.  
    Public MethodResetResets the active view to its default settings.  
    Public MethodSaveXmlInputMapFileOverloaded. Saves the XML input map file.  
    Public MethodSaveXmlInputMapFileWhenChildHasFocusOverloaded. Saves the XML input map file when the child has focus.  
    Public MethodSaveXmlInputMapFileWhenShapeHasFocusOverloaded. Saves the XML input map file when the shape has focus.  
    Public MethodSetActionMapSets the action map.  
    Public MethodSetActiveViewportOverloaded. Sets the active viewport.  
    Public MethodSetActiveWorkbookSets the active SpreadView to the specified object. If the workbook passed in is null, sets this object to be the active SpreadView.  
    Public MethodSetCursorSets the pointer displayed over a specific area at a specific time.  
    Public MethodSetImageSets the specified graphic for a specified part of the user interface.  
    Public MethodSetImageDPISupportSets the multiscaling versions of specified graphic for a specified part of the user interface.  
    Public MethodSetInputMapOverloaded. Sets the input map for the view for the specified focus mode.  
    Public MethodSetInputMapToOtherSpreadViewSets the input maps of this spreadview to another spread view.  
    Public MethodSetInputMapWhenChildHasFocusSets the input map for the view for when a child object has focus.  
    Public MethodSetInputMapWhenShapeHasFocusSets the input map for the view for when a shape has focus.  
    Public MethodSetMaximumCellOverflowWidthSets the maximum cell overflow width in pixels for cells in the view.  
    Public MethodSetViewportLeftColumnOverloaded. Sets the index of the left most column of the specified viewport column.  
    Public MethodSetViewportPreferredHeightOverloaded. Sets the maximum height for the viewport row.  
    Public MethodSetViewportPreferredWidthOverloaded. Sets the maximum width for the viewport column.  
    Public MethodSetViewportTopRowOverloaded. Sets the index of the top row of the specified viewport row.  
    Public MethodShowActiveCellMoves the currently selected cell in the specified viewport to the specified position.  
    Public MethodShowAutoFillIndicatorShows the AutoFill indicator.  
    Public MethodShowCellMoves the specified cell in the specified viewport to the specified position.  
    Public MethodShowColumnMoves a column in the specified viewport to the specified position.  
    Public MethodShowCommentThreadedShows comment(s) of the active cell.  
    Public MethodShowRowMoves a row in the specified viewport to the specified position.  
    Public MethodStartCellEditingStarts cell editing in the view.  
    Public MethodStopCellEditingStops cell editing in the view.  
    Public MethodStopFilterBarEditingStops cell editing in the filter bar.  
    Top
    Protected Methods
     NameDescription
    Protected MethodCancelColumnResizingCancels column resizing.  
    Protected MethodCancelRowResizingCancels row resizing.  
    Protected MethodContinueCellSelectingContinues selecting cells to the point of the specified coordinates.  
    Protected MethodContinueColumnResizingContinues resizing the column to the specified x-coordinate.  
    Protected MethodContinueColumnSelectingContinues selecting columns to the point at the specified coordinates.  
    Protected MethodContinueDragDroppingContinues drag and drop to the point of the specified coordinates.  
    Protected MethodContinueDragFillingContinues drag and fill to the point of the specified coordinates.  
    Protected MethodContinueFormulaCellRangeMovingContinues moving the formula cell range.  
    Protected MethodContinueFormulaCellRangeResizingContinues the formula cell range resizing.  
    Protected MethodContinueTableResizingContinues resizing the active TableView.  
    Protected MethodFinalizeInternal use only. Creates a new view.  
    Protected MethodInvalidateCornerInvalidates the sheet corner.  
    Protected MethodInvalidateFilterBarOverloaded. Invalidates filter bar.  
    Protected MethodInvalidateFilterBarHeaderInvalidates filter bar header.  
    Protected MethodInvalidateFooterCornerInvalidates the column footer corner.  
    Protected MethodStartCellSelectingStarts selecting cells.  
    Protected MethodStartColumnResizingStarts resizing a column.  
    Protected MethodStartColumnSelectingStarts selecting columns.  
    Protected MethodStartDragDroppingStarts drag and drop.  
    Protected MethodStartDragFillingStarts drag and fill.  
    Protected MethodStartPaintTimerStarts the timer for painting animation.  
    Protected MethodStartScrollTimerStarts the scroll timer.  
    Protected MethodStartTableResizingStart resizing the active TableView.  
    Protected MethodStartTipTimerStarts the tip timer.  
    Protected MethodStopCellSelectingStops selecting cells.  
    Protected MethodStopColumnResizingStops resizing the column.  
    Protected MethodStopColumnSelectingStops selecting the column.  
    Protected MethodStopDragDroppingStops drag and drop.  
    Protected MethodStopDragFillingStops drag and fill.  
    Protected MethodStopFormulaCellRangeMovingStops the formula cell range from moving.  
    Protected MethodStopFormulaCellRangeResizingStops the formula cell range from resizing.  
    Protected MethodStopPaintTimerStops the scroll timer.  
    Protected MethodStopTableResizingStops resizing table.  
    Protected MethodToHorizontalAlignmentConverts a FarPoint.Win.Spread.CellHorizontalAlignment setting to the corresponding FarPoint.Win.HorizontalAlignment setting.  
    Protected MethodToVerticalAlignmentConverts a FarPoint.Win.Spread.CellVerticalAlignment setting to the corresponding FarPoint.Win.VerticalAlignment setting.  
    Top
    See Also

    Reference

    SpreadView Class
    FarPoint.Win.Spread Namespace