DiagramEditableSettingsBuilder

Methods

ShapeTemplateName(System.String)

Specifies the name of the shape editor template. You can use it to customize the editing UI of the shape or to display editor controls only for certain fields of the shape data item.

Parameters

value - System.String

The name of the Razor view editor template.

RETURNS

The current DiagramEditableSettingsBuilder instance.

Example

Razor
 
             @(Html.Kendo().Diagram<OrgChartShape, OrgChartConnection>()
                .Name("diagram")
                 .Editable(editable => editable.ShapeTemplateName("DiagramShapeEditor"))
             )
             

ShapeTemplateComponentName(System.String)

Specifies the name of the editor template that contains a Template component, which defines the editors for the shape data item. The editor template must be added in the 'Views/Shared/EditorTemplates/' folder.

Parameters

templateName - System.String

The name of the Razor view editor template.

RETURNS

The current DiagramEditableSettingsBuilder instance.

Example

Razor
 
             @(Html.Kendo().Diagram<OrgChartShape, OrgChartConnection>()
                .Name("diagram")
                 .Editable(editable => editable.ShapeTemplateComponentName("DiagramShapeEditor"))
             )
             

ConnectionTemplate(System.String)

Specifies the connection editor template which shows up when editing the connection. A template can be used to change the default editors for the connection fields or to prevent some fields from being edited by not rendering an editor input for them.

Parameters

value - System.String

The value for ConnectionTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ConnectionTemplateId(System.String)

Specifies the connection editor template which shows up when editing the connection. A template can be used to change the default editors for the connection fields or to prevent some fields from being edited by not rendering an editor input for them.

Parameters

templateId - System.String

The ID of the template element for ConnectionTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ConnectionTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

Specifies the connection editor template which shows up when editing the connection. A template can be used to change the default editors for the connection fields or to prevent some fields from being edited by not rendering an editor input for them.

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for ConnectionTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ConnectionTemplateHandler(System.String)

Specifies the connection editor template which shows up when editing the connection. A template can be used to change the default editors for the connection fields or to prevent some fields from being edited by not rendering an editor input for them.

Parameters

templateHandler - System.String

The handler that returs the template for ConnectionTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ConnectionTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Specifies the connection editor template which shows up when editing the connection. A template can be used to change the default editors for the connection fields or to prevent some fields from being edited by not rendering an editor input for them.

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the connectiontemplate.

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

Drag(System.Action)

Specifies if the shapes and connections can be dragged.

Parameters

configurator - System.Action<DiagramEditableDragSettingsBuilder>

The configurator for the drag setting.

RETURNS

Returns the current instance of DiagramEditableSettingsBuilder .

Drag(System.Boolean)

Specifies if the shapes and connections can be dragged.

Parameters

enabled - System.Boolean

Enables or disables the drag option.

RETURNS

Returns the current instance of DiagramEditableDragSettingsBuilder .

Remove(System.Boolean)

Specifies if the shapes and connections can be removed.

Parameters

value - System.Boolean

The value for Remove

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

Resize(System.Action)

Defines the look-and-feel of the shape resizing handles.

Parameters

configurator - System.Action<DiagramEditableResizeSettingsBuilder>

The configurator for the resize setting.

RETURNS

Returns the current instance of DiagramEditableSettingsBuilder .

Resize(System.Boolean)

Defines the look-and-feel of the shape resizing handles.

Parameters

enabled - System.Boolean

Enables or disables the resize option.

RETURNS

Returns the current instance of DiagramEditableResizeSettingsBuilder .

Rotate(System.Action)

Specifies whether the shapes can be rotated. Note that changing this setting after creating the diagram will have no effect.

Parameters

configurator - System.Action<DiagramEditableRotateSettingsBuilder>

The configurator for the rotate setting.

RETURNS

Returns the current instance of DiagramEditableSettingsBuilder .

Rotate(System.Boolean)

Specifies whether the shapes can be rotated. Note that changing this setting after creating the diagram will have no effect.

Parameters

enabled - System.Boolean

Enables or disables the rotate option.

RETURNS

Returns the current instance of DiagramEditableRotateSettingsBuilder .

ShapeTemplate(System.String)

Specifies the shape editor template. You can use it to customize the editing UI of the shape or to display editor controls only for certain fields of the shape data item.

Parameters

value - System.String

The value for ShapeTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ShapeTemplateId(System.String)

Specifies the shape editor template. You can use it to customize the editing UI of the shape or to display editor controls only for certain fields of the shape data item.

Parameters

templateId - System.String

The ID of the template element for ShapeTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ShapeTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

Specifies the shape editor template. You can use it to customize the editing UI of the shape or to display editor controls only for certain fields of the shape data item.

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for ShapeTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ShapeTemplateHandler(System.String)

Specifies the shape editor template. You can use it to customize the editing UI of the shape or to display editor controls only for certain fields of the shape data item.

Parameters

templateHandler - System.String

The handler that returs the template for ShapeTemplate

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

ShapeTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

Specifies the shape editor template. You can use it to customize the editing UI of the shape or to display editor controls only for certain fields of the shape data item.

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the shapetemplate.

RETURNS

Returns the current DiagramEditableSettingsBuilder instance.

Tools(System.Action)

Specifies the the toolbar tools. Supports all options supported by the toolbar.items property. Predefined tools are: "edit" - The selected item can be edited.; "createShape" - Adds an empty shape data item and a popup window is displayed.; "createConnection" - Adds an empty connection data item and a popup window is displayed.; "undo" - Undoes the previous action.; "redo" - Executes again the previously undone action.; "rotateClockwise" - The selected items can be rotated clockwise. The default rotation value is 90 degree. or "rotateAnticlockwise" - The selected items can be rotated anticlockwise. The default rotation value is 90 degree..

Parameters

configurator - System.Action<DiagramEditableSettingsToolFactory>

The configurator for the tools setting.

RETURNS

Returns the current instance of DiagramEditableSettingsBuilder .