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

PDFViewerToolbarSettingsItemBuilder

Class

Defines the fluent API for configuring the PDFViewerToolbarSettingsItem settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class PDFViewerToolbarSettingsItemBuilder

Inheritance: objectPDFViewerToolbarSettingsItemBuilder

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

Constructors

PDFViewerToolbarSettingsItemBuilder(PDFViewerToolbarSettingsItem)

Initialize the PDFViewerToolbarSettingsItemBuilder

public PDFViewerToolbarSettingsItemBuilder(PDFViewerToolbarSettingsItem settings)

Parameters:settingsPDFViewerToolbarSettingsItem

The PDFViewerToolbarSettingsItem

Methods

Click(Func<object, object>)

Specifies the click event handler of the tool button.

public PDFViewerToolbarSettingsItemBuilder Click(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the click action.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Command("PrintCommand").Type("button").Name("print").Click(@&lt;text&gt;
function(e) {
// Handle the Click event inline.
}
&lt;/text&gt;);
})
)
)

Click(string)

Specifies the click event handler of the tool button.

public PDFViewerToolbarSettingsItemBuilder Click(string handler)

Parameters:handlerstring

The value that configures the click action.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Command("PrintCommand").Type("button").Name("print").Click("onPrintClick");
})
)
)

Sets the command of the Toolbar tool. The default commands are: 'OpenCommand', 'PageChangeCommand', 'DownloadCommand', 'EnableSelectionCommand', 'EnablePanCommand', 'ExportCommand', 'PrintCommand', 'OpenSearchCommand', and 'ZoomCommand'.

public PDFViewerToolbarSettingsItemBuilder Command(string value)

Parameters:valuestring

The value that configures the command.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Command("PageChangeCommand").Type("pager").Name("pager");
})
)
)

Enable(bool)

Specifies whether the control is initially enabled or disabled. Default value is "true".

public PDFViewerToolbarSettingsItemBuilder Enable(bool value)

Parameters:valuebool

The value that configures the enable.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Type("button").Text("custom").Enable(false);
})
)
)

Hidden(bool)

Determines if a button is visible or hidden. By default buttons are visible.

public PDFViewerToolbarSettingsItemBuilder Hidden(bool value)

Parameters:valuebool

The value that configures the hidden.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Type("button").Text("custom").Hidden(true);
})
)
)

HtmlAttributes(IDictionary<string, object>)

public PDFViewerToolbarSettingsItemBuilder HtmlAttributes(IDictionary<string, object> value)

Parameters:valueIDictionary<string, object>Returns:

PDFViewerToolbarSettingsItemBuilder

HtmlAttributes(object)

Specifies the HTML attributes of the ToolBar button.

public PDFViewerToolbarSettingsItemBuilder HtmlAttributes(object value)

Parameters:valueobject

The value that configures the htmlattributes.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").HtmlAttributes(new { style = "color: green;" });
})
)
)

Icon(string)

Sets icon for the item. The icon should be one of the existing in the Kendo UI theme sprite.

public PDFViewerToolbarSettingsItemBuilder Icon(string value)

Parameters:valuestring

The value that configures the icon.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Type("button").Text("custom").Icon("user");
})
)
)

Id(string)

Specifies the ID of the button.

public PDFViewerToolbarSettingsItemBuilder Id(string value)

Parameters:valuestring

The value that configures the id.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Type("button").Text("custom").Id("custom-btn-1");
})
)
)

ImageUrl(string)

If set, the ToolBar will render an image with the specified URL in the button.

public PDFViewerToolbarSettingsItemBuilder ImageUrl(string value)

Parameters:valuestring

The value that configures the imageurl.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Type("button").Text("custom").ImageUrl(Url.Content("~/Content/shared/icons/16/star.png"));
})
)
)

Name(string)

Specifies the Toolbar tool's name. The tool definition will be taken from the default collection - 'kendo.pdfviewer.DefaultTools'.

public PDFViewerToolbarSettingsItemBuilder Name(string value)

Parameters:valuestring

The value that configures the name.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Type("pager").Name("pager");
})
)
)

Overflow(string)

Specifies the overflow behavior of the toolbar item. Accepts auto, never, or always to control when the item appears in the toolbar's overflow menu.

public PDFViewerToolbarSettingsItemBuilder Overflow(string value)

Parameters:valuestring

The value that configures the overflow.

Returns:

PDFViewerToolbarSettingsItemBuilder

Primary(bool)

Specifies whether the button is primary. Primary buttons receive different styling.

public PDFViewerToolbarSettingsItemBuilder Primary(bool value)

Parameters:valuebool

The value that configures the primary.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Primary(true);
})
)
)

ShowIcon(string)

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

public PDFViewerToolbarSettingsItemBuilder ShowIcon(string value)

Parameters:valuestring

The value that configures the showicon.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Type("button").Text("custom").ShowIcon("both");
})
)
)

ShowText(string)

Specifies where the text will be displayed. Possible values are: "toolbar", "overflow" or "both" (default).

public PDFViewerToolbarSettingsItemBuilder ShowText(string value)

Parameters:valuestring

The value that configures the showtext.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").ShowText("both");
})
)
)

SpriteCssClass(string)

Defines a CSS class (or multiple classes separated by spaces) which will be used for button icon.

public PDFViewerToolbarSettingsItemBuilder SpriteCssClass(string value)

Parameters:valuestring

The value that configures the spritecssclass.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Type("button").Text("custom").SpriteCssClass("customIconClass");
})
)
)

Template(string)

Specifies what element will be added in the ToolBar wrapper. Items with template do not have a Type().

public PDFViewerToolbarSettingsItemBuilder Template(string value)

Parameters:valuestring

The value that configures the template.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Template("My custom button");
})
)
)

Template<TModel>(TemplateBuilder<TModel>)

Specifies what element will be added in the ToolBar wrapper. Items with template do not have a Type().

public PDFViewerToolbarSettingsItemBuilder Template<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the template.

Returns:

PDFViewerToolbarSettingsItemBuilder

TemplateHandler(string)

Specifies what element will be added in the ToolBar wrapper. Items with template do not have a Type().

public PDFViewerToolbarSettingsItemBuilder TemplateHandler(string value)

Parameters:valuestring

The value that configures the template.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").TemplateHandler("customToolTemplate");
})
)
)

TemplateId(string)

Specifies what element will be added in the ToolBar wrapper. Items with template do not have a Type().

public PDFViewerToolbarSettingsItemBuilder TemplateId(string value)

Parameters:valuestring

The value that configures the template.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Template("customToolTemplate");
})
)
)

TemplateView(MvcHtmlString)

Specifies what element will be added in the ToolBar wrapper. Items with template do not have a Type().

public PDFViewerToolbarSettingsItemBuilder TemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the template.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").TemplateView(Html.Partial("_CustomToolTemplatePartial"));
})
)
)

Text(string)

Sets the text of the tool button.

public PDFViewerToolbarSettingsItemBuilder Text(string value)

Parameters:valuestring

The value that configures the text.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("custom").Text("Custom tool");
})
)
)

Togglable(bool)

Specifies if the tool button is togglable, e.g. has a selected and unselected state.

public PDFViewerToolbarSettingsItemBuilder Togglable(bool value)

Parameters:valuebool

The value that configures the togglable.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Command("PrintCommand").Type("button").Name("print").Togglable(true).Toggle("onPrintClick");
})
)
)

Toggle(Func<object, object>)

Specifies the toggle event handler of the tool button. Applicable only for commands of type "button" and Togglable(true).

public PDFViewerToolbarSettingsItemBuilder Toggle(Func<object, object> handler)

Parameters:handlerFunc<object, object>

The value that configures the toggle action.

Returns:

PDFViewerToolbarSettingsItemBuilder

Toggle(string)

Specifies the toggle event handler of the tool button. Applicable only for commands of type "button" and Togglable(true).

public PDFViewerToolbarSettingsItemBuilder Toggle(string handler)

Parameters:handlerstring

The value that configures the toggle action.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Command("PrintCommand").Type("button").Name("print").Togglable(true).Toggle("onPrintClick");
})
)
)

Type(string)

Specifies the type of the Toolbar tool.

public PDFViewerToolbarSettingsItemBuilder Type(string value)

Parameters:valuestring

The value that configures the type.

Returns:

PDFViewerToolbarSettingsItemBuilder

Example:

@(Html.Kendo().PDFViewer()
.Name("pdfviewer")
.Toolbar(toolbar =&gt;
toolbar.Items(items =&gt;
{
items.Add().Name("pager").Type("pager");
})
)
)