# Interface IDesignerParameterFormatProvider

OptimaJet.Workflow.Core.Runtime.IDesignerParameterFormatProvider

Supplies the Workflow Designer with metadata used to build structured editors for the parameters of named workflow actions, conditions, and rules.

Namespace: [OptimaJet.Workflow.Core.Runtime](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/)

```csharp
public interface IDesignerParameterFormatProvider
```

## Type Hierarchy

-   IDesignerParameterFormatProvider Current type
    -   Derived interfaces
        -   [ICustomDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomDesignerParameterFormatProvider/)
            -   [ICustomMixProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomMixProvider/)
    -   Implementing types
        -   [ActiveDirectoryDesignerParameterFormatProvider](https://api.workflowengine.io/active-directory-plugin/OptimaJet.Workflow.Plugins.ActiveDirectoryPlugin.Providers/ActiveDirectoryDesignerParameterFormatProvider/)
        -   [AggregatingDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/AggregatingDesignerParameterFormatProvider/)
        -   [DeactivatedDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/DeactivatedDesignerParameterFormatProvider/)
        -   [EmptyDesignerParameterFormatProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/EmptyDesignerParameterFormatProvider/)
        -   [ProviderProviders<TEnumProviders>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ProviderProviders-TEnumProviders/)
            -   [FilePlugin](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins/FilePlugin/)
            -   [FTPProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.FTPProvider/FTPProvider/)
        -   [WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowActionAndDesignerParameterFormatProvider-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)
            -   [CustomMixProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/CustomMixProvider-EnumActions-EnumActionsAsync-EnumConditions-EnumConditionsAsync/)
                -   [CompressProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.CompressProvider/CompressProvider/)
                -   [DirectoryFTPProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.SFTPProvider.DirectoryFTPProvider/DirectoryFTPProvider/)
                -   [DirectoryProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.DirectoryProvider/DirectoryProvider/)
                -   [FileFTPProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.SFTPProvider.FileFTPProvider/FileFTPProvider/)
                -   [FileProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.FileProvider/FileProvider/)
                -   [ListFilesProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.ListFilesProvider/ListFilesProvider/)
                -   [WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowPlugin-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)
                    -   [ApprovalPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/ApprovalPlugin/)
                    -   [LoopPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/LoopPlugin/)
                    -   [WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowPluginWithRuleProvider-EnumActions-EnumActionsAsync-EnumConditions-EnumConditionsAsync-EnumRules-EnumRulesAsync/)
                        -   [BasicPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/BasicPlugin/)

## Methods

`List<CodeActionParameterDefinition> GetFormat(CodeActionType type, string name, string schemeCode)` 

Gets the ordered form-field definitions for a named action, condition, or rule.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `type` | `CodeActionType` | The parameter usage context: [CodeActionType.Action](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/CodeActionType/), [CodeActionType.Condition](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/CodeActionType/), [CodeActionType.RuleCheck](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/CodeActionType/), or [CodeActionType.RuleGet](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/CodeActionType/). |
| `name` | `String` | The action, condition, or rule name selected in the Designer. |
| `schemeCode` | `String` | The current process scheme code, which can be used to provide scheme-specific fields. The value may be [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) when the format is requested without a process scheme context. |

### Returns

| Type | Description |
| --- | --- |
| `List<CodeActionParameterDefinition>` | An ordered list containing one [CodeActionParameterDefinition](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/CodeActionParameterDefinition/) per form field. Returning [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) or an empty list indicates that no structured parameter editor is defined; the Designer then uses its raw JSON editor. |

## Remarks

When a user edits an action parameter on an activity, a condition parameter on a transition, or a rule parameter on an actor, the Designer requests definitions for the selected provider method and the current process scheme. Each [CodeActionParameterDefinition](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/CodeActionParameterDefinition/) describes one form field, including its name, label, control type, required state, default value, available choices, and explanatory text.

The Designer serializes the values entered in the generated form into the parameter string stored in the process scheme. At runtime, that string is passed to the corresponding [IWorkflowActionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IWorkflowActionProvider/) or [IWorkflowRuleProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IWorkflowRuleProvider/) method. This provider supplies design-time UI metadata only; it does not parse the resulting value or execute the action, condition, or rule.

A non-empty [CodeActionDefinition.ParameterDefinitions](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/CodeActionDefinition/) collection declared directly on a matching scheme code action takes precedence over this provider. If neither the code action nor this provider supplies definitions, the Designer uses its raw JSON parameter editor instead of a generated form.

[Previous IDesignerAutocompleteProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IDesignerAutocompleteProvider/) [Next ILocalizationProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/ILocalizationProvider/)