Class StdBSExtensibility
Inheritance
Inherited Members
Namespace: StdPlatBS100
Assembly: StdPlatBS100.dll
Syntax
public class StdBSExtensibility
Constructors
StdBSExtensibility()
Declaration
public StdBSExtensibility()
Properties
ActiveComponents
Gets the active components.
Declaration
public ActiveExtensibilityComponents ActiveComponents { get; }
Property Value
Type | Description |
---|---|
Primavera.Extensibility.BusinessEntities.ExtensibilityService.ActiveExtensibilityComponents |
Configuration
Configuração de extensões.
Declaration
public StdBSExtensibilityConfiguration Configuration { get; }
Property Value
Type | Description |
---|---|
StdBSExtensibilityConfiguration |
ExtensionsNotLoaded
Gets the extensions not loaded.
Declaration
public List<Extension> ExtensionsNotLoaded { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Primavera.Extensibility.BusinessEntities.Data.Extension> |
IsOperational
Gets a value indicating whether this instance is operational.
Declaration
public bool IsOperational { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Logger
Gets the extensibility logger.
Declaration
public IExtensibilityLogger Logger { get; set; }
Property Value
Type | Description |
---|---|
Primavera.Extensibility.Patterns.IExtensibilityLogger |
PEXLicense
Gets a value indicating whether this instance has pex license.
Declaration
public PEXLicense PEXLicense { get; }
Property Value
Type | Description |
---|---|
Primavera.Extensibility.Constants.ExtensibilityService.PEXLicense |
Version
Gets the version.
Declaration
public string Version { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
CreateCustomFormInstance(Type)
Creates the custom form instance.
Declaration
public ExtensibilityResult CreateCustomFormInstance(Type formType)
Parameters
Type | Name | Description |
---|---|---|
System.Type | formType | Type of the form. |
Returns
Type | Description |
---|---|
Primavera.Extensibility.BusinessEntities.ExtensibilityService.ExtensibilityResult |
ExecuteCustomCode(CustomCodeDefinition)
Executes the custom code.
Declaration
public ExtensibilityResult ExecuteCustomCode(CustomCodeDefinition customCodeDefinition)
Parameters
Type | Name | Description |
---|---|---|
Primavera.Extensibility.BusinessEntities.Data.CustomCodeDefinition | customCodeDefinition | The custom code definition. |
Returns
Type | Description |
---|---|
Primavera.Extensibility.BusinessEntities.ExtensibilityService.ExtensibilityResult |
GetCopyOfCustomTabInstance(Object, Object)
Gets the copy of custom tab instance.
Declaration
public object GetCopyOfCustomTabInstance(object customTab, object parentForm)
Parameters
Type | Name | Description |
---|---|---|
System.Object | customTab | The custom tab. |
System.Object | parentForm | The parent form. |
Returns
Type | Description |
---|---|
System.Object |
GetCustomCodeForExtension(String)
Gets the custom code for extension.
Declaration
public IEnumerable<CustomCodeDefinition> GetCustomCodeForExtension(string extension)
Parameters
Type | Name | Description |
---|---|---|
System.String | extension | The extension. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<Primavera.Extensibility.BusinessEntities.Data.CustomCodeDefinition> |
GetCustomFormsForExtension(String)
Gets the custom forms for extension.
Declaration
public IEnumerable<CustomComponentDefinition> GetCustomFormsForExtension(string extension)
Parameters
Type | Name | Description |
---|---|---|
System.String | extension | The extension. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<Primavera.Extensibility.BusinessEntities.Data.CustomComponentDefinition> |
GetCustomTabsForController(Type, String)
Gets the custom tabs for controller.
Declaration
public ExtensibilityResult GetCustomTabsForController(Type controllerType, string controllerName)
Parameters
Type | Name | Description |
---|---|---|
System.Type | controllerType | Fully qualified type of the controler. |
System.String | controllerName | Name of the controler. |
Returns
Type | Description |
---|---|
Primavera.Extensibility.BusinessEntities.ExtensibilityService.ExtensibilityResult |
GetUnsupportedComponents(String)
Gets the assembly pex only components.
Declaration
public IEnumerable<Type> GetUnsupportedComponents(string extensionFileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | extensionFileName | The assembly file. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.Type> |
IgnoreCustomForm(String, String)
Add A custom form to a ignore list to avoid it's load.
Declaration
public void IgnoreCustomForm(string extension, string formType)
Parameters
Type | Name | Description |
---|---|---|
System.String | extension | |
System.String | formType |
IgnoreCustomFunction(String, String)
Add A custom function (code) to a ignore list to avoid it's load.
Declaration
public void IgnoreCustomFunction(string extension, string functionSignature)
Parameters
Type | Name | Description |
---|---|---|
System.String | extension | |
System.String | functionSignature |
IgnoreCustomTab(String, String)
Add A custom tab to a ignore list to avoid it's load.
Declaration
public void IgnoreCustomTab(string extension, string tabType)
Parameters
Type | Name | Description |
---|---|---|
System.String | extension | |
System.String | tabType |
Initialize(Object, IExtensibilityLogger)
Initializes the specified erp engine.
Declaration
public bool Initialize(object erpEngine, IExtensibilityLogger logger = null)
Parameters
Type | Name | Description |
---|---|---|
System.Object | erpEngine | The erp engine. |
Primavera.Extensibility.Patterns.IExtensibilityLogger | logger | The logger. |
Returns
Type | Description |
---|---|
System.Boolean |
LoadExtensions()
Loads the extensions.
Declaration
public void LoadExtensions()
Restart()
Restarts this instance.
Declaration
public bool Restart()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldIgnoreKeyPress(String, Object[])
Shoulds the ignore key press.
Declaration
public bool ShouldIgnoreKeyPress(string eventName, params dynamic[] parameters)
Parameters
Type | Name | Description |
---|---|---|
System.String | eventName | Name of the event. |
System.Object[] | parameters | The parameters. |
Returns
Type | Description |
---|---|
System.Boolean |
ShowCustomForm(CustomComponentDefinition)
Shows the custom form.
Declaration
public ExtensibilityResult ShowCustomForm(CustomComponentDefinition customComponentDefinition)
Parameters
Type | Name | Description |
---|---|---|
Primavera.Extensibility.BusinessEntities.Data.CustomComponentDefinition | customComponentDefinition | The custom component definition. |
Returns
Type | Description |
---|---|
Primavera.Extensibility.BusinessEntities.ExtensibilityService.ExtensibilityResult |
Terminate()
Terminates this instance.
Declaration
public void Terminate()
TriggerEvent(Object, String, String, Sender, SyncEventType, Object[])
Triggers the event.
Declaration
public ExtensibilityResult TriggerEvent(object contextObject, string workingModule, string eventName, Sender sender, SyncEventType syncEventType, params object[] parameters)
Parameters
Type | Name | Description |
---|---|---|
System.Object | contextObject | The context object. |
System.String | workingModule | The working module. |
System.String | eventName | Name of the event. |
Primavera.Extensibility.Constants.ExtensibilityService.Sender | sender | The sender. |
Primavera.Extensibility.Constants.ExtensibilityService.SyncEventType | syncEventType | Type of the synchronize event. |
System.Object[] | parameters | The parameters. |
Returns
Type | Description |
---|---|
Primavera.Extensibility.BusinessEntities.ExtensibilityService.ExtensibilityResult |
TriggerEvent(Object, String, String, Object[])
Triggers the event.
Declaration
public ExtensibilityResult TriggerEvent(object contextObject, string workingModule, string eventName, params object[] parameters)
Parameters
Type | Name | Description |
---|---|---|
System.Object | contextObject | The context object. |
System.String | workingModule | The working module. |
System.String | eventName | Name of the event. |
System.Object[] | parameters | The parameters. |
Returns
Type | Description |
---|---|
Primavera.Extensibility.BusinessEntities.ExtensibilityService.ExtensibilityResult |