Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Class

Defines the fluent API for configuring the DiagramEditableSettingsTool settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TShapeModel

TConnectionModel

Syntax:
C#
public class DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> where TShapeModel : class where TConnectionModel : class

Inheritance: objectDiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

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

Constructors

DiagramEditableSettingsToolBuilder(DiagramEditableSettingsTool)

C#
public DiagramEditableSettingsToolBuilder(DiagramEditableSettingsTool settings)
Parameters:settingsDiagramEditableSettingsTool

Methods

Buttons(Action<DiagramEditableSettingsToolButtonFactory<TShapeModel, TConnectionModel>>)

Specifies the buttons of ButtonGroup.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Buttons(Action<DiagramEditableSettingsToolButtonFactory<TShapeModel, TConnectionModel>> configurator)
Parameters:configuratorAction<DiagramEditableSettingsToolButtonFactory<TShapeModel, TConnectionModel>>

The action that configures the buttons.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Click(Func<object, object>)

Specifies the "click" event handler of the toolbar button. The option is applicable only for tools of type button and splitButton

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Click(Func<object, object> handler)
Parameters:handlerFunc<object, object>

The value that configures the click action.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Click(string)

Specifies the "click" event handler of the toolbar button. The option is applicable only for tools of type button and splitButton

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Click(string handler)
Parameters:handlerstring

The value that configures the click action.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("customUpdateBtn").Type("button").Text("Update").Click("onUpdateClick")))
)

Enable(bool)

Specifies whether the toolbar button is initially enabled or disabled. The default value is "true".

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Enable(bool value)
Parameters:valuebool

The value that enables or disables the button.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("customBtn").Type("button").Text("Custom Button").Enable(false)))
)

Group(string)

Assigns a group to the toolbar button. The option is applicable only for buttons with option Togglable(true).

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Group(string value)
Parameters:valuestring

The value that configures the group of the button.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(e =&gt; e.Tools(tt =&gt;
{
tt.Custom().Type("button").Name("btn1").Text("Button 1").Togglable(true).Group("group1");
tt.Custom().Type("button").Name("btn2").Text("Button 2").Togglable(true).Group("group1");
tt.Custom().Type("button").Name("btn2").Text("Button 3").Togglable(true).Group("group1");
})
)
)

HtmlAttributes(IDictionary<string, object>)

Specifies the HTML attributes of the toolbar tool.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> HtmlAttributes(IDictionary<string, object> value)
Parameters:valueIDictionary<string, object>

The value that configures the HTML attributes.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("customTool").HtmlAttributes(new Dictionary&lt;string, object&gt;() { ["class"] = "custom-btn" })))
)

HtmlAttributes(object)

Specifies the HTML attributes of the toolbar tool.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> HtmlAttributes(object value)
Parameters:valueobject

The value that configures the HTML attributes.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("customTool").HtmlAttributes(new { @class = "custom-btn"})))
)

Icon(string)

Sets an icon for the toolbar button. The icon must be one of the existing in the Kendo UI theme sprite.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Icon(string value)
Parameters:valuestring

The value that configures the icon for the toolbar button.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("infoBtn").Type("button").Icon("info-circle")))
)

Id(string)

Specifies the ID of the toolbar button.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Id(string value)
Parameters:valuestring

The value that configures the id.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("infoBtn").Type("button").Id("infoButton")))
)

ImageUrl(string)

Sets an image with a specified URL to be rendered in the toolbar button.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> ImageUrl(string value)
Parameters:valuestring

The value that configures the image URL.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").ImageUrl("/diagram/settings.png")))
)

MenuButtons(Action<DiagramEditableSettingsToolMenuButtonFactory<TShapeModel, TConnectionModel>>)

Specifies the menu buttons of SplitButton or DropDownButton in the Toolbar of the connection.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> MenuButtons(Action<DiagramEditableSettingsToolMenuButtonFactory<TShapeModel, TConnectionModel>> configurator)
Parameters:configuratorAction<DiagramEditableSettingsToolMenuButtonFactory<TShapeModel, TConnectionModel>>

The action that configures the menubuttons.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Name(string)

Defines the name of the tool. The built-in tools are "edit", "createShape", "createConnection", "undo", "redo", "rotateClockwise" and "rotateAnticlockwise".

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Name(string value)
Parameters:valuestring

The value that configures the tool name.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("customTool")))
)

Overflow(string)

Specifies how the button behaves when the toolbar is resized. The supported values are: "always", "never" or "auto" (default). If a toolbar item contains a template and the Overflow is set to "always", the template will never be rendered. If the item contains an OverflowTemplate() and the Overflow is set to "never", the specified overflow template will never be rendered.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Overflow(string value)
Parameters:valuestring

The value that configures the overflow.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("Settings").Overflow("always")))
)

OverflowTemplate(string)

Specifies what element will be added in the command overflow popup. The option is applicable only for toolbar items that have a template.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplate(string value)
Parameters:valuestring

The value that configures the overflow template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom()
.Name("settingsBtn")
.Template("&lt;div class='settings'&gt;Settings&lt;/div&gt;")
.OverflowTemplate("&lt;div class='overflow-settings'&gt;Settings&lt;/div&gt;")
))
)

OverflowTemplate<TModel>(TemplateBuilder<TModel>)

Specifies what element will be added in the command overflow popup. The option is applicable only for toolbar items that have a template.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the overflowtemplate.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

OverflowTemplateHandler(string)

Specifies what element will be added in the command overflow popup. The option is applicable only for toolbar items that have a template.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplateHandler(string value)
Parameters:valuestring

The value that configures the overflow template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom()
.Name("settingsBtn")
.Template("&lt;div class='settings'&gt;Settings&lt;/div&gt;")
.OverflowTemplateHandler("getOverflowTemplate")
))
)

OverflowTemplateId(string)

Specifies what element will be added in the command overflow popup. The option is applicable only for toolbar items that have a template.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplateId(string value)
Parameters:valuestring

The value that configures the overflow template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom()
.Name("settingsBtn")
.Template("&lt;div class='settings'&gt;Settings&lt;/div&gt;")
.OverflowTemplateId("overflowTemplate")
))
)
&lt;script id="overflowTemplate" type="text/x-kendo-template"&gt;
&lt;div class='overflow-settings'&gt;Settings&lt;/div&gt;
&lt;/script&gt;

OverflowTemplateView(MvcHtmlString)

Specifies what element will be added in the command overflow popup. The option is applicable only for toolbar items that have a template.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the overflow template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom()
.Name("settingsBtn")
.Template("&lt;div class='settings'&gt;Settings&lt;/div&gt;")
.OverflowTemplateView(Html.Partial("OverflowTemplateView"))
))
)

Primary(bool)

Specifies whether the toolbar button is primary. The primary buttons have different styling.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Primary(bool value)
Parameters:valuebool

The value that configures the primary.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("Settings").Primary(true)))
)

Selected(bool)

Specifies if the toolbar toggle button must be initially selected. The option is applicable only for buttons with Togglable(true).

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Selected(bool value)
Parameters:valuebool

The value that configures the selected option.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("Settings").Togglable(true).Selected(true)))
)

ShowIcon(string)

Specifies where the toolbar button icon will be displayed. The supported values are: "toolbar", "overflow", and "both" (default).

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> ShowIcon(string value)
Parameters:valuestring

The value that configures the visibility of the button icon.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("infoBtn").Type("button").Icon("info-circle").ShowIcon("toolbar")))
)

ShowText(string)

Specifies where the toolbar button's text will be displayed. The supported values are: "toolbar", "overflow", and "both" (default).

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> ShowText(string value)
Parameters:valuestring

The value that configures the visibility of the button text.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("Settings").ShowText("overflow")))
)

SpriteCssClass(string)

Defines a CSS class (or multiple classes separated by spaces) that will be used for the button's icon.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> SpriteCssClass(string value)
Parameters:valuestring

The value that configures the CSS class.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("Settings").Icon("check").SpriteCssClass("tick-icon")))
)

Step(double)

The step of the RotateClockwise and RotateAnticlockwise tools.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Step(double value)
Parameters:valuedouble

The value that configures the step.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tool =&gt;
{
tool.RotateClockwise().Step(2);
tool.RotateAnticlockwise().Step(2);
}))
)

Template(string)

Specifies what element will be added in the ToolBar wrapper. The items with template do not have a type.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Template(string value)
Parameters:valuestring

The value that configures the template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Template("&lt;button style='color: red;'&gt;Settings&lt;/button&gt;")))
)

Template<TModel>(TemplateBuilder<TModel>)

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Template<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

TemplateHandler(string)

Specifies what element will be added in the ToolBar wrapper. The items with template do not have a type.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> TemplateHandler(string value)
Parameters:valuestring

The value that configures the template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

TemplateId(string)

Specifies what element will be added in the ToolBar wrapper. The items with template do not have a type.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> TemplateId(string value)
Parameters:valuestring

The value that configures the template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").TemplateId("settingsTemplate")))
)
&lt;script id="settingsTemplate" type="text/x-kendo-template"&gt;
&lt;button style='color: red;'&gt;Settings&lt;/button&gt;
&lt;/script&gt;

TemplateView(MvcHtmlString)

Specifies what element will be added in the ToolBar wrapper. The items with template do not have a type.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> TemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").TemplateView(Html.Partial("ItemTemplateView"))))
)

Text(string)

Sets the text of the button.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Text(string value)
Parameters:valuestring

The value that configures the text.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("User settings")))
)

Togglable(bool)

Specifies whether the toolbar button must be togglable. For example, the button has a selected and unselected state.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Togglable(bool value)
Parameters:valuebool

The value that enables or disables the togglable option.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("User settings").Togglable(true)))
)

Toggle(Func<object, object>)

Specifies the Toggle event handler of the toolbar button. The option is applicable only for commands with options Type("button") and Togglable(true).

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Toggle(Func<object, object> handler)
Parameters:handlerFunc<object, object>

The value that configures the toggle action.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Toggle(string)

Specifies the Toggle event handler of the toolbar button. The option is applicable only for commands with options Type("button") and Togglable(true).

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Toggle(string handler)
Parameters:handlerstring

The value that configures the toggle action.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("User settings").Togglable(true).Toggle("onButtonToggle")))
)
&lt;script&gt;
function onButtonToggle() {
console.log("toggle toolbar button");
}
&lt;/script&gt;

Type(string)

Specifies the type of the toolbar command. The supported types are: "button", "splitButton", "dropDownButton", "buttonGroup", "separator", "spacer".

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Type(string value)
Parameters:valuestring

The value that configures the type.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("User settings")))
)

Url(string)

Specifies the URL of the toolbar command to navigate to.

C#
public DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Url(string value)
Parameters:valuestring

The value that configures the URL.

Returns:

DiagramEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:
C#
@(Html.Kendo().Diagram()
.Name("diagram")
.Editable(editable =&gt; editable.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("User settings").Url("URL value")))
)
In this article
DefinitionConstructorsDiagramEditableSettingsToolBuilder(DiagramEditableSettingsTool)MethodsButtons(Action<DiagramEditableSettingsToolButtonFactory<TShapeModel, TConnectionModel>>)Click(Func<object, object>)Click(string)Enable(bool)Group(string)HtmlAttributes(IDictionary<string, object>)HtmlAttributes(object)Icon(string)Id(string)ImageUrl(string)MenuButtons(Action<DiagramEditableSettingsToolMenuButtonFactory<TShapeModel, TConnectionModel>>)Name(string)Overflow(string)OverflowTemplate(string)OverflowTemplate<TModel>(TemplateBuilder<TModel>)OverflowTemplateHandler(string)OverflowTemplateId(string)OverflowTemplateView(MvcHtmlString)Primary(bool)Selected(bool)ShowIcon(string)ShowText(string)SpriteCssClass(string)Step(double)Template(string)Template<TModel>(TemplateBuilder<TModel>)TemplateHandler(string)TemplateId(string)TemplateView(MvcHtmlString)Text(string)Togglable(bool)Toggle(Func<object, object>)Toggle(string)Type(string)Url(string)
Not finding the help you need?
Contact Support