Tip
Absolute definitions are starting with AbsoluteChar.
SMath Studio Core documentation
Worksheet Class
Abstraction of a document which consists of regions.
Definition
Namespace: SMath.Controls
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0
Assembly: SMath.Controls (in SMath.Controls.dll) Version: 1.73.9126.0
C#
public abstract class Worksheet : IDocument<RegionBase>,
IDisposableVB
Public MustInherit Class Worksheet
Implements IDocument(Of RegionBase), IDisposableC++
public ref class Worksheet abstract : IDocument<RegionBase^>,
IDisposableF#
[<AbstractClassAttribute>]
type Worksheet =
class
interface IDocument<RegionBase>
interface IDisposable
end- Inheritance
- Object Worksheet
- Implements
- IDocument<RegionBase>, IDisposable
Constructors
| Worksheet | Initializes a new instance of the Worksheet class |
Properties
| AbsoluteDefinitions | Gets the list of Absolute Definitions for the Worksheet, i.e. the definitions which are available to read/write from any location on the Worksheet regardless of order. |
| Clipboard | Clipboard manager. |
| ClipboardImpl | Implementation of Clipboard. |
| ContentSize | Size of the document content. |
| CurrentRegion | Current Region of the Worksheet. |
| CurrentRegionImpl | Implementation of CurrentRegion. |
| CustomRegionPlugins | Returns the list of installed Custom Region plug-ins. |
| DrawGrid | Defines if the grid will be drawn on the worksheet. |
| Focused | Determines if the current document is focused or not. |
| HasCurrentRegion | Determines whether the Worksheet contains Current Region or not. |
| History | Worksheet changes history. |
| HistoryImpl | Implementation of History. |
| IsDisposed | Determines whether this instance is disposed. |
| Layout | Layout of the document. |
| MetaContext | Overall context of the document. |
| MetaData | Worksheet meta-data. |
| MetaDataImpl | Implementation of MetaData. |
| Mode | Presentation mode of the document. |
| ModeImpl | Implementation of Mode. |
| PageModel | Print out worksheet parameters. |
| PageModelImpl | Implementation of PageModel. |
| PagesMultiColumnImpl | Implementation of PagesMultiColumn. |
| PagesOptions | Worksheet Pages manager. |
| Params | Parameters of the worksheet document. |
| ParamsImpl | Implementation of Params. |
| Pointer | Current Worksheet cursor information. |
| ScrollSize | Scroll size of the document. |
| Search | Search component of the worksheet. |
| SearchImpl | Implementation of Search. |
| SessionProfile | Profile of the session the document belongs to. |
| SessionProfileImpl | Implementation of SessionProfile. |
| Size | Current size of the visible active Worksheet area. |
| Status | Status of the worksheet. |
| StatusImpl | Implementation of Status. |
Methods
| AttachAutoComplete | Attaches the event handler which starts dynamic assistance to AvailableTermsListShow event of the specified region. |
| CreateRegions(IEnumerable<RegionBase>, Boolean, LocationCorrectionMode) | Adds Regions to the worksheet. |
| CreateRegions(RegionsEnumerator, Int32, Int32, Boolean, LocationCorrectionMode) | Adds Regions to the worksheet. |
| CreateRegionsImpl(IEnumerable<RegionBase>, Boolean, LocationCorrectionMode) | Implementation of CreateRegions(IEnumerable<RegionBase>, Boolean, LocationCorrectionMode). |
| CreateRegionsImpl(RegionsEnumerator, Int32, Int32, Boolean, LocationCorrectionMode) | Implementation of CreateRegions(RegionsEnumerator, Int32, Int32, Boolean, LocationCorrectionMode). |
| CreateStore | Creates a new instance of Store for use with this worksheet. |
| DetachAutoComplete | Detaches the event handler which starts dynamic assistance from AvailableTermsListShow event of the specified region. |
| Dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| Dispose(Boolean) | Implementation of Dispose() |
| 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 | Sets input focus to the document. |
| GetAssemblyTagName | Determines the tag name for custom plug-in the specified region originates from. |
| GetCurrentStore() | Provides access to the evaluation context created during the previous calculation process of the document and which are visible to the currently focused document element. |
| GetCurrentStore(RegionBase) | Provides access to the evaluation context created during the previous calculation process of the document. If region is specified then the store is provided for that region, otherwise it is provided for the entire worksheet. |
| GetEvaluationContext | Creates a new instance of EvaluationContext for use with this worksheet. |
| GetEvaluationContextImpl | Implementation of GetEvaluationContext(). |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPreviouslyDefinedParams | Provides access to the definitions made available during the previous calculation process of the document and which are visible to the currently focused document element. |
| GetPreviouslyDefinedParamsAll | Provides access to the definitions made available during the previous calculation process of the document. |
| GetRegionDrawingPlugins | Returns all plug-ins which support drawing of regions. Important
This method is for internal use only and must not be accessed by the user code.
|
| GetRegionsBounds | Determines the full bounding rectangle covering all specified Regions. |
| GetRegionsEnumerator | Creates enumerator to iterate through available Worksheet Regions. |
| GetRegionsEnumeratorImpl | Implementation of GetRegionsEnumerator(). |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetWorksheetPage(Int32, Int32) | Finds the document page for the specified logical coordinate. |
| GetWorksheetPage(RegionBase, Point) | Finds the document page which contains the specified region. |
| GetWorksheetPage(RegionBase, Int32) | Finds the document page which contains the specified region. |
| GetWorksheetPage(RegionsList, Int32, Int32) | Finds the document page for the specified logical coordinate. |
| GetWorksheetPageImpl(Int32, Int32) | Implementation of GetWorksheetPage(Int32, Int32). |
| GetWorksheetPageImpl(RegionBase, Point) | Implementation of GetWorksheetPage(RegionBase, Point). |
| GetWorksheetPageImpl(RegionBase, Int32) | Implementation of GetWorksheetPage(RegionBase, Int32). |
| GetWorksheetPageImpl(RegionsList, Int32, Int32) | Implementation of GetWorksheetPage(RegionsList, Int32, Int32). |
| GetWorksheetStatus | Retrieves the overall status of the worksheet. |
| HideCursorIfRequired | Hides a native system waiting cursor. |
| HideError | Hides an error which is shown for the focused region in the current document. |
| Insert(ButtonAction) | Performs the specified ButtonAction and inserts the regions which are created by it. The regions are taken from CurrentRegions. |
| Insert(RegionBase[]) | Adds Regions to Worksheet and insert focus in the first added Region. |
| Insert(String) | Parses a text command for the current worksheet. |
| InsertImpl(ButtonAction) | Implementation of Insert(ButtonAction). |
| InsertImpl(RegionBase[]) | Implementation of Insert(RegionBase[]). |
| InsertImpl(String) | Implementation of Insert(String). |
| Invalidate() | Redraws all visible parts of the document. |
| Invalidate(Rectangle) | Redraws all parts of the Worksheet which are shown in the specified rectangle. |
| Invalidate(Int32, Int32, Int32, Int32) | Redraws all parts of the Worksheet which are shown in the specified rectangle. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RefreshUI | Refreshes User Interface elements of the current document. |
| RemoveRegions(IEnumerable<RegionBase>) | Removes the specified regions from the worksheet. |
| RemoveRegions(RegionBase) | Removes the specified region from the worksheet. |
| RemoveRegions(IEnumerable<RegionBase>, Boolean) | Removes the specified regions from the worksheet. |
| RemoveRegionsImpl | Implementation of RemoveRegions(RegionBase), RemoveRegions(IEnumerable<RegionBase>) and RemoveRegions(IEnumerable<RegionBase>, Boolean). |
| ResetCustomRegionPlugins | Resets the list of Custom Region plug-ins for future usage. |
| ResetRegionDrawingPlugins | Reset list of Region Drawing plug-ins for future usage. |
| ScrollToContent(RegionBase, Boolean) | Scrolls Worksheet to specified Region. Expands collapsed Areas if required. |
| ScrollToContent(RegionBase, RectangleF, Boolean) | Scrolls Worksheet to specified Region. Expands collapsed Areas if required. |
| ScrollToContent(RegionEvaluable, Int32, Boolean) | Scrolls Worksheet to specified Region specifying an exact cursor position. Expands collapsed Areas if required. |
| ScrollToContentImpl(RegionBase, Boolean) | Implementation of ScrollToContent(RegionBase, Boolean). |
| ScrollToContentImpl(RegionBase, RectangleF, Boolean) | Implementation of ScrollToContent(RegionBase, RectangleF, Boolean). |
| ScrollToContentImpl(RegionEvaluable, Int32, Boolean) | Implementation of ScrollToContent(RegionEvaluable, Int32, Boolean). |
| ScrollToRegion(RegionBase, Boolean) | Scrolls Worksheet to show specific Region. |
| ScrollToRegion(RegionBase, RectangleF) | Scrolls Worksheet to show specific Region. |
| ScrollToRegionImpl(RegionBase, Boolean) | Implementation of ScrollToRegion(RegionBase, Boolean). |
| ScrollToRegionImpl(RegionBase, RectangleF) | Implementation of ScrollToRegion(RegionBase, RectangleF). |
| SelectRegions | Selects or deselects Regions. Behavior of the method depends on the specified value. |
| SelectRegionsImpl | Implementation of SelectRegions(SelectionType). |
| ShowCursorIfRequired | Shows a native system waiting cursor. |
| ShowError | Shows an error for the specified RegionEvaluable region. |
| StartEvaluation | Starts evaluation of the worksheet. Note
This method exits immediately, it does not wait until evaluation is finished or stopped in debugger.
Obsolete. |
| StartEvaluationImpl | Implementation of StartEvaluation(Int32, Int32, Boolean, Boolean). |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| 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 | Removes the focused state from all regions optionally preserving the focus on the specified region. |
| UnfocusRegionsImpl | Implementation of UnfocusRegions(RegionBase). |
| UpdatePageModel | Updates Mode of PageModel. |
| UpdateScrollBars | Updates scrollbars values in the current document. |
| UpdateWorksheetStatus | If WorksheetStatusChanged event has any listener then updates the status of the page via GetWorksheetStatus() and then raises WorksheetStatusChanged event. |
Events
| WorksheetStatusChanged | Occurs on worksheet status change. |
Explicit Interface Implementations
| IDocument<RegionBase>.Layout | Layout of the document. |
| IDocument<RegionBase>.PagesMultiColumn | Determines whether multiple pages can be rendered horizontally at once or not. |
| IDocument<RegionBase>.Status | Status of the worksheet. |