Class DiagramConnectorAnnotationBuilder

Inheritance

System.Object

ControlBuilder

DiagramConnectorAnnotationBuilder

Inherited Members

ControlBuilder.Output

ControlBuilder.Context

Namespace: Syncfusion.EJ2.Diagrams

Assembly: Syncfusion.EJ2.dll

Syntax

public class DiagramConnectorAnnotationBuilder : ControlBuilder

Constructors

DiagramConnectorAnnotationBuilder()

Declaration

public DiagramConnectorAnnotationBuilder()

DiagramConnectorAnnotationBuilder(List<DiagramConnectorAnnotation>)

Declaration

public DiagramConnectorAnnotationBuilder(List<DiagramConnectorAnnotation> collection)

Parameters

Type	Name	Description
System.Collections.Generic.List<DiagramConnectorAnnotation>	collection

Methods

Add()

Declaration

public void Add()

AddInfo(Object)

Allows the user to save custom information/data about an annotation

Declaration

public DiagramConnectorAnnotationBuilder AddInfo(object addInfo)

Parameters

Type	Name	Description
System.Object	addInfo

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Alignment(AnnotationAlignment)

Sets the segment alignment of annotation Center - Aligns the annotation at the center of a connector segment Before - Aligns the annotation before a connector segment After - Aligns the annotation after a connector segment

Declaration

public DiagramConnectorAnnotationBuilder Alignment(AnnotationAlignment alignment)

Parameters

Type	Name	Description
AnnotationAlignment	alignment

Returns

Type	Description
DiagramConnectorAnnotationBuilder

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 DiagramConnectorAnnotationBuilder AnnotationType(AnnotationType annotationType)

Parameters

Type	Name	Description
AnnotationType	annotationType

Returns

Type	Description
DiagramConnectorAnnotationBuilder

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 DiagramConnectorAnnotationBuilder Constraints(AnnotationConstraints constraints)

Parameters

Type	Name	Description
AnnotationConstraints	constraints

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Content(String)

Sets the textual description of the node/connector

Declaration

public DiagramConnectorAnnotationBuilder Content(string content)

Parameters

Type	Name	Description
System.String	content

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Displacement(DiagramPoint)

Sets the displacement of an annotation from its actual position

Declaration

public DiagramConnectorAnnotationBuilder Displacement(DiagramPoint displacement)

Parameters

Type	Name	Description
DiagramPoint	displacement

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Displacement(Action<DiagramPointBuilder>)

Declaration

public DiagramConnectorAnnotationBuilder Displacement(Action<DiagramPointBuilder> displacement)

Parameters

Type	Name	Description
System.Action<DiagramPointBuilder>	displacement

Returns

Type	Description
DiagramConnectorAnnotationBuilder

DragLimit(DiagramMargin)

Sets the space to be left between an annotation and its parent node/connector

Declaration

public DiagramConnectorAnnotationBuilder DragLimit(DiagramMargin dragLimit)

Parameters

Type	Name	Description
DiagramMargin	dragLimit

Returns

Type	Description
DiagramConnectorAnnotationBuilder

DragLimit(Action<DiagramMarginBuilder>)

Declaration

public DiagramConnectorAnnotationBuilder DragLimit(Action<DiagramMarginBuilder> dragLimit)

Parameters

Type	Name	Description
System.Action<DiagramMarginBuilder>	dragLimit

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Height(Double)

Sets the height of the text

Declaration

public DiagramConnectorAnnotationBuilder Height(double height)

Parameters

Type	Name	Description
System.Double	height

Returns

Type	Description
DiagramConnectorAnnotationBuilder

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 DiagramConnectorAnnotationBuilder HorizontalAlignment(HorizontalAlignment horizontalAlignment)

Parameters

Type	Name	Description
HorizontalAlignment	horizontalAlignment

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Hyperlink(DiagramHyperlink)

Sets the hyperlink of the label

Declaration

public DiagramConnectorAnnotationBuilder Hyperlink(DiagramHyperlink hyperlink)

Parameters

Type	Name	Description
DiagramHyperlink	hyperlink

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Hyperlink(Action<DiagramHyperlinkBuilder>)

Declaration

public DiagramConnectorAnnotationBuilder Hyperlink(Action<DiagramHyperlinkBuilder> hyperlink)

Parameters

Type	Name	Description
System.Action<DiagramHyperlinkBuilder>	hyperlink

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Id(String)

Defines the unique id of the annotation

Declaration

public DiagramConnectorAnnotationBuilder Id(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Margin(DiagramMargin)

Sets the space to be left between an annotation and its parent node/connector

Declaration

public DiagramConnectorAnnotationBuilder Margin(DiagramMargin margin)

Parameters

Type	Name	Description
DiagramMargin	margin

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Margin(Action<DiagramMarginBuilder>)

Declaration

public DiagramConnectorAnnotationBuilder Margin(Action<DiagramMarginBuilder> margin)

Parameters

Type	Name	Description
System.Action<DiagramMarginBuilder>	margin

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Offset(Double)

Sets the segment offset of annotation

Declaration

public DiagramConnectorAnnotationBuilder Offset(double offset)

Parameters

Type	Name	Description
System.Double	offset

Returns

Type	Description
DiagramConnectorAnnotationBuilder

RotateAngle(Double)

Sets the rotate angle of the text

Declaration

public DiagramConnectorAnnotationBuilder RotateAngle(double rotateAngle)

Parameters

Type	Name	Description
System.Double	rotateAngle

Returns

Type	Description
DiagramConnectorAnnotationBuilder

SegmentAngle(Boolean)

Enable/Disable the angle based on the connector segment

Declaration

public DiagramConnectorAnnotationBuilder SegmentAngle(bool segmentAngle)

Parameters

Type	Name	Description
System.Boolean	segmentAngle

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Style(DiagramTextStyle)

Defines the appearance of the text

Declaration

public DiagramConnectorAnnotationBuilder Style(DiagramTextStyle style)

Parameters

Type	Name	Description
DiagramTextStyle	style

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Style(Action<DiagramTextStyleBuilder>)

Declaration

public DiagramConnectorAnnotationBuilder Style(Action<DiagramTextStyleBuilder> style)

Parameters

Type	Name	Description
System.Action<DiagramTextStyleBuilder>	style

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Template(Object)

Sets the textual description of the node/connector

Declaration

public DiagramConnectorAnnotationBuilder Template(object template)

Parameters

Type	Name	Description
System.Object	template

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Template(String)

Sets the textual description of the node/connector

Declaration

public DiagramConnectorAnnotationBuilder Template(string template)

Parameters

Type	Name	Description
System.String	template

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Type(AnnotationTypes)

Sets the type of the annotation Shape - Sets the annotation type as Shape Path - Sets the annotation type as Path

Declaration

public DiagramConnectorAnnotationBuilder Type(AnnotationTypes type)

Parameters

Type	Name	Description
AnnotationTypes	type

Returns

Type	Description
DiagramConnectorAnnotationBuilder

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 DiagramConnectorAnnotationBuilder VerticalAlignment(VerticalAlignment verticalAlignment)

Parameters

Type	Name	Description
VerticalAlignment	verticalAlignment

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Visibility(Boolean)

Defines the visibility of the label

Declaration

public DiagramConnectorAnnotationBuilder Visibility(bool visibility)

Parameters

Type	Name	Description
System.Boolean	visibility

Returns

Type	Description
DiagramConnectorAnnotationBuilder

Width(Double)

Sets the width of the text

Declaration

public DiagramConnectorAnnotationBuilder Width(double width)

Parameters

Type	Name	Description
System.Double	width

Returns

Type	Description
DiagramConnectorAnnotationBuilder