Click or drag to resize

IScriptContext Methods

The IScriptContext type exposes the following members.

Methods
  NameDescription
Public methodAddMessage(String)
Adds the information message to the event log.
Public methodAddMessage(DocumentItem, String)
Adds the information message to the event log with a related DocumentItem.
Public methodAddWarning(String)
Adds the warning message to the event log.
Public methodAddWarning(DocumentItem, String)
Adds the warning message to the event log with a related DocumentItem.
Public methodCreateDocument
Creates the supplied document.
Public methodCreateField(String)
Creates a new field with a Text FieldItemType.
Public methodCreateField(String, ChoiceFieldItemType)
Creates the given field name as choice or multi-choice if it does not exist.
Public methodCreateField(String, FieldItemType)
Creates a new field using the given FieldItemType.
Public methodCreateFieldSet
Create field set with given collection of fields
Public methodDeleteField
Deletes the field from the project schema.
Public methodGetCustomFields
Gets a list of the custom (User) fields available to the script.
Public methodGetDocuments
Gets a list of documents based on the documents already available in the context.
Public methodGetField
Gets the instance of the field based on the name.
Public methodGetFields
Gets all the application fields that exist.
Public methodGetFieldSet(String)
Get field set with given name
Public methodGetFieldSet(FieldSetItemType)
Get field set with given type
Public methodGetFieldSets
Get all field sets
Public methodGetNewDocument
Gets a new document reference with the supplied docid.
Public methodGetNewDocuments
Gets the list of new documents that have been created by the script.
Public methodGetOrCreateField(String, ChoiceFieldItemType)
Gets or creates the field matching both the given name and choice type.
Public methodGetOrCreateField(String, FieldItemType)
Gets or creates the field matching both the given name and field data type.
Public methodGetProject
Gets active project
Public methodGetRemovedDocuments
Gets the list of documents that have been marked as removed by the script.
Public methodHasField
Determines whether the specified field name exists.
Public methodReadDocument
Reads the next document in the list available to the script.
Public methodReadDocument(DocumentItem)
Marks the document as being read by the script. Primarily used for progress updates.
Public methodRemoveDocument
Flags the document as being removed by the script.
Public methodRenameField
Renames the given field in the schema.
Public methodThrowIfCancellationRequested
Throws a OperationCanceledException if cancellation is requested.
Public methodTryConvertFieldType
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.
Public methodTryGetOrCreateField(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.
Public methodTryGetOrCreateField(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.
Public methodUpdateDocument
Updates and commits the changes to the document.
Top
See Also