<img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=6889170&amp;fmt=gif">
Skip to content
  • There are no suggestions because the search field is empty.

EDD Scripting | IScriptContext Interface

Defines the actions available to a script within a IScriptContainer.

Syntax

C# Copy 
public interface IScriptContext

The IScriptContext type exposes the following members.

Properties

Name Description
pubProperty Document Gets the active document in the list.
pubProperty IsCancellationRequested Gets whether cancellation has been requested.

Methods

Name Description
pubMethod AddMessage(String) Adds the information message to the event log.
pubMethod AddMessage(DocumentItem, String) Adds the information message to the event log with a related DocumentItem.
pubMethod AddWarning(String) Adds the warning message to the event log.
pubMethod  AddWarning(DocumentItem, String) Adds the warning message to the event log with a related DocumentItem.
pubMethod CreateDocument Creates the supplied document.
pubMethod CreateField(String) Creates a new field with a Text FieldItemType.
pubMethod CreateField(String, ChoiceFieldItemType) Creates the given field name as choice or multi-choice if it does not exist.
pubMethod CreateField(String, FieldItemType) Creates a new field using the given FieldItemType.
pubMethod CreateFieldSet Create field set with given collection of fields
pubMethod DeleteField Deletes the field from the project schema.
pubMethod GetCustomFields Gets a list of the custom (User) fields available to the script.
pubMethod GetDocuments Gets a list of documents based on the documents already available in the context.
pubMethod GetField Gets the instance of the field based on the name.
pubMethod GetFields Gets all the application fields that exist.
pubMethod GetFieldSet(FieldSetItemType) Get field set with given type
pubMethod GetFieldSet(String) Get field set with given name
pubMethod GetFieldSets Get all field sets
pubMethod GetNewDocument Gets a new document reference with the supplied docid.
pubMethod GetNewDocuments Gets the list of new documents that have been created by the script.
pubMethod GetOrCreateField(String, ChoiceFieldItemType) Gets or creates the field matching both the given name and choice type.
pubMethod GetOrCreateField(String, FieldItemType) Gets or creates the field matching both the given name and field data type.
pubMethod GetProject Gets active project
pubMethod GetRemovedDocuments Gets the list of documents that have been marked as removed by the script.
pubMethod HasField Determines whether the specified field name exists.
pubMethod ReadDocument() Reads the next document in the list available to the script.
pubMethod ReadDocument(DocumentItem) Marks the document as being read by the script. Primarily used for progress updates.
pubMethod RemoveDocument Flags the document as being removed by the script.
pubMethod RenameField Renames the given field in the schema.
pubMethod ThrowIfCancellationRequested Throws a OperationCanceledException if cancellation is requested.
pubMethod 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.
pubMethod 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.
pubMethod 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.
pubMethod UpdateDocument Updates and commits the changes to the document.

See Also

Reference
Compiled.EDD.Scripting Namespace