PluginBase Class |
General base class for LLBLGen Pro plug-ins. Every plug-in has to derive from this base class.
Inheritance HierarchyNamespace: SD.LLBLGen.Pro.ApplicationCore.Extensibility
Assembly: SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.4.0.0 (5.4.0)
SyntaxThe PluginBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PluginBase |
Creates a new PluginBase instance.
|
Properties| Name | Description | |
|---|---|---|
 | Callbacks |
Sets the callbacks hashtable. Callbacks are used to produce a progress bar for example.
|
| ConfigurationSettings |
Gets / sets LLBLGen Pro configurationSettings for the plugin to use.
|
| Entities |
Gets / sets entities to use.
|
| ExecutionResult |
Gets the execution result of the Execution method. TargetValue and ExecutionResult are two variables used for plugins without an interface which have
to process data for the designer. ExecutionResult is also used if a return value is expected from the plugin.
|
| FullPathPluginRootFolder |
Gets / sets FullPathPluginRootFolder. This path is useful for the plugin to read/write settings.
|
| Preferences |
Gets / sets the LLBLGen Pro preferences of the current user.
|
| ProjectToTarget |
Gets / sets the project to target
|
| RootDocuments |
Gets or sets the root derived elements to use.
|
| SPCalls |
Gets / sets SPCalls to use
|
| TargetValue |
Gets or sets the target value of the plugin. Set this property if the plugin has to work on something else than project elements like entities, typedlists
and the like.
|
| TvfCalls |
Gets or sets the TVF calls to use
|
| TypedLists |
Gets / sets typedLists to use
|
| TypedViews |
Gets / sets typedViews to use
|
| ValueTypes |
Gets / sets Valuetypes to use
|
Methods| Name | Description | |
|---|---|---|
 | BeforeExecute |
Executes the plugin with the knowledge that it's executed before an action and that it can cancel that action by returning false.
|
| CreateAndDispatchCorrectableMessage |
Creates a new correctable message which won't receive choices/step corrections, and which is dispatched directly
|
| CreateAndDispatchNormalMessage |
Creates a new normal message which is dispatched directly
|
| CreateCorrectableMessage |
Creates a new correctable message. Use this method to create a message to append corrections to and dispatch at a later point
|
| Describe |
Describes this plugin. It has to return a filled in PluginDescription object.
|
| DispatchCorrectableMessage |
Dispatches the correctable message.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Execute |
Executes the plugin.
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetConfigurationControl |
Gets the configuration control for this plugin. The control is hosted by the plugin execution form.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| LogLineToApplicationOutput(String, String) |
Logs the line passed in to application output using the settings specified, as a non-verbose message and appends a newline to the line logged
|
| LogLineToApplicationOutput(String, String, Boolean) |
Logs the line passed in to application output using the settings specified, as a non-verbose message
|
| LogLineToApplicationOutput(String, String, Boolean, Boolean) |
Logs the line passed in to application output using the settings specified
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OpenDockedWindow |
Opens the passed in, closed, form as a docked window in the llblgen pro designer.
|
| OpenLogViewerWindow |
Opens a log viewer window with the node passed in.
|
| ProgressSubtaskComplete |
Makes the progress viewer to advance the subtask progress bar 1 position
|
| ProgressSubtaskInit |
Initializes the subtask progress bar with the number of subtasks to complete
|
| ProgressSubtaskStart |
Makes the progress viewer know that a subtask has started. The description is displayed for the subtask
|
| ProgressTaskComplete |
Makes the progress viewer to advance the task progress bar 1 position
|
| ProgressTaskInit |
Initializes the progress viewer with the number of tasks to complete
|
| ProgressTaskStart |
Makes the progress viewer know that a task has started. The description is displayed for the task
|
| Reset |
Resets this instance. All contained collections are cleared.
|
| ToString | (Overrides ObjectToString.) |
Events| Name | Description | |
|---|---|---|
 | OpenWindow |
Event which is raised when OpenWindow is called.
|
| ShowLogViewer |
See Also