New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Class

Defines the fluent API for configuring the DiagramConnectionContentSettings settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TShapeModel

TConnectionModel

Syntax:

public class DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> where TShapeModel : class where TConnectionModel : class

Inheritance: objectDiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

DiagramConnectionContentSettingsBuilder(DiagramConnectionContentSettings)

public DiagramConnectionContentSettingsBuilder(DiagramConnectionContentSettings settings)

Parameters:settingsDiagramConnectionContentSettings

Methods

Background(string)

The background color of the connection label. Accepts valid CSS colors.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Background(string value)

Parameters:valuestring

The value that configures the background.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Border(Action<DiagramConnectionContentBorderSettingsBuilder<TShapeModel, TConnectionModel>>)

The border options of the connection label. Applicable when background is set.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Border(Action<DiagramConnectionContentBorderSettingsBuilder<TShapeModel, TConnectionModel>> configurator)

Parameters:configuratorAction<DiagramConnectionContentBorderSettingsBuilder<TShapeModel, TConnectionModel>>

The action that configures the border.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Color(string)

Defines the color of the connection content text.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Color(string value)

Parameters:valuestring

The value that configures the color.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.Color("blue"));
})
)

FontFamily(string)

Defines the font family of the connection content text.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> FontFamily(string value)

Parameters:valuestring

The value that configures the font family.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.FontFamily("Tahoma"));
})
)

FontSize(double)

Defines the font size of the connection content text.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> FontSize(double value)

Parameters:valuedouble

The value that configures the font size.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.FontSize(18));
})
)

FontStyle(string)

Defines the font style of the connection content text.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> FontStyle(string value)

Parameters:valuestring

The value that configures the font style.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.FontStyle("italic"));
})
)

FontWeight(string)

Defines the font weight of the connection content text.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> FontWeight(string value)

Parameters:valuestring

The value that configures the font weight.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.FontWeight("600"));
})
)

Offset(double)

Defines the distance (in pixels) between the label and the connection path.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Offset(double value)

Parameters:valuedouble

The value that configures the offset.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Padding(Action<DiagramConnectionContentPaddingSettingsBuilder<TShapeModel, TConnectionModel>>)

The padding options of the connection label. Applicable when background or border is set.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Padding(Action<DiagramConnectionContentPaddingSettingsBuilder<TShapeModel, TConnectionModel>> configurator)

Parameters:configuratorAction<DiagramConnectionContentPaddingSettingsBuilder<TShapeModel, TConnectionModel>>

The action that configures the padding.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Position(Action<DiagramConnectionContentPositionSettingsBuilder<TShapeModel, TConnectionModel>>)

Defines the position of the label relative to the connection path. Can be set to "inline" to position the label along the connection path, or an object with vertical and horizontal properties.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Position(Action<DiagramConnectionContentPositionSettingsBuilder<TShapeModel, TConnectionModel>> configurator)

Parameters:configuratorAction<DiagramConnectionContentPositionSettingsBuilder<TShapeModel, TConnectionModel>>

The action that configures the position.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Template(string)

The template that renders the connection labels.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Template(string value)

Parameters:valuestring

The value that configures the template content.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.Template("Iteration on #:kendo.toString(new Date(), 'MM/dd/yyyy')#"));
})
)

Template<TModel>(TemplateBuilder<TModel>)

The template that renders the connection labels.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Template<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

TemplateHandler(string)

The template that renders the connection labels.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> TemplateHandler(string value)

Parameters:valuestring

The value that configures the template content.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.TemplateHandler("getLabelTemplate"));
})
)
&lt;script&gt;
function getLabelTemplate() {
return `Iteration on ${kendo.toString(new Date(), 'MM/dd/yyyy')}`;
}
&lt;/script&gt;

TemplateId(string)

The template that renders the connection labels.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> TemplateId(string value)

Parameters:valuestring

The value that configures the template content.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.TemplateId("connectionLabel"));
})
)
&lt;script id="connectionLabel" type="text/x-kendo-template"&gt;
Iteration on #:kendo.toString(new Date(), 'MM/dd/yyyy')#
&lt;/script&gt;

TemplateView(MvcHtmlString)

The template that renders the connection labels.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> TemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the template content.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.TemplateView(Html.Partial("ConnectionLabelTemplateView")));
})
)

Text(string)

Sets the label text displayed for the connection.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Text(string value)

Parameters:valuestring

The value that configures the text content.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.Text("Step 1"));
})
)

Visual(Func<object, object>)

Defines a JavaScript function that returns a visual element to render the content of the connection.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Visual(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the visual action.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.Visual(@&lt;text&gt;
function(e) {
// Return a custom visual element.
}
&lt;/text&gt;));
})
)

Visual(string)

Defines a JavaScript function that returns a visual element to render the content of the connection.

public DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel> Visual(string handler)

Parameters:handlerstring

The value that configures the visual action.

Returns:

DiagramConnectionContentSettingsBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Connections(connection =&gt;
{
connection.Add().Content(c =&gt; c.Visual("getConnectionContent"));
})
)