Click or drag to resize
PluginBase Class
General base class for LLBLGen Pro plug-ins. Every plug-in has to derive from this base class.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ApplicationCore.ExtensibilityPluginBase

Namespace:  SD.LLBLGen.Pro.ApplicationCore.Extensibility
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.2.0.0 (5.2.17.0403)
Syntax
public abstract class PluginBase

The PluginBase type exposes the following members.

Constructors
  NameDescription
Protected methodPluginBase
Creates a new PluginBase instance.
Top
Properties
  NameDescription
Public propertyCallbacks
Sets the callbacks hashtable. Callbacks are used to produce a progress bar for example.
Public propertyConfigurationSettings
Gets / sets LLBLGen Pro configurationSettings for the plugin to use.
Public propertyEntities
Gets / sets entities to use.
Public propertyExecutionResult
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.
Public propertyFullPathPluginRootFolder
Gets / sets FullPathPluginRootFolder. This path is useful for the plugin to read/write settings.
Public propertyPreferences
Gets / sets the LLBLGen Pro preferences of the current user.
Public propertyProjectToTarget
Gets / sets the project to target
Public propertyRootDocuments
Gets or sets the root derived elements to use.
Public propertySPCalls
Gets / sets SPCalls to use
Public propertyTargetValue
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.
Public propertyTvfCalls
Gets or sets the TVF calls to use
Public propertyTypedLists
Gets / sets typedLists to use
Public propertyTypedViews
Gets / sets typedViews to use
Public propertyValueTypes
Gets / sets Valuetypes to use
Top
Methods
  NameDescription
Public methodBeforeExecute
Executes the plugin with the knowledge that it's executed before an action and that it can cancel that action by returning false.
Protected methodCreateAndDispatchCorrectableMessage
Creates a new correctable message which won't receive choices/step corrections, and which is dispatched directly
Protected methodCreateAndDispatchNormalMessage
Creates a new normal message which is dispatched directly
Protected methodCreateCorrectableMessage
Creates a new correctable message. Use this method to create a message to append corrections to and dispatch at a later point
Public methodDescribe
Describes this plugin. It has to return a filled in PluginDescription object.
Protected methodDispatchCorrectableMessage
Dispatches the correctable message.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute
Executes the plugin.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetConfigurationControl
Gets the configuration control for this plugin. The control is hosted by the plugin execution form.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodLogLineToApplicationOutput(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
Protected methodLogLineToApplicationOutput(String, String, Boolean)
Logs the line passed in to application output using the settings specified, as a non-verbose message
Protected methodLogLineToApplicationOutput(String, String, Boolean, Boolean)
Logs the line passed in to application output using the settings specified
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOpenDockedWindow
Opens the passed in, closed, form as a docked window in the llblgen pro designer.
Protected methodOpenLogViewerWindow
Opens a log viewer window with the node passed in.
Protected methodProgressSubtaskComplete
Makes the progress viewer to advance the subtask progress bar 1 position
Protected methodProgressSubtaskInit
Initializes the subtask progress bar with the number of subtasks to complete
Protected methodProgressSubtaskStart
Makes the progress viewer know that a subtask has started. The description is displayed for the subtask
Protected methodProgressTaskComplete
Makes the progress viewer to advance the task progress bar 1 position
Protected methodProgressTaskInit
Initializes the progress viewer with the number of tasks to complete
Protected methodProgressTaskStart
Makes the progress viewer know that a task has started. The description is displayed for the task
Public methodReset
Resets this instance. All contained collections are cleared.
Public methodToString
Returns a String that represents the current Object.
(Overrides ObjectToString.)
Top
Events
  NameDescription
Public eventOpenWindow
Event which is raised when OpenWindow is called.
Public eventShowLogViewer
Top
See Also