Script |
Controller for editing, compiling, and executing scripts.
Inheritance HierarchyNamespace: Altaxo.Gui.Scripting
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
public class ScriptController : IScriptController, IMVCANController, IMVCAController, IMVCController, IDisposable, IApplyController
The ScriptController type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ScriptController | Initializes a new instance of the ScriptController class. |
| ScriptController(IScriptText) | Initializes a new instance of the ScriptController class. |
| ScriptController(IScriptText, ScriptExecutionHandler) | Initializes a new instance of the ScriptController class. |
Properties| Name | Description | |
|---|---|---|
 | ModelObject | Gets the model (document) that this controller manages. |
| 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. |
| ViewObject | Gets or sets the GUI element that shows the model to the user. |
Methods| Name | Description | |
|---|---|---|
| Apply | Called when the user input has to be applied to the document being controlled. Returns if apply is successful. |
| AttachView | Attaches the current view to this controller. |
| Cancel | Cancels the current operation. |
| Compile | Compiles the current script. |
| DetachView | Detaches the current view from this controller. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| EhView_GotoCompilerError | Moves the script cursor to the location described by a compiler message. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Execute | Executes the script. |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HasExecutionErrors | Determines whether execution errors are present. |
| Initialize | Initializes the view with the current script data. |
| InitializeDocument | Initializes the controller with the document. |
| InternalCompiling | Performs compilation using the built-in script implementation. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Revert | Try to revert changes to the model, i.e. restores the original state of the model. |
| SetText | Sets the script text in the view. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Update | Updates the model with the current script text. |
Fields| Name | Description | |
|---|---|---|
 | _scriptExecutionHandler | Delegate that executes the current script. |
See Also