Base |
Represents the base class of all plugins of type dialog automation. A dialog automation should be able to prompt the user when it is executed.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElementBoolean
RAYLASE.Marker.JobElementBaseDialogAutomation
RAYLASE.MarkerPlugin.JobElementsDialogAutomation
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.JobElementBaseJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElement
RAYLASE.Marker.JobElementBaseAutomationJobElementBoolean
RAYLASE.Marker.JobElementBaseDialogAutomation
RAYLASE.MarkerPlugin.JobElementsDialogAutomation
Namespace: RAYLASE.Marker.JobElement
Assembly: RAYLASE.Marker.JobElement (in RAYLASE.Marker.JobElement.dll) Version: 2.19.0
SyntaxC#
public abstract class BaseDialogAutomation : BaseAutomationJobElement<bool>
The BaseDialogAutomation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BaseDialogAutomation | Initializes a new instance of the BaseDialogAutomation class |
Properties| Name | Description | |
|---|---|---|
 | ApplicationDataDirectory |
The directory where application data, such as logs and configurations, are stored.
(Inherited from BaseJobElement) |
 | CancelLabel | The label of the Cancel button |
| Condition |
The binning condition for the holder of the job element.
(Inherited from BaseJobElement) |
| ConfigurationManager | (Inherited from BasePlugin) |
| DeviceManager | (Inherited from BaseJobElement) |
| DirtyFlagLocker |
The lock object for property modification.
(Inherited from BaseJobElement) |
| DoHandleConditionPortChangedDelegate | (Inherited from BaseJobElement) |
| HasVariable | The flag to indicate whether the dialog should ask for a value for a variable to be entered. |
| IsDirty |
The flag to indicate whether the content of this job element has been modified.
(Inherited from BaseJobElement) |
| IsModal | The flag to indicate whether the dialog is modal. |
| JobElementID |
The unique ID of the job element. If the concrete class inherits from BaseJobElement, the JobElementID of the BaseJobElement will be prefilled. Recommended not to be changed.
(Inherited from BaseJobElement) |
| LogDirectory |
The directory of the log file.
(Inherited from BasePlugin) |
| Logger |
The common logger.
(Inherited from BasePlugin) |
| Message | The message to be displayed during the prompting. |
| OkLabel | The label of the OK button. |
| PluginMetadata |
The metadata of the plugin instances. If the concrete class inherits from the BasePluginSetup interface, the metadata of the BasePluginSetup will be prefilled.
(Inherited from BasePlugin) |
| PropertyMask | (Inherited from BaseJobElement) |
| ShouldExecute |
The flag to indicate whether the job element should be marked.
(Inherited from BaseAutomationJobElement) |
| ShowConditionControllerUIDelegate |
The delegate to show the controller UI because no ports have been defined.
(Inherited from BaseJobElement) |
| Title | The title of the prompt. |
| VariableManager | (Inherited from BaseJobElement) |
| VariableName | The name of the variable holding the entered value. |
| VariableScopeName | (Inherited from BaseJobElement) |
Methods| Name | Description | |
|---|---|---|
 | CompareWith | (Inherited from BaseJobElement) |
| CopyFrom |
Copies the source job element into this job element.
(Inherited from BaseJobElement) |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | (Inherited from BasePlugin) |
| DisposeUI | (Inherited from BaseJobElement) |
| DoCompareWith | (Inherited from BaseJobElement) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoGetUIMask | (Inherited from BaseJobElement) |
| DoShowUI(String) | (Inherited from BaseJobElement) |
| DoShowUI(JobElementHolder, String) | (Inherited from BaseJobElement) |
| DoShowUI(JobElementHolder, String, PropertyMask) | (Inherited from BaseJobElement) |
| DoShowUICallback(PluginSettingsView) |
This callback method is called when a GUI settings dialog is closed
with Apply or OK and is used to extract the changed properties from
a settings dialog in the GUI.
(Inherited from BaseJobElement) |
| DoShowUICallback(JobElementHolder, PluginSettingsView) |
This callback method is called when a GUI settings dialog is closed
with Apply or OK and is used to extract the changed properties from
a settings dialog in the GUI.
(Inherited from BaseJobElement) |
| Execute |
Executes the automation and return the result.
(Inherited from BaseAutomationJobElementT) |
| GenerateLocalTag | (Inherited from BaseJobElement) |
| GetUIMask | (Inherited from BaseJobElement) |
| HandleConditionPortChanged |
Performs necessary adjustments whenever the controller has updated its ports.
(Inherited from BaseJobElement) |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin) |
| ShowUI(String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String) | (Inherited from BaseJobElement) |
| ShowUI(JobElementHolder, String, PropertyMask) | (Inherited from BaseAutomationJobElementT) |
| ShowUICallback(PluginSettingsView) | (Inherited from BaseJobElement) |
| ShowUICallback(JobElementHolder, PluginSettingsView) | (Inherited from BaseAutomationJobElementT) |
| ShowUICancelCallback(PluginSettingsView) |
Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin) |
| ShowUICancelCallback(JobElementHolder, PluginSettingsView) | (Inherited from BaseJobElement) |
| ToString | (Inherited from BasePlugin) |
| UpdateFieldT |
Updates the Property to the value by using DirtyFlagLocker and setting IsDirty .
(Inherited from BaseJobElement) |
See Also