Class BpmnTextAnnotation

Represents the information about any Bpmn element in the diagram.

Inheritance
System.Object
DiagramObject
Shape
BpmnTextAnnotation
Implements
System.ICloneable
Inherited Members
Namespace: Syncfusion.Blazor.Diagram
Assembly: Syncfusion.Blazor.dll
Syntax
public class BpmnTextAnnotation : Shape, IDiagramObject, ICloneable
Remarks

The BpmnTextAnnotation class is used to annotate BPMN diagrams with additional textual information.

It provides functionalities to target specific BPMN elements and specify the direction of the text annotation.

Examples
Node node = new Node()
{
    ID = "node1",
    Width = 70,
    Height = 70,
    OffsetX = 100,
    OffsetY = 300,
    Shape = new BpmnTextAnnotation()
    {
        TextAnnotationTarget = "node2",
        TextAnnotationDirection = TextAnnotationDirection.Auto
    }
};

Constructors

BpmnTextAnnotation()

Initializes a new instance of the BpmnTextAnnotation class.

Declaration
public BpmnTextAnnotation()

BpmnTextAnnotation(BpmnTextAnnotation)

Creates a new instance of the BpmnTextAnnotation class.

Declaration
public BpmnTextAnnotation(BpmnTextAnnotation src)
Parameters
Type Name Description
BpmnTextAnnotation src

An instance of BpmnTextAnnotation to copy data from.

Properties

TextAnnotationDirection

Gets or sets the direction of the text annotation with respect to target.

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

A TextAnnotationDirection value that specifies the direction of the BpmnTextAnnotation node. The default value is Auto.
Examples
Node node = new Node()
{
    ID = "node1",
    Width = 70,
    Height = 70,
    OffsetX = 100,
    OffsetY = 300,
    Shape = new BpmnTextAnnotation()
    {
        TextAnnotationTarget = "node2",
        TextAnnotationDirection = TextAnnotationDirection.Auto
    }
};

TextAnnotationTarget

Gets or sets the target Bpmn element to the current text annotation.

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

A System.String representing the unique ID of the target element which defines the target of the BpmnTextAnnotation.
Examples
Node node = new Node()
{
    ID = "node1",
    Width = 70,
    Height = 70,
    OffsetX = 100,
    OffsetY = 300,
    Shape = new BpmnTextAnnotation()
    {
        TextAnnotationTarget = "node2",
        TextAnnotationDirection = TextAnnotationDirection.Auto
    }
};

Methods

Clone()

Creates a new BpmnTextAnnotation that is a copy of the current BpmnTextAnnotation object.

Declaration
public override object Clone()
Returns
Type Description
System.Object

A new BpmnTextAnnotation that is a copy of this instance.
Overrides

Implements

System.ICloneable