Class DiagramAnnotationBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
DiagramAnnotationBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class DiagramAnnotationBuilder : ControlBuilder
Constructors
DiagramAnnotationBuilder()
Declaration
public DiagramAnnotationBuilder()
DiagramAnnotationBuilder(DiagramAnnotation)
Declaration
public DiagramAnnotationBuilder(DiagramAnnotation model)
Parameters
Methods
AddInfo(Object)
Allows the user to save custom information/data about an annotation
Declaration
public DiagramAnnotationBuilder AddInfo(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
AnnotationType(AnnotationType)
Defines the type of annotation template
String - Defines annotation template to be in string
Template - Defines annotation template to be in html content
Declaration
public DiagramAnnotationBuilder AnnotationType(AnnotationType value)
Parameters
Returns
Constraints(AnnotationConstraints)
Enables or disables the default behaviors of the label.
ReadOnly - Enables/Disables the ReadOnly Constraints
InheritReadOnly - Enables/Disables the InheritReadOnly Constraints
Declaration
public DiagramAnnotationBuilder Constraints(AnnotationConstraints value)
Parameters
Returns
Content(String)
Sets the textual description of the node/connector
Declaration
public DiagramAnnotationBuilder Content(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
DragLimit(Object)
Sets the space to be left between an annotation and its parent node/connector
Declaration
public DiagramAnnotationBuilder DragLimit(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Height(Double)
Sets the height of the text
Declaration
public DiagramAnnotationBuilder Height(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
HorizontalAlignment(HorizontalAlignment)
Sets the horizontal alignment of the text with respect to the parent node/connector
Stretch - Stretches the diagram element throughout its immediate parent
Left - Aligns the diagram element at the left of its immediate parent
Right - Aligns the diagram element at the right of its immediate parent
Center - Aligns the diagram element at the center of its immediate parent
Auto - Aligns the diagram element based on the characteristics of its immediate parent
Declaration
public DiagramAnnotationBuilder HorizontalAlignment(HorizontalAlignment value)
Parameters
Returns
Hyperlink(DiagramHyperlink)
Sets the hyperlink of the label
Declaration
public DiagramAnnotationBuilder Hyperlink(DiagramHyperlink value)
Parameters
Returns
Hyperlink(Action<DiagramHyperlinkBuilder>)
Declaration
public DiagramAnnotationBuilder Hyperlink(Action<DiagramHyperlinkBuilder> hyperlink)
Parameters
Returns
Id(String)
Defines the unique id of the annotation
Declaration
public DiagramAnnotationBuilder Id(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Margin(DiagramMargin)
Sets the space to be left between an annotation and its parent node/connector
Declaration
public DiagramAnnotationBuilder Margin(DiagramMargin value)
Parameters
Returns
Margin(Action<DiagramMarginBuilder>)
Declaration
public DiagramAnnotationBuilder Margin(Action<DiagramMarginBuilder> margin)
Parameters
Returns
RotateAngle(Double)
Sets the rotate angle of the text
Declaration
public DiagramAnnotationBuilder RotateAngle(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
RotationReference(RotationReference)
Gets or sets the reference mode for annotation rotation.
Declaration
public DiagramAnnotationBuilder RotationReference(RotationReference value)
Parameters
Returns
Style(DiagramTextStyle)
Defines the appearance of the text
Declaration
public DiagramAnnotationBuilder Style(DiagramTextStyle value)
Parameters
Returns
Style(Action<DiagramTextStyleBuilder>)
Declaration
public DiagramAnnotationBuilder Style(Action<DiagramTextStyleBuilder> style)
Parameters
Returns
Template(Object)
Sets the textual description of the node/connector
Declaration
public DiagramAnnotationBuilder Template(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Template(String)
Sets the textual description of the node/connector
Declaration
public DiagramAnnotationBuilder Template(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
This property is used to show tooltip for annotation on mouse over.
Declaration
public DiagramAnnotationBuilder Tooltip(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Type(AnnotationTypes)
Sets the type of the annotation
Shape - Sets the annotation type as Shape
Path - Sets the annotation type as Path
Declaration
public DiagramAnnotationBuilder Type(AnnotationTypes value)
Parameters
Returns
VerticalAlignment(VerticalAlignment)
Sets the vertical alignment of the text with respect to the parent node/connector
Stretch - Stretches the diagram element throughout its immediate parent
Top - Aligns the diagram element at the top of its immediate parent
Bottom - Aligns the diagram element at the bottom of its immediate parent
Center - Aligns the diagram element at the center of its immediate parent
Auto - Aligns the diagram element based on the characteristics of its immediate parent
Declaration
public DiagramAnnotationBuilder VerticalAlignment(VerticalAlignment value)
Parameters
Returns
Visibility(Boolean)
Defines the visibility of the label
Declaration
public DiagramAnnotationBuilder Visibility(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(Double)
Sets the width of the text
Declaration
public DiagramAnnotationBuilder Width(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
