IScriptContext Interface |  |
Defines the actions available to a script within a IScriptContainer.
Namespace: Compiled.EDD.Scripting
Assembly: Compiled.EDD.Scripting (in Compiled.EDD.Scripting.dll) Version: 7.6.1.3-5cb5c356
SyntaxC#
public interface IScriptContext
The IScriptContext type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Document |
Gets the active document in the list.
|
| IsCancellationRequested |
Gets whether cancellation has been requested.
|
Methods| Name | Description | |
|---|---|---|
 | AddMessage(String) |
Adds the information message to the event log.
|
| AddMessage(DocumentItem, String) |
Adds the information message to the event log with a related DocumentItem.
|
| AddWarning(String) |
Adds the warning message to the event log.
|
| AddWarning(DocumentItem, String) |
Adds the warning message to the event log with a related DocumentItem.
|
| CreateDocument |
Creates the supplied document.
|
| CreateField(String) |
Creates a new field with a Text FieldItemType.
|
| CreateField(String, ChoiceFieldItemType) |
Creates the given field name as choice or multi-choice if it does not exist.
|
| CreateField(String, FieldItemType) |
Creates a new field using the given FieldItemType.
|
| CreateFieldSet |
Create field set with given collection of fields
|
| DeleteField |
Deletes the field from the project schema.
|
| GetCustomFields |
Gets a list of the custom (User) fields available to the script.
|
| GetDocuments |
Gets a list of documents based on the documents
already available in the context.
|
| GetField |
Gets the instance of the field based on the name.
|
| GetFields |
Gets all the application fields that exist.
|
| GetFieldSet(String) |
Get field set with given name
|
| GetFieldSet(FieldSetItemType) |
Get field set with given type
|
| GetFieldSets |
Get all field sets
|
| GetNewDocument |
Gets a new document reference with the supplied docid.
|
| GetNewDocuments |
Gets the list of new documents that have been created by the script.
|
| GetOrCreateField(String, ChoiceFieldItemType) |
Gets or creates the field matching both the given name and choice type.
|
| GetOrCreateField(String, FieldItemType) |
Gets or creates the field matching both the given name and field data type.
|
| GetProject |
Gets active project
|
| GetRemovedDocuments |
Gets the list of documents that have been marked as removed by the script.
|
| HasField |
Determines whether the specified field name exists.
|
| ReadDocument |
Reads the next document in the list available to the script.
|
| ReadDocument(DocumentItem) |
Marks the document as being read by the script. Primarily used for progress updates.
|
| RemoveDocument |
Flags the document as being removed by the script.
|
| RenameField |
Renames the given field in the schema.
|
| ThrowIfCancellationRequested |
Throws a OperationCanceledException if cancellation is requested.
|
| TryConvertFieldType |
Attempts to convert the provided field to a new field type. A return value indicates whether the field
was converted successfully to the new field type.
|
| TryGetOrCreateField(String, ChoiceFieldItemType, FieldItem) |
Gets or creates the field matching both the given name and choice type. A return value indicates
an existing field with type was found or a new field instance was created successfully.
|
| TryGetOrCreateField(String, FieldItemType, FieldItem) |
Gets or creates the field matching both the given name and field type. A return value indicates
an existing field with type was found or a new field instance was created successfully.
|
| UpdateDocument |
Updates and commits the changes to the document.
|
See Also