Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DiagramBpmnSubEvent - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class DiagramBpmnSubEvent

    Represents the event placed within another subprocess.

    Inheritance
    System.Object
    SfDiagramBase
    DiagramBpmnSubEvent
    Inherited Members
    SfDiagramBase.UpdateCollection(IList, Boolean)
    SfDiagramBase.RandomString(Int32)
    Namespace: Syncfusion.Blazor.Diagrams
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class DiagramBpmnSubEvent : SfDiagramBase
    Remarks
    Users can set an event to a subprocess with the event and trigger the properties of the subprocess. The Type property of the subprocess allows you to define the type of subprocess.
    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 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}}
                    }
               },
            }
           }
          }
         };
       }

    Constructors

    DiagramBpmnSubEvent()

    Represents the event placed within another subprocess.

    Declaration
    public DiagramBpmnSubEvent()

    Properties

    Annotations

    Represents to connect an annotation element to the BpmnSubEvent.

    Declaration
    public ObservableCollection<DiagramNodeAnnotation> Annotations { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<DiagramNodeAnnotation>
    Remarks
    A BpmnSubEvent can be associated with a text annotation that does not affect the flow but gives details about objects within a flow.

    Event

    Gets or sets the type of BpmnEvent. By default, it is set to Start.

    Declaration
    public BpmnEvents Event { get; set; }
    Property Value
    Type Description
    BpmnEvents

    Height

    Gets or sets the height of the node.

    Declaration
    public double Height { get; set; }
    Property Value
    Type Description
    System.Double

    HorizontalAlignment

    Represents how to horizontally align a node concerning its parent. By default, it is set to Center.

    Declaration
    public HorizontalAlignment HorizontalAlignment { get; set; }
    Property Value
    Type Description
    HorizontalAlignment

    Id

    Specifies the Id of the BpmnSubEvent.

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    System.String

    Margin

    Specifies the space to be left between the node and its immediate parent. By default, it is set to 0.

    Declaration
    public DiagramMargin Margin { get; set; }
    Property Value
    Type Description
    DiagramMargin

    Offset

    Specifies the position of the sub-event. By default, it is set to 0.5 in X and Y.

    Declaration
    public BpmnSubEventOffset Offset { get; set; }
    Property Value
    Type Description
    BpmnSubEventOffset

    Ports

    Specifies the collection of connection points of the sub-events.

    Declaration
    public ObservableCollection<DiagramPort> Ports { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<DiagramPort>

    Trigger

    Specifies the type of event trigger. By default, it is set to Start.

    Declaration
    public BpmnTriggers Trigger { get; set; }
    Property Value
    Type Description
    BpmnTriggers

    VerticalAlignment

    Represents how to vertically align a node concerning its immediate parent. By default, it is set to Center.

    Declaration
    public VerticalAlignment VerticalAlignment { get; set; }
    Property Value
    Type Description
    VerticalAlignment

    Visible

    Specifies the visibility of the sub-event. By default, it is set to true.

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

    Width

    Gets or sets the width of the node.

    Declaration
    public double Width { get; set; }
    Property Value
    Type Description
    System.Double
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved