CitationBuilder

Properties

WriteAction - Func

Methods

Sources(System.Action)

An array of source objects displayed in the popover. Each source object can include url, title, and description properties.

Parameters

configurator - System.Action<CitationSourceFactory>

The configurator for the sources setting.

RETURNS

Returns the current instance of CitationBuilder .

Label(System.String)

The text label displayed on the chip. When null, the hostname of the first source URL is used automatically.

Parameters

value - System.String

The value for Label

RETURNS

Returns the current CitationBuilder instance.

SvgIcon(System.String)

The name of the SVG icon displayed on the chip.

Parameters

value - System.String

The value for SvgIcon

RETURNS

Returns the current CitationBuilder instance.

ShowAdditionalCount(System.Boolean)

When true and more than one source is present, a +N count is appended to the chip label showing the number of additional sources.

Parameters

value - System.Boolean

The value for ShowAdditionalCount

RETURNS

Returns the current CitationBuilder instance.

SourceIcon(System.String)

The name of the SVG icon used for source links inside the popover.

Parameters

value - System.String

The value for SourceIcon

RETURNS

Returns the current CitationBuilder instance.

SourceSVGIcon(System.String)

Overrides sourceIcon with a specific SVG icon name for source links inside the popover.

Parameters

value - System.String

The value for SourceSVGIcon

RETURNS

Returns the current CitationBuilder instance.

PopoverWidth(System.Double)

The width of the sources popover in pixels.

Parameters

value - System.Double

The value for PopoverWidth

RETURNS

Returns the current CitationBuilder instance.

BodyTemplateHandler(System.String)

A function used to render the entire popover body. Receives { sources: [] } as the first argument and must return an HTML string. When set, the built-in navigation buttons and source layout are not rendered.

Parameters

templateHandler - System.String

The handler that returs the template for BodyTemplate

RETURNS

Returns the current CitationBuilder instance.

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

A function used to render the entire popover body. Receives { sources: [] } as the first argument and must return an HTML string. When set, the built-in navigation buttons and source layout are not rendered.

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the bodytemplate.

RETURNS

Returns the current CitationBuilder instance.

Messages(System.Action)

Contains the localizable text strings used by the widget.

Parameters

configurator - System.Action<CitationMessagesSettingsBuilder>

The configurator for the messages setting.

RETURNS

Returns the current instance of CitationBuilder .

ShowOn(Kendo.Mvc.UI.CitationShowOn)

Determines when the popover is shown.

Parameters

value - CitationShowOn

The value for ShowOn

RETURNS

Returns the current CitationBuilder instance.

Events(System.Action)

Configures the client-side events.

Parameters

configurator - System.Action<CitationEventBuilder>

The client events action.

RETURNS

Returns the current CitationBuilder instance.

Example

Razor

 
            @(Html.Kendo().Citation()
                  .Name("Citation")
                  .Events(events => events
                      .Open("onOpen")
                  )
            )
             

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

The name.

RETURNS

Returns the current instance.

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

Sets the name of the component.

Parameters

modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer

The name.

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 Kendo.Mvc.UI.Fluent.WidgetFactory.DeferredScripts(System.Boolean,System.Boolean)

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.