Worksheet |
public class WorksheetController : AbstractViewContent, IWorksheetController, IMVCANController, IMVCAController, IMVCController, IDisposable, IApplyController
The WorksheetController type exposes the following members.
| Name | Description | |
|---|---|---|
| WorksheetController(DataTable) | Initializes a new instance of the WorksheetController class for the specified table. | |
| WorksheetController(WorksheetLayout) | Creates a WorksheetController which shows the table data using the specified layout. | |
| WorksheetController(WorksheetViewLayout) | Initializes a new instance of the WorksheetController class for the specified view layout. |
| Name | Description | |
|---|---|---|
| AreColumnsOrRowsSelected | Returns true if one or more columns, rows or property columns or rows are selected. | |
| AreDataCellsSelected | Returns true if one or more data columns or rows are selected. | |
| ArePropertyCellsSelected | Returns true if one or more property columns or rows are selected. | |
| CloseCommand |
Gets the command that closes the view content.
(Inherited from AbstractViewContent) | |
| CloseWithSolution |
Gets whether this view content should be closed when the solution is closed.
(Inherited from AbstractViewContent) | |
| ContentId |
Gets or sets the content identifier. Here, the content identifier is calculated of the reference hash of the document.
Setting is not implemented here.
(Inherited from AbstractViewContent) | |
| DataTable | This returns the Table that is managed by this controller. | |
| EnableCopy | Gets a value indicating whether the copy command is currently enabled. | |
| EnableCut | Gets a value indicating whether the cut command is currently enabled. | |
| EnableDelete | Gets a value indicating whether the delete command is currently enabled. | |
| EnablePaste | Gets a value indicating whether the paste command is currently enabled. | |
| EnableSelectAll | Gets a value indicating whether the select-all command is currently enabled. | |
| FirstVisibleColumn | Gets or sets the index of the first visible data column. | |
| FirstVisiblePropertyColumn | Gets the index of the first visible property column. | |
| FirstVisibleTableRow | Gets the index of the first visible table row. | |
| FullyVisibleColumns | Gets the number of fully visible data columns. | |
| FullyVisiblePropertyColumns | Gets the number of fully visible property columns. | |
| FullyVisibleTableRows | Gets the number of fully visible table rows. | |
| HorzScrollMaximum | Gets or sets the maximum horizontal scroll position. | |
| HorzScrollPos | Gets or sets the horizontal scroll position. | |
| IconSource |
Gets or sets the icon source.
(Inherited from AbstractViewContent) | |
| InfoTip |
Gets or sets the informational tooltip for the view content.
(Inherited from AbstractViewContent) | |
| InitiallyFocusedControl |
Gets the control which has focus initially.
(Inherited from AbstractViewContent) | |
| IsActive |
Gets or sets a value indicating whether the view of this instance is active in the UI.
(Inherited from AbstractViewContent) | |
| IsContentVisible |
Gets a value indicating whether the content of this document window is visible (it is if either IsActive or IsSelected is visible.
(Inherited from AbstractViewContent) | |
| IsDirty |
If this property returns true the content has changed since
the last load/save operation.
(Inherited from AbstractViewContent) | |
| IsDisposed |
Gets a value indicating whether the view content has been disposed.
(Inherited from AbstractViewContent) | |
| IsDisposeInProgress |
Gets or sets a value indicating whether disposal is in progress.
(Inherited from AbstractViewContent) | |
| IsReadOnly |
Gets if the view content is read-only (can be saved only when choosing another file name).
(Inherited from AbstractViewContent) | |
| IsSelected |
Gets or sets a value indicating whether the view of this instance is selected (e.g. inside its container).
(Inherited from AbstractViewContent) | |
| IsViewOnly |
Gets if the view content is view-only (cannot be saved at all).
(Inherited from AbstractViewContent) | |
| IsVisible |
Gets or sets the visibility of the document.
If false, the document tab header is not visible (but the document itself maybe visible !).
If true, the document tab header is visible (if it fits in the bar),
and the document is visible, if it is selected, too.
(Inherited from AbstractViewContent) | |
| LastFullyVisibleColumn | Gets the index of the last fully visible data column. | |
| LastFullyVisiblePropertyColumn | Gets the index of the last fully visible property column. | |
| LastFullyVisibleTableRow | Gets the index of the last fully visible table row. | |
| LastVisibleTableRow | Gets the index of the last visible table row. | |
| ModelObject |
Gets the model (document) that this controller manages.
(Overrides AbstractViewContentModelObject) | |
| RemainingEnabledPropertyColumns | Returns the remaining number of property columns that could be shown below the current scroll position. | |
| SelectedDataColumns | Gets the currently selected data columns. | |
| SelectedDataRows | Returns the currently selected data rows. | |
| SelectedPropertyColumns | Returns the currently selected property columns. | |
| SelectedPropertyRows | Returns the currently selected property rows if property cells are selected alone. If not selected alone, the SelectedColumn property is returned. | |
| Services |
Gets or sets the service container for the view content.
(Inherited from AbstractViewContent) | |
| TableAreaHeight | Gets the height of the visible table area. | |
| TableAreaWidth | Gets the width of the visible table area. | |
| Title |
Gets/Sets the title of the current tab page.
This value will be passed through the string parser before being displayed.
(Inherited from AbstractViewContent) | |
| TotalEnabledPropertyColumns | Returns number of property columns that are enabled for been shown on the grid. | |
| UseDocumentCopy | Sets whether or not a copy of the document is used. If set to true, a copy of the document is used, so if the controller is not applied, all changes can be reverted. If set to false, no copy must be made. The document is directly changed by the controller, and changes cannot be reverted. Use the last option if a controller higher in the hierarchy has already made a copy of the document. | |
| VerticalPositionOfFirstVisibleDataRow | This returns the vertical position of the first visible data row.; | |
| VerticalScrollPosition | The vertical scroll position is defined as following: If 0 (zero), the data row 0 is the first visible line (after the column header). If positive, the data row with the number of VertScrollPos is the first visible row. If negative, the property column with index PropertyColumnCount+VertScrollPos is the first visible line. | |
| VertScrollMaximum | Gets or sets the maximum vertical scroll position. | |
| ViewObject |
Gets or sets the GUI element that shows the model to the user.
(Overrides AbstractViewContentViewObject) | |
| VisibleColumns | Gets the number of visible data columns. | |
| VisiblePropertyColumns | Gets the number of visible property columns. | |
| VisibleTableRows | Gets the number of visible table rows. | |
| WorksheetLayout | Gets the worksheet layout managed by this controller. |
| Name | Description | |
|---|---|---|
| AdjustXScrollBarMaximum | Recalculates the maximum value of the horizontal scroll bar. | |
| AdjustXScrollBarViewPortSize | Adjusts the X scroll bar viewport size (= size of the thumb). Should be called after the X scrollbar maximum is adjusted or when the width of the columns changes considerably. Here, we want to avoid that the thumb size changing while we scroll through the worksheet. Thus, we calculate an average value for the thumb size that is the relation of the table-area width and the total width of all data columns. | |
| AdjustYScrollBarMaximum | Recalculates the maximum value of the vertical scroll bar. | |
| Apply | Called when the user input has to be applied to the document being controlled. Returns if apply is successful. | |
| BuildNavPoint |
Builds an INavigationPoint for the current position.
(Inherited from AbstractViewContent) | |
| CanClose |
Determines whether the view content can be closed.
(Inherited from AbstractViewContent) | |
| ClearAllSelections | Clears all selections of columns, rows or property columns. | |
| ClearIsDirty |
Clears the dirty state.
(Inherited from AbstractViewContent) | |
| Copy | Copies the current cell-edit selection or the selected worksheet items. | |
| CreateResizingPositions | Rebuilds the cached list of column-divider positions used for column resizing. | |
| Cut | Cuts the current cell-edit selection or the selected worksheet items. | |
| Delete | Deletes the current cell-edit content, the current selection, or the worksheet itself. | |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Overrides AbstractViewContentDispose) | |
| EhPropertyDataChanged | Handles changes in worksheet property-column data. | |
| EhTable_Changed | Handles changes of the worksheet table, for example table renaming. | |
| EhTableDataChanged | Handles changes in worksheet data values. | |
| EhTitleLocalizationChanged |
Updates the title when the localized title changes.
(Inherited from AbstractViewContent) | |
| EhView_HorzScrollBarScroll | Handles scrolling of the horizontal scrollbar in the view. | |
| EhView_KeyDown | Handles keyboard navigation commands from the view. | |
| EhView_TableAreaMouseClick | Handles mouse clicks in the table area. | |
| EhView_TableAreaMouseDoubleClick | Handles mouse double-clicks in the table area. | |
| EhView_TableAreaMouseDown | Handles mouse-button presses over the table area. | |
| EhView_TableAreaMouseMove | Handles mouse movement over the table area. | |
| EhView_TableAreaMouseUp | Handles mouse-button release over the table area. | |
| EhView_TableAreaMouseWheel | Handles the mouse wheel event. | |
| EhView_TableAreaSizeChanged | Handles changes in the size of the table area. | |
| EhView_VertScrollBarScroll | Handles scrolling of the vertical scrollbar in the view. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| GetDataColumnStyle | Retrieves the column style for the data column with index i. | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetPropertyColumnStyle | Retrieves the column style for the property column with index i. | |
| GetService(Type) | Gets the service object of the specified type. (Inherited from AbstractViewContent) | |
| GetServiceT |
Gets a required service of the specified type.
(Inherited from AbstractViewContent) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| InitializeDocument | Initializes the controller with the document. | |
| InternalInitializeWorksheetLayout | Initializes the controller with the specified worksheet layout. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| NavigateCellEdit | Moves the cell editor to the next editable cell. | |
| NavigatePropertyCellEdit | Moves the cell editor to the next property cell. | |
| NavigateTableCellEdit | Moves the cell editor to the next data cell. | |
| NotifyContentIdChanged |
Can be used to notify the view content that the ContentId maybe has changed.
(Inherited from AbstractViewContent) | |
| OnClose |
Closes the view content.
(Inherited from AbstractViewContent) | |
| OnIsDirtyChanged |
Raises notifications that the dirty state has changed.
(Inherited from AbstractViewContent) | |
| OnLeftClickDataCell | Handles a left-click on a data cell. | |
| OnLeftClickDataColumnHeader | Handles a left-click on a data-column header. | |
| OnLeftClickDataRowHeader | Handles a left-click on a data-row header. | |
| OnLeftClickOutsideAll | Raises the event for a left-click outside all worksheet areas. | |
| OnLeftClickPropertyCell | Handles a left-click on a property cell. | |
| OnLeftClickPropertyColumnHeader | Handles a left-click on a property-column header. | |
| OnLeftClickTableHeader | Raises the event for a left-click on the table header. | |
| OnPropertyChanged |
Raises the PropertyChanged event.
(Inherited from AbstractViewContent) | |
| OnRightClickDataCell | Raises the event for a right-click on a data cell. | |
| OnRightClickDataColumnHeader | Raises the event for a right-click on a data-column header and shows the context menu. | |
| OnRightClickDataRowHeader | Raises the event for a right-click on a data-row header and shows the context menu. | |
| OnRightClickOutsideAll | Raises the event for a right-click outside all worksheet areas and shows the context menu. | |
| OnRightClickPropertyCell | Raises the event for a right-click on a property cell. | |
| OnRightClickPropertyColumnHeader | Raises the event for a right-click on a property-column header and shows the context menu. | |
| OnRightClickTableHeader | Raises the event for a right-click on the table header and shows the context menu. | |
| Paste | Pastes clipboard content into the active cell editor or worksheet selection. | |
| Revert | Try to revert changes to the model, i.e. restores the original state of the model. | |
| SelectAll | Selects all data columns in the worksheet. | |
| SetCachedNumberOfDataColumns | Updates the cached number of data columns. | |
| SetCachedNumberOfDataRows | Updates the cached number of data rows. | |
| SetCachedNumberOfPropertyColumns | Updates the cached number of property columns. | |
| SetDirty |
Sets the dirty state.
(Inherited from AbstractViewContent) | |
| SetDisposeInProgress |
Announces that this view content is about to be disposed very soon. The view content should remain passiv (e.g. should not react to events any more),
but should not release its resources yet (this is done later in Dispose).
(Inherited from AbstractViewContent) | |
| SetLocalizedInfoTip |
Sets a localized info tip that will update automatically when the language changes.
(Inherited from AbstractViewContent) | |
| SetLocalizedTitle |
Sets a localized title that will update automatically when the language changes.
(Inherited from AbstractViewContent) | |
| SetMemberVariablesToDefault | Set the member variables to default values. Intended only for use in constructors and deserialization code. | |
| SetScrollPositionTo | SetScrollPositions only sets the scroll positions, and not Invalidates the Area! | |
| TableAreaInvalidate | Forces redraw of the table. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) | |
| TriggerRedrawing | Forces the view to redraw its table area, updating the display to reflect any recent changes. |
| Name | Description | |
|---|---|---|
| DataCellRightClicked | Occurs when a data cell is clicked with the right mouse button. | |
| DataColumnHeaderRightClicked | Occurs when a data-column header is clicked with the right mouse button. | |
| DataRowHeaderRightClicked | Occurs when a data-row header is clicked with the right mouse button. | |
| Disposed |
Occurs when the view content has been disposed.
(Inherited from AbstractViewContent) | |
| IsDirtyChanged |
Occurs when the dirty state changes.
(Inherited from AbstractViewContent) | |
| OutsideAllLeftClicked | Occurs when the user left-clicks outside any worksheet area. | |
| OutsideAllRightClicked | Occurs when the user right-clicks outside any worksheet area. | |
| PropertyCellRightClicked | Occurs when a property cell is clicked with the right mouse button. | |
| PropertyChanged | Occurs when a property value changes. (Inherited from AbstractViewContent) | |
| PropertyColumnHeaderRightClicked | Occurs when a property-column header is clicked with the right mouse button. | |
| TableHeaderLeftClicked | Occurs when the table header is clicked with the left mouse button. | |
| TableHeaderRightClicked | Occurs when the table header is clicked with the right mouse button. |
| Name | Description | |
|---|---|---|
| _cellEdit_IsArmed | Indicates whether cell editing is currently armed. | |
| _cellEdit_IsModified | Indicates whether the current cell-edit content was modified. | |
| _columnWidthResizingPositions | List of x positions where the horizontal resizing cursor should be shown in order to resize the columns. | |
| _columnWidthResizingPositionsFirstColumnIndex | Index of the first data column that was shown when the list of resizing positions was created. | |
| _isActive |
Stores whether the view content is active.
(Inherited from AbstractViewContent) | |
| _isSelected |
Stores whether the view content is selected.
(Inherited from AbstractViewContent) | |
| _isVisible |
Stores whether the view content is visible.
(Inherited from AbstractViewContent) | |
| _lastSelectionType | Which selection was done last: selection (i) a data column, (ii) a data row, or (iii) a property column. | |
| _numberOfPropertyCols | Cached number of property columns. | |
| _numberOfTableCols | Cached number of table columns. | |
| _numberOfTableRows | Cached number of table rows. | |
| _selectedDataColumns | Holds the indizes to the selected data columns. | |
| _selectedDataRows | Holds the indizes to the selected rows. | |
| _selectedPropertyColumns | Holds the indizes to the selected property columns. | |
| _selectedPropertyRows | Holds the indizes to the selected property rows (but only in case property cells are selected alone). | |
| _table | Holds the data table cached from the layout. | |
| _title |
Stores the current title.
(Inherited from AbstractViewContent) | |
| _titleToBeLocalized |
Stores the localized title source.
(Inherited from AbstractViewContent) | |
| _weakEventHandlerDataColumnChanged | Weak event handler for data-column changes. | |
| _weakEventHandlerForLayout_TunneledEvent | Weak event handler for tunneled events raised by the worksheet layout. | |
| _weakEventHandlerForTable_Changed | Weak event handler for changes on the worksheet table. | |
| _weakEventHandlerForTable_TunneledEvent | Weak event handler for tunneled events raised by the worksheet table. | |
| _weakEventHandlerPropertyColumnChanged | Weak event handler for property-column changes. | |
| _worksheetLayout | Holds the worksheet layout controlled by this instance. |