Harness proD API Help
EPLAN.Harness.API.Plugins Namespace / IHpDLibraryPlugin Interface
Members
In This Topic
    IHpDLibraryPlugin Interface
    In This Topic
    Base interface for EPLAN Harness proD Library plugins.
    Syntax
    public interface IHpDLibraryPlugin : EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo, EPLAN.Harness.API.Plugins.Core.IPluginDisplayInfo
    Remarks
    Use this interface to implement your own plugins which are to be displayed and used in a running instance of EPLAN Harness proD Library.
    Public Properties
     NameDescription
    PropertyAuthor Author of this plugin and copyright information. (Inherited from EPLAN.Harness.API.Plugins.Core.IPluginDisplayInfo)
    PropertyButtonOrder Position of the button in the Ribbon group. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    PropertyButtonSize Button size. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    PropertyButtonText Text to be displayed in ribbon control if a plugin successfully loaded. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    PropertyButtonTooltip Tooltip to be displayed in ribbon control if a plugin successfully loaded. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    PropertyDescription Description of this plugin. (Inherited from EPLAN.Harness.API.Plugins.Core.IPluginDisplayInfo)
    PropertyEnabled If active, plugin button will be enabled. In order to propagate a change, INotifyPropertyChanged interface must be implemented. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    PropertyImageStream Image to be displayed in button if plugin successfully loaded. (Inherited from EPLAN.Harness.API.Plugins.Core.IPluginDisplayInfo)
    PropertyName Unique name of this plugin. (Inherited from EPLAN.Harness.API.Plugins.Core.IPluginDisplayInfo)
    PropertyVersion Version of this plugin. (Inherited from EPLAN.Harness.API.Plugins.Core.IPluginDisplayInfo)
    PropertyVisible If active, plugin button will be visible. In order to propagate a change, INotifyPropertyChanged interface must be implemented. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    PropertyVisibleInQuickAccessToolbar If active, plugin button will be displayed in ribbon's quick access toolbar. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    Top
    Public Methods
     NameDescription
    MethodExecute Execution of this plugin.  
    MethodInitialize Initialization of this plugin.  
    MethodModuleChanged If a module (Workspace, ProjectPage, Report, etc.) changes, ModuleChanged method is called informing user about the chagne. (Inherited from EPLAN.Harness.API.Plugins.Core.IHpDPluginInfo)
    MethodTerminate Termination of this plugin.  
    Top
    See Also

    Reference

    IHpDLibraryPlugin Members
    EPLAN.Harness.API.Plugins Namespace

    Send Feedback