Click or drag to resize

IColumnScriptText Interface

[Missing <summary> documentation for "T:Altaxo.Scripting.IColumnScriptText"]


Namespace: Altaxo.Scripting
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public interface IColumnScriptText : IScriptText, 
	IPureScriptText, ICloneable, IDocumentLeafNode, INamedObject, IChangedEventSource, 
	ISuspendableByToken, ITunnelingEventSource, IDisposable, ITreeNodeWithParent<IDocumentLeafNode>, 
	ITreeNode<IDocumentLeafNode>, INodeWithParentNode<IDocumentLeafNode>

The IColumnScriptText type exposes the following members.

Properties
 NameDescription
Public propertyChildNodes Gets the child nodes.
(Inherited from ITreeNodeT)
Public propertyCodeEnd Gets the line after the user code ends
(Inherited from IScriptText)
Public propertyCodeHeader Gets the code header, i.e. the leading script text. This includes the using statements
(Inherited from IScriptText)
Public propertyCodeStart Gets the line before the user code starts
(Inherited from IScriptText)
Public propertyCodeTail Get the ending text of the script, dependent on the ScriptStyle.
(Inherited from IScriptText)
Public propertyCodeUserDefault Gets the default code (i.e. an code example)
(Inherited from IScriptText)
Public propertyErrors Returns the compiler errors as array of strings.
(Inherited from IScriptText)
Public propertyIsDisposed Gets a value indicating whether this instance is disposed.
(Inherited from IDocumentLeafNode)
Public propertyIsDisposeInProgress Gets a value indicating whether this instance is dispose in progress, or the instance is already disposed.
(Inherited from IDocumentLeafNode)
Public propertyIsReadOnly Returns true when the script text can not be modified. Use CloneForModification to obtain a writable copy.
(Inherited from IScriptText)
Public propertyIsSuspended Gets a value indicating whether this instance is suspended.
(Inherited from ISuspendableByToken)
Public propertyName Gets the name of this instance. An InvalidOperationException will be thrown if the name is not yet set or can not be retrieved.
(Inherited from INamedObject)
Public propertyParentNode Gets the parent node of this node.
(Inherited from INodeWithParentNodeT)
Public propertyParentObject Retrieves the parent object.
(Inherited from IDocumentLeafNode)
Public propertyScriptName
(Inherited from IScriptText)
Public propertyScriptObject
(Inherited from IScriptText)
Public propertyScriptObjectType Gives the type of the script object (full name), which is created after successfull compilation.
(Inherited from IScriptText)
Public propertyScriptText Get / sets the script text
(Inherited from IPureScriptText)
Public propertyUserAreaScriptOffset Gets the index in the script (considered as string), where the user area starts. This is momentarily behind the comment line " ----- add your script below this line ------"
(Inherited from IScriptText)
Top
Methods
 NameDescription
Public methodClearErrors Clears the errors.
(Inherited from IScriptText)
Public methodCloneCreates a new object that is a copy of the current instance.
(Inherited from ICloneable)
Public methodCloneForModification This clones the script so that the text can be modified.
(Inherited from IScriptText)
Public methodCompile Does the compilation of the script into an assembly. If it was not compiled before or is dirty, it is compiled first. From the compiled assembly, a new instance of the newly created script class is created and stored in m_ScriptObject.
(Inherited from IScriptText)
Public methodCopyFrom Copies the content of a script to here.
(Inherited from IScriptText)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodEhParentTunnelingEventHappened
(Inherited from IDocumentLeafNode)
Public methodExecuteWithSuspendedNotifications Executes the script. If no instance of the script object exists, a error message will be stored and the return value is false. If the script object exists, the data change notifications will be switched of (for all tables). Then the Execute function of this script object is called. Afterwards, the data changed notifications are switched on again.
Public methodSetCompilerResult
(Inherited from IScriptText)
Public methodSetDisposeInProgress Sets the flag that dispose is in progress for this node and all child nodes recursively.
(Inherited from IDocumentLeafNode)
Public methodSuspendGetToken Suspends the event handling of the object by getting a suspend token. The event handling of the object is resumed when the suspend token is disposed.
(Inherited from ISuspendableByToken)
Public methodTryGetName Test if this item already has a name.
(Inherited from INamedObject)
Top
Events
 NameDescription
Public eventChangedFired when something in the object has changed.
(Inherited from IChangedEventSource)
Public eventTunneledEvent The event that is fired when the object is disposed. First argument is the sender, second argument is the original source, and third argument is the event arg.
(Inherited from ITunnelingEventSource)
Top
Extension Methods
 NameDescription
Public Extension MethodGetPropertyContext Gets the property context of the document node. If the provided node is not implementing IPropertyBagOwner, the parent nodes of this node are searched, until a node which implements IPropertyBagOwner is found.
(Defined by PropertyExtensions)
Top
See Also