SignatureBuilder

Properties

WriteAction - Func

Methods

BackgroundColor(System.String)

Gets or sets the background color of the signature.

Parameters

value - System.String

The value for BackgroundColor

RETURNS

Returns the current SignatureBuilder instance.

Color(System.String)

The stroke color of the signature.

Parameters

value - System.String

The value for Color

RETURNS

Returns the current SignatureBuilder instance.

Enable(System.Boolean)

If set to false, the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.

Parameters

value - System.Boolean

The value for Enable

RETURNS

Returns the current SignatureBuilder instance.

Height(System.Double)

Determines the height of the signature in pixels.

Parameters

value - System.Double

The value for Height

RETURNS

Returns the current SignatureBuilder instance.

HideLine(System.Boolean)

A value indicating whether the dotted line should be displayed in the background.

Parameters

value - System.Boolean

The value for HideLine

RETURNS

Returns the current SignatureBuilder instance.

HideLine()

A value indicating whether the dotted line should be displayed in the background.

RETURNS

Returns the current SignatureBuilder instance.

Label(System.String)

Specifies the label that will be rendered on the k-signature-canvas element of the component with the aria-label attribute.

Parameters

value - System.String

The value for Label

RETURNS

Returns the current SignatureBuilder instance.

Maximizable(System.Boolean)

A value indicating whether the component can be maximized

Parameters

value - System.Boolean

The value for Maximizable

RETURNS

Returns the current SignatureBuilder instance.

PopupScale(System.Double)

Defines a value indicating the scaling size of the popup signature pad

Parameters

value - System.Double

The value for PopupScale

RETURNS

Returns the current SignatureBuilder instance.

Readonly(System.Boolean)

If set to true, the widget will be readonly and will not allow user input. The widget is not readonly by default and allows user input.

Parameters

value - System.Boolean

The value for Readonly

RETURNS

Returns the current SignatureBuilder instance.

Readonly()

If set to true, the widget will be readonly and will not allow user input. The widget is not readonly by default and allows user input.

RETURNS

Returns the current SignatureBuilder instance.

Smooth(System.Boolean)

A value indicating whether to smoothen out the signature lines.

Parameters

value - System.Boolean

The value for Smooth

RETURNS

Returns the current SignatureBuilder instance.

Smooth()

A value indicating whether to smoothen out the signature lines.

RETURNS

Returns the current SignatureBuilder instance.

StrokeWidth(System.Double)

Defines how wide will the stroke be.

Parameters

value - System.Double

The value for StrokeWidth

RETURNS

Returns the current SignatureBuilder instance.

Value(System.String)

A string value representing a Base64-encoded PNG image

Parameters

value - System.String

The value for Value

RETURNS

Returns the current SignatureBuilder instance.

Width(System.Double)

Determines the width of the signature in pixels.

Parameters

value - System.Double

The value for Width

RETURNS

Returns the current SignatureBuilder instance.

Size(Kendo.Mvc.UI.ComponentSize)

Sets a value controlling the size of the component.

Parameters

value - ComponentSize

The value for Size

RETURNS

Returns the current SignatureBuilder instance.

Rounded(Kendo.Mvc.UI.Rounded)

Sets a value controlling the border radius.

Parameters

value - Rounded

The value for Rounded

RETURNS

Returns the current SignatureBuilder instance.

FillMode(Kendo.Mvc.UI.FillMode)

Sets a value controlling how the color is applied.

Parameters

value - FillMode

The value for FillMode

RETURNS

Returns the current SignatureBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<SignatureEventBuilder>

The client events action.

RETURNS

Returns the current SignatureBuilder instance.

Example

Razor
 
            @(Html.Kendo().Signature()
                  .Name("Signature")
                  .Events(events => events
                      .Change("onChange")
                  )
            )
             

ToComponent()

Returns the internal view component.

RETURNS

The instance that represents the component.

Expression(System.String)

Sets the name of the component.

Parameters

modelExpression - System.String

RETURNS

Returns the current instance.

Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

RETURNS

Returns the current instance.

Name(System.String)

Sets the name of the component.

Parameters

componentName - System.String

The name.

RETURNS

Returns the current instance.

Deferred(System.Boolean)

Suppress initialization script rendering. Note that this options should be used in conjunction with

Parameters

deferred - System.Boolean

RETURNS

Returns a DeferredWidgetBuilder instance.

HtmlAttributes(System.Object)

Sets the HTML attributes.

Parameters

attributes - System.Object

The HTML attributes.

RETURNS

Returns the current instance.

HtmlAttributes(System.Collections.Generic.IDictionary)

Sets the HTML attributes.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The HTML attributes.

RETURNS

Returns the current instance.

ScriptAttributes(System.Object,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Object

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)

Sets the JavaScript attributes to the initialization script.

Parameters

attributes - System.Collections.Generic.IDictionary<String,Object>

The JavaScript attributes.

overrideAttributes - System.Boolean

Argument which determines whether attributes should be overriden.

RETURNS

Returns the current instance.

Render()

Renders the component in place.

ToHtmlString()

Returns the HTML representation of the component.

WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder)

Parameters

writer - System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder

ToClientTemplate()

Returns the client template for the component.

AsModule(System.Boolean)

Specifies whether the initialization script of the component will be rendered as a JavaScript module.

Parameters

value - System.Boolean

RETURNS

Returns the current instance.