GcSpreadSheet Class

Represents the Spreadsheet component.

Inheritance

object

Visual

UIElement

FrameworkElement

Control

GcSpreadSheet

Implements

IAnimatable

IFrameworkInputElement

IInputElement

ISupportInitialize

IQueryAmbient

IBackgroundHoverManager

Namespace: GrapeCity.Wpf.SpreadSheet

Assembly: GrapeCity.Wpf.SpreadSheet.dll

Syntax

public class GcSpreadSheet : Control, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IBackgroundHoverManager

Public Class GcSpreadSheet
    Inherits Control
    Implements IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IQueryAmbient, IBackgroundHoverManager

Constructors

Name	Description
GcSpreadSheet()	Initializes a new instance of the GcSpreadSheet class.

Fields

Name	Description
BeforeRightClickEvent	Identifies theBeforeRightClick routed event
DataItemCreatedEvent	Identifies theDataItemCreated routed event
EnterCellEvent	Identifies theEnterCell routed event
LeaveCellEvent	Identifies theLeaveCell routed event

Properties

Name	Description
ActiveCellBackground	Gets or sets the background of active cell.
AllowCellOverflow	Gets or sets a bool value indicates whether data can overflow into adjacent empty cells.
AllowDragFill	Gets or sets whether to allow the user to drag and fill cells in the component with the contents of a cell or cells.
AllowUserZoom	Gets or sets whether the user can scale the display of the control using Ctrl key and the mouse wheel.
AutoFitMode	Gets or sets the auto-fit mode.
DataValidationStyle	Gets or sets the data validation symbol style.
DataValidationTemplate	Gets or sets the data template used to display the content of the data validation.
Date1904	Gets or sets whether the date system used to convert a date from/to a serial value starts since 1/1/1904.
DragDropMode	Gets or sets the drag and drop mode in which user can drag and drop.
EditingColumn	Get or set the index value of EditingColumn.
EditingRow	Get or set the index value of EditingRow.
Features	Gets a Features object to manipulate settings of features.
FocusCellColor	Gets or sets the color of focus cell selection.
FocusCellMode	Gets or sets the FocusCellMode value that represents how the focus cells selection is displayed.
HorizontalScrollBarSmallChange	Gets or sets a value that specifies how the GcSpreadSheet scroll in vertical direction.
HorizontalScrollMode	Gets or sets a value that specifies how the GcSpreadSheet scroll in horizontal direction.
HoverCellBackground	Gets or sets the background of active cell.
IsEditing	Gets a boolean value indicating whether the GcSpreadSheet is in editing mode.
IsFormulaSelecting	Gets a boolean value indicating whether the formula is selecting.
IsProcessing	Gets a boolean value indicating whether the GcSpreadSheet is processing an UI action.
LogicalChildren
MergedCellSelectionPolicy	Gets or sets the selection policy to use with the merge cells.
Names	Gets a Names collection that represents all the names in the specified workbook (including all worksheet-specific names).
ProcessingAction
SaveLinkValues	Gets or sets a boolean value indicating whether externally referenced values will be saved with the workbook, enabling cells which refer to those values to be calculated without returning a #REF! error.
SelectionBackground	Gets or sets the background of selection.
SelectionStyle	Gets or sets how selections on this sheet are drawn.
Sheets	Gets a SheetInfoCollection object for the sheets of the GcSpreadSheet.
ShowHorizontalScroll	Gets or sets a boolean value that indicates whether to display the horizontal scroll bar in the user interface.
ShowSheetTabs	Gets or sets a boolean value that indicates whether to display the sheet tabs in the user interface.
ShowVerticalScroll	Gets or sets a boolean value that indicates whether to display the vertical scroll bar in the user interface.
Styles	Gets a CellStyleInfoCollection object for the styles of the GcSpreadSheet.
TabStripEditable	Gets or sets whether users can edit the sheet tab text by double-clicking it.
UpdateLinks	Gets or sets an UpdateLinks constant indicating a workbook's setting for updating links.
VerticalScrollBarSmallChange	Gets or sets a value that specifies how the GcSpreadSheet scroll in horizontal direction.
VerticalScrollMode	Gets or sets a value that specifies how the GcSpreadSheet scroll in vertical direction.
VisualChildrenCount
Workbook	Gets the workbook associated with the control.
WorkbookName	Gets or sets the name of the Workbook.

Methods

Name	Description
AddCustomFunction(Function)	Adds a user-defined custom function (GrapeCity.CalcEngine.Function object) to the model for use in formulas.
ArrangeOverride(Size)	Called to arrange and size the content of a Control object.
ClearCustomFunctions()	Clears all custom functions.
CreateCellEditCommand(object, string)	Create the cell edit command from the specified value.
DeActiveShapes()
EndInit()
GetCustomFunction(string)	Gets a user-defined custom function from the workbook.
GetCustomFunctionEnumerator()	Gets an IEnumerable<GrapeCity.CalcEngine.Function> that enumerates through the names of the custom functions in the workbook.
GetVisualChild(int)	Overrides GetVisualChild(int), and returns a child at the specified index from a collection of child elements.
MeasureOverride(Size)	Called to remeasure a control.
OnContextMenuOpening(ContextMenuEventArgs)	Invoked whenever an unhandled ContextMenuOpening routed event reaches this class in its route.
OnGotFocus(RoutedEventArgs)	Invoked whenever an unhandled GotFocus event reaches this element in its route.
OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)	Invoked when an unhandled Keyboard.GotKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)
OnMouseDown(MouseButtonEventArgs)	Invoked when an unhandled ouse.MouseDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
OnMouseWheel(MouseWheelEventArgs)	Spread take the whole permission to handle mouse wheel. Child control have nothing.
OnPreviewKeyDown(KeyEventArgs)	Invoked when an unhandled Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
OnPreviewKeyUp(KeyEventArgs)
OnPreviewMouseDown(MouseButtonEventArgs)	Invoked when an unhandled Mouse.PreviewMouseDown attached routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
OnPreviewTextInput(TextCompositionEventArgs)	Invoked when an unhandled TextCompositionManager.PreviewTextInput attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.
OnRender(DrawingContext)	When overridden in a derived class, participates in rendering operations that are directed by the layout system. The rendering instructions for this element are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing.
OnRenderSizeChanged(SizeChangedInfo)	Raises the SizeChanged event, using the specified information as part of the eventual event data.
OpenExcel(Stream, ImportContext)	Opens an Excel file and loads it into Spread.
OpenExcel(Stream, ImportOptions)	Opens an Excel file and loads it into Spread.
OpenExcel(string, ImportContext)	Opens an Excel file and loads it into Spread.
OpenExcel(string, ImportOptions)	Opens an Excel file and loads it into Spread.
Print(int, PrintSettings, bool)	Prints the GcSpreadSheet.
PrintToDocument(int, PrintSettings)	Prints the GcSpreadSheett to a document which can be displayed by DocumentViewer control.
Refresh()	Forces the spread to invalidate its client area and redraw itself.
RemoveCustomFunction(string)	Removes a user-defined custom function.
Reset()	Resets the component to its original state.

Events

Name	Description
BeforeRightClick	Occurs when an object is right-clicked, before the default right-click action.
ColumnWidthChanged	Occurs when the width of a column has changed.
DataItemCreated	Occurs when the new data item is created.
DragFillCompleted	Occurs after the drag-filling process completes.
DragFillStarted	Occurs after the drag-filling process starts.
DragFillStarting	Occurs before the drag-filling process starts.
EditEnd	Occurs when a cell leaves edit mode.
EditStarting	Occurs when a cell goes into edit mode.
EnterCell	Occurs when the user enters a cell.
ExtensionResolve	Occurs when the resolution of an extension fails.
LeaveCell	Occurs when the user leaves a cell.
RowHeightChanged	Occurs when the height of a row has changed.