Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / CitationBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

CitationBuilder

Class

Defines the fluent API for configuring the Kendo Citation for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class CitationBuilder : WidgetBuilderBase<Citation, CitationBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<Citation, CitationBuilder>CitationBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<Citation, CitationBuilder>.ToComponent()WidgetBuilderBase<Citation, CitationBuilder>.Name(string)WidgetBuilderBase<Citation, CitationBuilder>.Deferred(bool)WidgetBuilderBase<Citation, CitationBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<Citation, CitationBuilder>.HtmlAttributes(object)WidgetBuilderBase<Citation, CitationBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<Citation, CitationBuilder>.AsModule(bool)WidgetBuilderBase<Citation, CitationBuilder>.Render()WidgetBuilderBase<Citation, CitationBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<Citation, CitationBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<Citation, CitationBuilder>.ToHtmlString()WidgetBuilderBase<Citation, CitationBuilder>.ToClientTemplate()WidgetBuilderBase<Citation, CitationBuilder>.ToString()WidgetBuilderBase<Citation, CitationBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

CitationBuilder(Citation)

Initializes a new instance of the Citation class.

C#
public CitationBuilder(Citation component)
Parameters:componentCitation

The component.

Methods

BodyTemplate<TModel>(TemplateBuilder<TModel>)

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.

C#
public CitationBuilder BodyTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the bodytemplate.

Returns:

CitationBuilder

BodyTemplateHandler(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.

C#
public CitationBuilder BodyTemplateHandler(string value)
Parameters:valuestring

The value that configures the bodytemplate.

Returns:

CitationBuilder

Events(Action<CitationEventBuilder>)

Configures the client-side events.

C#
public CitationBuilder Events(Action<CitationEventBuilder> configurator)
Parameters:configuratorAction<CitationEventBuilder>

The client events action.

Returns:

CitationBuilder

Example:
C#
@(Html.Kendo().Citation()
.Name("Citation")
.Events(events =&gt; events
.Open("onOpen")
)
)

Label(string)

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

C#
public CitationBuilder Label(string value)
Parameters:valuestring

The value that configures the label.

Returns:

CitationBuilder

Messages(Action<CitationMessagesSettingsBuilder>)

Contains the localizable text strings used by the widget.

C#
public CitationBuilder Messages(Action<CitationMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<CitationMessagesSettingsBuilder>

The action that configures the messages.

Returns:

CitationBuilder

PopoverWidth(double)

The width of the sources popover in pixels.

C#
public CitationBuilder PopoverWidth(double value)
Parameters:valuedouble

The value that configures the popoverwidth.

Returns:

CitationBuilder

ShowAdditionalCount(bool)

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

C#
public CitationBuilder ShowAdditionalCount(bool value)
Parameters:valuebool

The value that configures the showadditionalcount.

Returns:

CitationBuilder

ShowOn(CitationShowOn)

Determines when the popover is shown.

C#
public CitationBuilder ShowOn(CitationShowOn value)
Parameters:valueCitationShowOn

The value that configures the showon.

Returns:

CitationBuilder

SourceIcon(string)

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

C#
public CitationBuilder SourceIcon(string value)
Parameters:valuestring

The value that configures the sourceicon.

Returns:

CitationBuilder

Sources(Action<CitationSourceFactory>)

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

C#
public CitationBuilder Sources(Action<CitationSourceFactory> configurator)
Parameters:configuratorAction<CitationSourceFactory>

The action that configures the sources.

Returns:

CitationBuilder

SourceSVGIcon(string)

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

C#
public CitationBuilder SourceSVGIcon(string value)
Parameters:valuestring

The value that configures the sourcesvgicon.

Returns:

CitationBuilder

SvgIcon(string)

The name of the SVG icon displayed on the chip.

C#
public CitationBuilder SvgIcon(string value)
Parameters:valuestring

The value that configures the svgicon.

Returns:

CitationBuilder

In this article
DefinitionConstructorsCitationBuilder(Citation)MethodsBodyTemplate<TModel>(TemplateBuilder<TModel>)BodyTemplateHandler(string)Events(Action<CitationEventBuilder>)Label(string)Messages(Action<CitationMessagesSettingsBuilder>)PopoverWidth(double)ShowAdditionalCount(bool)ShowOn(CitationShowOn)SourceIcon(string)Sources(Action<CitationSourceFactory>)SourceSVGIcon(string)SvgIcon(string)
Not finding the help you need?
Contact Support