Compiled.EDD.Scripting Namespace |
Class | Description | |
---|---|---|
CustomReportRow |
Represents a custom item that can be reported on. Not intended to be created
outside of a ScriptReport instance.
| |
DocumentItem |
Represents an item in ReadySuite. Contains a collection of field
data, PageItem's, TextItem's and
NativeItem.
| |
FieldContainerT |
FieldContainer is responsible for executing a scripted field assigned a FieldItem.
| |
FieldContext |
Provides the context for performing available actions within a FieldContainerT.
| |
FieldItem |
Represents a field that can hold data for a DocumentItem.
| |
FieldItemAttribute |
Specifies the settings for a FieldItem when used withScriptOptions.
These settings can limit the field creation and fields available in the ScriptOptions.
| |
FieldSetItem |
Represents a set or collection of FieldItem | |
FindAndReplaceItem |
Represents a single entry for a find/replace action.
| |
FolderPathEditor |
UI editor for browsing or selecting a folder path. Use with a ScriptOptions instance to
allow a user to assign a folder path to an option property.
| |
NativeItem |
Represents a native file link path to a DocumentItem.
| |
NotNullOrEmptyCollectionAttribute |
Validation attribute for not null or empty collections used with ScriptOptions.
| |
PageItem |
Represents an individual page file link path in a DocumentItem.
| |
ProjectItem |
Represents a project.
| |
RequiredIfAttribute |
Provides conditional validation based on a related property value when used with ScriptOptions.
| |
ResourceFileItem |
Represents a base resource/file pertaining to a DocumentItem.
| |
SaveFileNameEditor |
UI editor for browsing or selecting a folder path. Use with a ScriptOptions instance to
allow a user to assign a folder path to an option property.
| |
ScriptAttribute |
Script attributes assigned to a script. This class cannot be inherited.
| |
ScriptAuthor |
Represents author information for a script.
| |
ScriptAuthorAttribute |
Assigns related author metadata to the script. This class cannot be inherited.
| |
ScriptCategoryReport |
Represents a report intended to show categories of data when used in a ScriptContainer.
| |
ScriptContainer |
ScriptContainer is responsible for hosting and running a script module.
| |
ScriptContext |
Provides the context for performing available actions within a ScriptContainer.
| |
ScriptGuidAttribute |
Assigns a unique identifier to the script. This class cannot be inherited.
| |
ScriptMessageEventArgs |
Contains information about a log message event during script execution.
| |
ScriptOptions |
Represents a base class intended to be extended for setting available options in a ScriptContainer.
| |
ScriptProgressEventArgs |
Contains information about progress on a Document action in a script.
| |
ScriptReport |
Represents a base class intended to be extended for showing an execution report from a ScriptContainer.
| |
ScriptTextReport |
Represents a report intended to show only text data when used in a ScriptContainer.
| |
ScriptUtil |
Contains helpful utilities that can be used by scripts.
| |
ScriptWarningEventArgs |
Contains information about a warning message event during script execution.
| |
TextItem |
Represents an individual text file link path in a DocumentItem.
|
Interface | Description | |
---|---|---|
IChoiceFieldItem |
Interface to manage the choices on a FieldItem.
| |
IContainer |
Interface to represent a container used to execute scripts.
| |
IFieldContainerT |
Interface to represent a script scoped to a single FieldItem.
| |
IFieldContainerBase |
Base interface to represent a script scoped to a single FieldItem.
| |
IFieldContext |
Defines the actions available to a script within a IFieldContainerT.
| |
IScriptContainer |
Interface to represent a script scoped to a DocumentItem set.
| |
IScriptContext |
Defines the actions available to a script within a IScriptContainer.
|
Enumeration | Description | |
---|---|---|
ChoiceFieldItemType |
Specifies the type of choice field.
| |
ContainerType |
Specifies the container type of a script.
| |
FieldItemLevel |
Indicates the field level source in a DocumentItem.
| |
FieldItemScope |
Indicates the creation scope of a FieldItem.
| |
FieldItemType |
Indicates the data type of a FieldItem.
| |
FieldSetItemType |
Indicates the type of a FieldSetItem.
| |
ProgressAction |
Specifies actions performed on a document for progress events.
| |
ProjectItemType |
Indicates the type of a ProjectItem.
| |
ScriptProgressItem |
Specifies items that are reported on for progress related events.
| |
ScriptProgressMode |
Specifies if progress is updated automatically in the ScriptContainer or
if the script author has manually implement progress updates.
|