Designer Behaviors

Overview

The IDesignerBehavior interface is the base behavior interface for Flow, Rule, MatrixRule, Form, Report, and TextMerge Designer entities. This interface includes common functionality of all designer behaviors, which may be needed to abstract from specific behaviors. This helps users configure the gallery dialog displayed when using the CREATE FLOW/RULE/FORM actions. This allows users to adjust the behavior's appearance in the dialog by modifying the behavior's properties. Below is a code example of the IDesignerBehavior interface.

public interface IDesignerBehavior
{
    string Name { get; }
    bool IsUserSettable { get; }
    string CreateGalleryImage { get; }
    string Category { get; }
    string GetDescription();
    string BaseEntityName { get; }
    int DisplayOrder { get; }
}

public interface IDesignerBehavior<T> : IDesignerBehavior
    where T: class
{
    DataDescription[] ProcessInputDeclaration(T entity, DataDescription[] inputData);         

    void OnBehaviorAssigned(T entity);
}

IDesignerBehavior Properties

Example

In most cases, simply overriding the Category property and GetDescription() method will be needed. The Name and BaseEntityName will be generated from the behavior class name. These can be overridden if a user wants to specify a different Name for behavior and BaseEntityName.

Below is a code example of creating a Healthcare category in the Flow Designer entity. 

public class InsuranceFlowBehavior : DefaultFlowBehavior
    {
        public override int DisplayOrder => 0;
        public override string Category => "Healthcare";
        public override string GetDescription()
        {
            return "Flow type allows to identify client insurance needs.";
        }
    }
 
    public class AccidentFlowBehavior : DefaultFlowBehavior
    {
        public override int DisplayOrder => 10;
        public override string BaseEntityName => "Accident Action";
        public override string Category => "Healthcare";
        public override string GetDescription()
        {
            return "Flow type allows to identify insurance payout in case of an accident.";
        }
    }