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

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Class

Defines the fluent API for configuring the DiagramShapeEditableSettingsTool settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TShapeModel

TConnectionModel

Syntax:

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

Inheritance: objectDiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

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

Constructors

DiagramShapeEditableSettingsToolBuilder(DiagramShapeEditableSettingsTool)

public DiagramShapeEditableSettingsToolBuilder(DiagramShapeEditableSettingsTool settings)

Parameters:settingsDiagramShapeEditableSettingsTool

Methods

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

Specifies the buttons of ButtonGroup in the default shapes Toolbar.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Buttons(Action<DiagramShapeEditableSettingsToolButtonFactory<TShapeModel, TConnectionModel>> configurator)

Parameters:configuratorAction<DiagramShapeEditableSettingsToolButtonFactory<TShapeModel, TConnectionModel>>

The action that configures the buttons.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Click(Func<object, object>)

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

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Click(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the click action.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Click(string)

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

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Click(string handler)

Parameters:handlerstring

The value that configures the click action.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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".

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Enable(bool value)

Parameters:valuebool

The value that enables or disables the button.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("customBtn").Type("button").Enable(false).Text("Custom Button")))
)
)

Group(string)

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

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Group(string value)

Parameters:valuestring

The value that configures the group of the button.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

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

HtmlAttributes(IDictionary<string, object>)

Specifies the HTML attributes of the toolbar tool.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> HtmlAttributes(IDictionary<string, object> value)

Parameters:valueIDictionary<string, object>

The value that configures the HTML attributes.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("customUpdateBtn").HtmlAttributes(new Dictionary&lt;string, object&gt;() { ["class"] = "custom-btn" })))
)
)

HtmlAttributes(object)

Specifies the HTML attributes of the toolbar tool.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> HtmlAttributes(object value)

Parameters:valueobject

The value that configures the HTML attributes.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("customUpdateBtn").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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Icon(string value)

Parameters:valuestring

The value that configures the icon for the toolbar button.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("infoBtn").Type("button").Icon("info-circle")))
)
)

Id(string)

Specifies the ID of the toolbar button.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Id(string value)

Parameters:valuestring

The value that configures the id of the button.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> ImageUrl(string value)

Parameters:valuestring

The value that configures the image URL.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").ImageUrl("/diagram/settings.png")))
)
)

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

Specifies the menu buttons of SplitButton or DropDownButton in the default Toolbar of the shapes.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> MenuButtons(Action<DiagramShapeEditableSettingsToolMenuButtonFactory<TShapeModel, TConnectionModel>> configurator)

Parameters:configuratorAction<DiagramShapeEditableSettingsToolMenuButtonFactory<TShapeModel, TConnectionModel>>

The action that configures the menubuttons.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Name(string)

Defines the name of the tool. The built-in tool names are "edit", "delete", "rotateClockwise" and "rotateAnticlockwise".

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Name(string value)

Parameters:valuestring

The value that configures the name.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("customUpdate")))
)
)

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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Overflow(string value)

Parameters:valuestring

The value that configures the overflow option.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("Settings").Type("button").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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplate(string value)

Parameters:valuestring

The value that configures the overflow template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the overflowtemplate.

Returns:

DiagramShapeEditableSettingsToolBuilder<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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplateHandler(string value)

Parameters:valuestring

The value that configures the overflow template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplateId(string value)

Parameters:valuestring

The value that configures the overflow template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> OverflowTemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the overflow template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Primary(bool value)

Parameters:valuebool

The value that configures the primary.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("Settings").Type("button").Primary(true)))
)
)

Selected(bool)

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

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Selected(bool value)

Parameters:valuebool

The value that configures the selected option.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("Settings").Type("button").Togglable(true).Selected(true)))
)
)

ShowIcon(string)

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

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> ShowIcon(string value)

Parameters:valuestring

The value that configures the visibility of the button icon.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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).

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> ShowText(string value)

Parameters:valuestring

The value that configures the visibility of the button text.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> SpriteCssClass(string value)

Parameters:valuestring

The value that configures the CSS class.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Type("button").Text("Settings").Icon("check").SpriteCssClass("tick-icon")))
)
)

Step(double)

Defines the step of the "rotateClockwise" and "rotateAnticlockwise" tools. The option determines the angle at which a selected shape will be rotated when one of the tools is clicked.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Step(double value)

Parameters:valuedouble

The value that configures the step.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.RotateClockwise().Step(45)))
)
)

Template(string)

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

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

Parameters:valuestring

The value that configures the item template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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. The items with template do not have a type.

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

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

TemplateHandler(string)

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

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

Parameters:valuestring

The value that configures the item template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").TemplateHandler("getItemTemplate")))
)
)

TemplateId(string)

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

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

Parameters:valuestring

The value that configures the item template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.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.

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

Parameters:valueMvcHtmlString

The value that configures the item template.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").TemplateView(Html.Partial("ItemTemplateView"))))
)
)

Text(string)

Sets the text of the toolbar button.

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

Parameters:valuestring

The value that configures the text.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("User settings")))
)
)

Togglable(bool)

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

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Togglable(bool value)

Parameters:valuebool

The value that enables or disables the togglable option.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("User settings").Type("button").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).

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Toggle(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the toggle action.

Returns:

DiagramShapeEditableSettingsToolBuilder<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).

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Toggle(string handler)

Parameters:handlerstring

The value that configures the toggle action.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("User settings").Type("button").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".

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Type(string value)

Parameters:valuestring

The value that configures the command type.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("User settings").Type("button")))
)
)

Url(string)

Specifies the URL of the toolbar command to navigate to.

public DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel> Url(string value)

Parameters:valuestring

The value that configures the URL.

Returns:

DiagramShapeEditableSettingsToolBuilder<TShapeModel, TConnectionModel>

Example:

@(Html.Kendo().Diagram()
.Name("diagram")
.Shapes(shape =&gt; shape
.Add().Editable(e =&gt; e.Tools(tt =&gt; tt.Custom().Name("settingsBtn").Text("User settings").Type("button").Url("URL value")))
)
)