Click or drag to resize
PluginDescription Class
Plugin description object which is filled by the plugin when the plugin's Describe method is called. This object is used to present the plugin to the user and to determine what the location should be of the plugin in the user interface so the user can execute the plugin correctly.
Inheritance Hierarchy
SystemObject
  SD.LLBLGen.Pro.ApplicationCore.ExtensibilityPluginDescription

Namespace:  SD.LLBLGen.Pro.ApplicationCore.Extensibility
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.1.0.0 (5.1.0)
Syntax
public class PluginDescription

The PluginDescription type exposes the following members.

Constructors
  NameDescription
Public methodPluginDescription
Creates a new PluginDescription instance.
Top
Properties
  NameDescription
Public propertyAutoSubscribedEvents
Gets the list of designer events the plugin subscribes to
Public propertyBuild
Gets / sets build
Public propertyDescription
Gets / sets description
Public propertyExecutionCursor
Gets / sets the executionCursor, the cursor to show while the plugin is executing. Default is Cursors.WaitCursor.
Public propertyId
Gets or sets the id
Public propertyLogExecutionFeedback
Gets / sets LogExecutionFeedback. This flag, true by default, controls whether LLBLGen Pro logs lines in the application output that the plugin was executed.
Public propertyName
Gets / sets name
Public propertyRequiresProjectBackup
Gets / sets RequiresProjectBackup. This flag, true by default, controls plug-in developers if a backup of the project file is really necessary.
Public propertyShowProgressViewerDuringExecution
Gets / sets showProgressViewerDuringExecution. Set to true to have a progress viewer window. It's recommended this setting is set to true. If set to false, the user has no idea what the progress of the plugin is. Default is true.
Public propertySuppressCatalogExplorerRedraw
Gets / sets suppressCatalogExplorerRedraw. Set to true if you want to process a lot of objects which fire a lot of changed events, which will make the catalog explorer to redraw itself a lot. If this setting is set to true, the catalog explorer is reset prior to the plugin run, and refreshed after the plugin run. Default is false.
Public propertySuppressProjectExplorerRedraw
Gets / sets suppressProjectExplorerRedraw. Set to true if you want to process a lot of objects which fire a lot of changed events, which will make the project explorer to redraw itself a lot. If this setting is set to true, the project explorer is reset prior to the plugin run, and refreshed after the plugin run. Default is false.
Public propertyTargetType
Gets / sets targetType
Public propertyTypeOfPlugin
Gets / sets typeOfPlugin
Public propertyVendor
Gets / sets vendor
Public propertyVersion
Gets / sets version
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Overrides tostring
(Overrides ObjectToString.)
Top
See Also