SMath Studio Core documentation
Worksheet Class
Worksheet Control of the program.
Definition
Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.2.9018.0
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.2.9018.0
C#
public abstract class Worksheet : IDisposable,
IDocument<RegionBase>VB
Public MustInherit Class Worksheet
Implements IDisposable, IDocument(Of RegionBase)C++
public ref class Worksheet abstract : IDisposable,
IDocument<RegionBase^>F#
[<AbstractClassAttribute>]
type Worksheet =
class
interface IDisposable
interface IDocument<RegionBase>
end- Inheritance
- Object Worksheet
- Derived
- Implements
- IDocumentRegionBase, IDisposable
Constructors
| Worksheet(Worksheet) | Constructor of the Worksheet class which copies properties from another instance of this class. |
| Worksheet(SessionProfile, PresentationMode) | Constructor of the Worksheet class taking a presentation mode to create an instance of the object. |
Properties
| AbsoluteDefinitions | Gets or sets a list of Absolute Definitions (definitions available to read/write anywhere in the Worksheet) for the Worksheet. |
| Clipboard | Clipboard manager. |
| ContentSize | Size of the document content. |
| CurrentColumnsCount | |
| CurrentContentPlacement | |
| CurrentPage | |
| CurrentRegion | Current Region of the Worksheet. |
| CustomRegionPlugins | Returns the list of installed Custom Region plug-ins. |
| DrawGrid | Defines if the grid will be drawn on the worksheet. |
| Editor | Worksheet editor logic. |
| Focused | Determines if the current document is focused or not. |
| GridSize | Grid size of the current Worksheet document. |
| HasCurrentRegion | Defines whether the Worksheet contain Current Region or not. |
| History | Worksheet changes history. |
| IntelliSense | Dynamic assistance for the Worksheet. |
| InvokeRequired | Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. |
| IsDifferentInPlacement | |
| IsInEvalution | Obsolete. |
| LanguageNotifier | On screen notification of current selected language for multilingual regions. |
| MetaContext | Overall context of the document. |
| MetaData | Worksheet meta-data. |
| Mode | Presentation mode of the document. |
| MultiplePages | Determines if the multiple page can be rendered horizontally at once or not. |
| ObjectsManager | Manager of the document objects. |
| PageIndex | |
| PageModel | Print out worksheet parameters. |
| PagesCount | |
| PagesOptions | Worksheet Pages manager. |
| Params | Parameters of the worksheet document. |
| Pointer | Current Worksheet cursor information. |
| ScrollSize | Scroll size of the document. |
| Search | Search component of the worksheet. |
| SessionProfile | Session parameters. |
| Size | Current size of the visible active Worksheet area. |
| Status | Status of the worksheet. |
Methods
| AddBreakpoint | |
| ApplyInitialDefinitions | |
| Clear | |
| CreateRegions(IEnumerableRegionBase, Boolean, LocationCorrectionMode) | Adds Regions to the worksheet. |
| CreateRegions(IEnumerableRegionBase, Boolean, Boolean) | Obsolete. |
| CreateRegions(RegionsEnumerator, Int32, Int32, Boolean, LocationCorrectionMode) | |
| CreateStore | |
| Dispose | Releases all resources used by the Worksheet |
| 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) |
| Focus | |
| GetAssemblyTagName | |
| GetCollapsedHeight(Int32) | |
| GetCollapsedHeight(RegionsList, Int32) | |
| GetCurrentStore | |
| GetCurrentTooltip | |
| GetCursorType | Defines a mouse cursor type at the specific position on the worksheet. |
| GetEvaluationContext | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPreviouslyDefinedParams | |
| GetPreviouslyDefinedParamsAll | |
| GetRegionIndex | |
| GetRegionsBounds | Calculates bounds of the selected Regions. |
| GetRegionsEnumerator | Creates enumerator to iterate through available Worksheet Regions. |
| GetStaticContextMenuItems(RegionBase) | |
| GetStaticContextMenuItems(RegionBase, LanguageInfo) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetWorksheetPage(Int32, Int32) | |
| GetWorksheetPage(RegionBase, Point) | Returns Document Page which contains given Object. |
| GetWorksheetPage(RegionBase, Int32) | Returns Document Page which contains given Object. |
| GetWorksheetPage(RegionsList, Int32, Int32) | |
| GetWorksheetPageStrict | Returns Document Page which contains given Object. |
| GotFocus | |
| HideCursorIfRequired | |
| HideError | Hides an error shown on the current document. |
| Insert(ButtonAction) | |
| Insert(RegionBase) | Adds Regions to Worksheet and insert focus in the first added Region. |
| Insert(String) | Parses a text command for the current worksheet. |
| Invalidate | Redraws all visible parts of the document. |
| Invalidate(Rectangle) | Redraws all parts of the Worksheet which is shown in the specified rectangle. |
| Invalidate(Int32, Int32, Int32, Int32) | |
| Invoke | |
| LockRegion | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MouseDown | Mouse button down event handler. |
| MouseMove | Mouse cursor move event handler. |
| MouseUp | Mouse button up event handler. |
| MouseWheel | Changing of the scrollbars values by mouse wheel. |
| PageStatusManager | |
| RefreshContent | |
| RefreshUI | Refreshes User Interface elements of the current document. |
| RemoveRegions(IEnumerableRegionBase) | Removes Regions from the worksheet. |
| RemoveRegions(RegionBase) | |
| RemoveRegions(IEnumerableRegionBase, Boolean) | |
| ResetCustomRegionPlugins | Reset list of Custom Region plug-ins for future usage. |
| ResetRegionDrawingPlugins | Reset list of Region Drawing plug-ins for future usage. |
| Resize | Changing element size. |
| ResumeLayout | |
| Scroll | |
| ScrollToContent(RegionBase, Boolean) | Scrolls Worksheet to specified Region. Expands collapsed Areas if required. |
| ScrollToContent(RegionBase, RectangleF, Boolean) | |
| ScrollToContent(RegionEvaluable, Int32, Boolean) | |
| ScrollToRegion(RegionBase, Boolean) | Scrolls Worksheet to show specific Region. |
| ScrollToRegion(RegionBase, RectangleF) | |
| SelectRegions | Works with the element selection property. The purpose changes depending on the argument received. |
| SetDebuggerMode | |
| SetRegionBorder | |
| SetRegionColor | |
| SetRegionCurrentTextLang | Updates all translatable Regions to set language according to global application settings. |
| SetRegionFontFamily | |
| SetRegionFontSize | |
| ShowCursorIfRequired | |
| ShowError | Shows an error under the specified RegionEvaluable region. |
| SnapToGrid | |
| SortRegions | |
| StartEvaluation | Performs evaluation of the worksheet. |
| StartEvaluationAndWait | Performs evaluation of the worksheet within a limited time. |
| SuppressLayout | |
| Test | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryAbortEvaluation | Abort worksheet recalculation. |
| TryGetRegionByTagName | Enumerates all the available custom region plug-ins in order to find one with specified tag name. Creates a new Region after plug-in is found. |
| UnfocusRegions | |
| UnlockRegion | |
| UpdatePageModel | |
| UpdateScrollBars | Updates scrollbars values in the current document. |
| VerifyLanguageNotifier |
Events
| EvaluationStateChanged | Occurs when the overall state of evaluation is changed on worksheet level. |
| OnBeforeWorksheetUnoad | |
| OnCurrentRegionChanged | |
| OnDataTrace | Occurs on data sent to trace. |
| OnDebugStart | Occurs on debug session started. |
| OnEntryInfoRequested | Rises when information about dimension requested. |
| OnFileContextLoad | |
| OnMenuButtonEmulated | |
| OnPasswordRequest | Requests password. |
| OnProgressChanged | |
| OnRegionCreated | |
| OnStatusChanged | |
| WorksheetStatusChanged | Worksheet status change. |