Blazor

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DiagramBpmnSubProcess

    Show / Hide Table of Contents

    Class DiagramBpmnSubProcess

    This occurs within a process and it is broken down to a finer level of detail.

    Inheritance
    System.Object
    SfDiagramBase
    DiagramBpmnSubProcess
    Inherited Members
    SfDiagramBase.UpdateCollection(IList, Boolean)
    SfDiagramBase.RandomString(Int32)
    Namespace: Syncfusion.Blazor.Diagrams
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class DiagramBpmnSubProcess : SfDiagramBase
    Examples
    <SfDiagram Height="600px" Nodes="@NodeCollection">
    </SfDiagram>
    @code
    {
      //Initialize the node collection with node
      ObservableCollection<DiagramNode> NodeCollection = new ObservableCollection<DiagramNode>()
      {
        new DiagramNode()
        {
          //Position of the node
          OffsetX = 100, OffsetY = 100,
          //Size of the node
          Width = 100, Height = 100,
          //unique id of the node
          Id = "node1",
          //Defines the type to BPMN and shape to activity
          Shape = new DiagramShape()
          {
            Type = Shapes.Bpmn, BpmnShape = BpmnShapes.Activity,
            //Sets the activity to subprocess
            Activity=new DiagramBpmnActivity()
            {
              Activity = BpmnActivities.SubProcess,
              //sets collapsed and ad hoc to true
              SubProcess = new DiagramBpmnSubProcess()
              {
                Collapsed = true,
                Adhoc = true
               },
             }
            }
          },
        };
      }

    Constructors

    DiagramBpmnSubProcess()

    This occurs within a process and it is broken down to a finer level of detail.

    Declaration
    public DiagramBpmnSubProcess()

    Properties

    Adhoc

    Specifies whether the subprocess is without any prescribed order or not.

    Declaration
    public bool Adhoc { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks
    Specifies a subprocess is a group of tasks that are executed in any order or skipped to fulfill the end condition and set it with the Ad-hoc property of the subprocess.
    Examples
    Activity = BpmnActivities.SubProcess,
              //sets collapsed and ad hoc to true
              SubProcess = new DiagramBpmnSubProcess()
              {
                Collapsed = true,
                Adhoc = true
               },

    Boundary

    Represent the type of task that is being processed.

    Declaration
    public BpmnBoundary Boundary { get; set; }
    Property Value
    Type Description
    BpmnBoundary
    Remarks

    The Boundary property of the subprocess allows you to define the type of boundary.

    Examples
    Activity = BpmnActivities.SubProcess,
        //Sets collapsed to true and boundary to Call
        SubProcess = new DiagramBpmnSubProcess()
        {
          Collapsed = true,
          Boundary = BpmnBoundary.Call
        },

    Collapsed

    Specifies whether the shape is collapsed or not. By default, it is set to true.

    Declaration
    public bool Collapsed { get; set; }
    Property Value
    Type Description
    System.Boolean

    Compensation

    Specifies whether the task is triggered as compensation for another task.

    Declaration
    public bool Compensation { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Compensation is triggered when the operation is partially failed and enabled it with the compensation property of the task and the subprocess.

    Examples
    Activity = new DiagramBpmnActivity()
           {
             Activity = BpmnActivities.Task,
             //set compensation to true
             Task=new DiagramBpmnTask()
             {
               Compensation = true,
             },
            }

    Events

    It allows the user to define the type of event. The default value of the event starts.

    Declaration
    public ObservableCollection<DiagramBpmnSubEvent> Events { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<DiagramBpmnSubEvent>
    Remarks

    Event SubProcess has placed within another subprocess that part of the normal flow of its parent process is not.

    Loop

    Specifies the task that is internally being looped and allows users to define the type of loop. The default value for Loop is None.

    Declaration
    public BpmnLoops Loop { get; set; }
    Property Value
    Type Description
    BpmnLoops
    Examples
    Activity = BpmnActivities.SubProcess,
        //Sets collapsed to true and loop to standard
        SubProcess=new DiagramBpmnSubProcess()
        {
          Collapsed = true,
          Loop = BpmnLoops.Standard,
        },

    Processes

    Specifies an array collection that defines the children's values for the Bpmn subprocess.

    Declaration
    public string[] Processes { get; set; }
    Property Value
    Type Description
    System.String[]
    Examples
    SubProcess = new DiagramBpmnSubProcess() {
        Collapsed = false,
        Type = BpmnSubProcessTypes.Event,
        Processes = new string[] { "Start", "End", "Node1" }
        }

    Transaction

    Specifies the transaction of the subprocess.

    Declaration
    public DiagramBpmnTransactionSubProcess Transaction { get; set; }
    Property Value
    Type Description
    DiagramBpmnTransactionSubProcess
    Remarks
    The transaction is a set of activities that logically belong together that all contained activities must complete their parts of the transaction otherwise, the process is failed. The execution result of a transaction is one of the following.
    � Successful Completion.
    � Unsuccessful Completion (Cancel).
    � Hazard (Exception).
    Examples
    //Sets collapsed to true and type to Transaction
        SubProcess = new DiagramBpmnSubProcess()
        {
            Collapsed = true,
            Type = BpmnSubProcessTypes.Transaction,
            //Sets offset and visible for cancel and offset for failure
            Transaction = new DiagramBpmnTransactionSubProcess()
             {
                Cancel = new CancelSubEvent() { Visible = true, Offset = new BpmnSubEventOffset() { X = 0.25, Y = 1 } },
                Failure = new FailureSubEvent() { Offset = new BpmnSubEventOffset() { X = 0.75, Y = 1 } }
             }
         },

    Type

    Specifies the type of BpmnSubProcess. The default value for type is None.

    Declaration
    public BpmnSubProcessTypes Type { get; set; }
    Property Value
    Type Description
    BpmnSubProcessTypes
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved