Class DiagramNodeAnnotationBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
DiagramNodeAnnotationBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class DiagramNodeAnnotationBuilder : ControlBuilder
Constructors
DiagramNodeAnnotationBuilder()
Declaration
public DiagramNodeAnnotationBuilder()
DiagramNodeAnnotationBuilder(List<DiagramNodeAnnotation>)
Declaration
public DiagramNodeAnnotationBuilder(List<DiagramNodeAnnotation> collection)
Parameters
Methods
Add()
Declaration
AddInfo(Object)
Allows the user to save custom information/data about an annotation
Declaration
public DiagramNodeAnnotationBuilder AddInfo(object addInfo)
Parameters
| Type |
Name |
Description |
| System.Object |
addInfo |
|
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 DiagramNodeAnnotationBuilder AnnotationType(AnnotationType annotationType)
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 DiagramNodeAnnotationBuilder Constraints(AnnotationConstraints constraints)
Parameters
Returns
Content(String)
Sets the textual description of the node/connector
Declaration
public DiagramNodeAnnotationBuilder Content(string content)
Parameters
| Type |
Name |
Description |
| System.String |
content |
|
Returns
DragLimit(DiagramMargin)
Sets the space to be left between an annotation and its parent node/connector
Declaration
public DiagramNodeAnnotationBuilder DragLimit(DiagramMargin dragLimit)
Parameters
Returns
DragLimit(Action<DiagramMarginBuilder>)
Declaration
public DiagramNodeAnnotationBuilder DragLimit(Action<DiagramMarginBuilder> dragLimit)
Parameters
Returns
Height(Double)
Sets the height of the text
Declaration
public DiagramNodeAnnotationBuilder Height(double height)
Parameters
| Type |
Name |
Description |
| System.Double |
height |
|
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 DiagramNodeAnnotationBuilder HorizontalAlignment(HorizontalAlignment horizontalAlignment)
Parameters
Returns
Hyperlink(DiagramHyperlink)
Sets the hyperlink of the label
Declaration
public DiagramNodeAnnotationBuilder Hyperlink(DiagramHyperlink hyperlink)
Parameters
Returns
Hyperlink(Action<DiagramHyperlinkBuilder>)
Declaration
public DiagramNodeAnnotationBuilder Hyperlink(Action<DiagramHyperlinkBuilder> hyperlink)
Parameters
Returns
Id(String)
Defines the unique id of the annotation
Declaration
public DiagramNodeAnnotationBuilder Id(string id)
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
Returns
Margin(DiagramMargin)
Sets the space to be left between an annotation and its parent node/connector
Declaration
public DiagramNodeAnnotationBuilder Margin(DiagramMargin margin)
Parameters
Returns
Margin(Action<DiagramMarginBuilder>)
Declaration
public DiagramNodeAnnotationBuilder Margin(Action<DiagramMarginBuilder> margin)
Parameters
Returns
Offset(DiagramPoint)
Sets the position of the annotation with respect to its parent bounds
Declaration
public DiagramNodeAnnotationBuilder Offset(DiagramPoint offset)
Parameters
Returns
Offset(Action<DiagramPointBuilder>)
Declaration
public DiagramNodeAnnotationBuilder Offset(Action<DiagramPointBuilder> offset)
Parameters
Returns
RotateAngle(Double)
Sets the rotate angle of the text
Declaration
public DiagramNodeAnnotationBuilder RotateAngle(double rotateAngle)
Parameters
| Type |
Name |
Description |
| System.Double |
rotateAngle |
|
Returns
RotationReference(RotationReference)
Gets or sets the reference mode for annotation rotation.
Declaration
public DiagramNodeAnnotationBuilder RotationReference(RotationReference rotationReference)
Parameters
Returns
Style(DiagramTextStyle)
Defines the appearance of the text
Declaration
public DiagramNodeAnnotationBuilder Style(DiagramTextStyle style)
Parameters
Returns
Style(Action<DiagramTextStyleBuilder>)
Declaration
public DiagramNodeAnnotationBuilder Style(Action<DiagramTextStyleBuilder> style)
Parameters
Returns
Template(Object)
Sets the textual description of the node/connector
Declaration
public DiagramNodeAnnotationBuilder Template(object template)
Parameters
| Type |
Name |
Description |
| System.Object |
template |
|
Returns
Template(String)
Sets the textual description of the node/connector
Declaration
public DiagramNodeAnnotationBuilder Template(string template)
Parameters
| Type |
Name |
Description |
| System.String |
template |
|
Returns
This property is used to show tooltip for annotation on mouse over.
Declaration
public DiagramNodeAnnotationBuilder Tooltip(object tooltip)
Parameters
| Type |
Name |
Description |
| System.Object |
tooltip |
|
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 DiagramNodeAnnotationBuilder Type(AnnotationTypes type)
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 DiagramNodeAnnotationBuilder VerticalAlignment(VerticalAlignment verticalAlignment)
Parameters
Returns
Visibility(Boolean)
Defines the visibility of the label
Declaration
public DiagramNodeAnnotationBuilder Visibility(bool visibility)
Parameters
| Type |
Name |
Description |
| System.Boolean |
visibility |
|
Returns
Width(Double)
Sets the width of the text
Declaration
public DiagramNodeAnnotationBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
