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

PDFViewerToolbarSettingsItem

Class

Defines the fluent API for configuring the PDFViewerToolbarSettingsItem settings.

Definition

Namespace:Kendo.Mvc.UI

Assembly:Kendo.Mvc.dll

Syntax:

public class PDFViewerToolbarSettingsItem : JsonObject

Inheritance: objectJsonObjectPDFViewerToolbarSettingsItem

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

Constructors

PDFViewerToolbarSettingsItem(string)

Initialization for the PDFViewerToolbarSettingsItem

public PDFViewerToolbarSettingsItem(string toolName = null)

Parameters:toolNamestring

Properties

Click

ClientHandlerDescriptor

Specifies the click event handler of the button.

public ClientHandlerDescriptor Click { get; set; }

Command

string

Default commands in the PDF Viewer are: OpenCommand; PageChangeCommand; DownloadCommand; EnableSelectionCommand; EnablePanCommand or ExportCommand.

public string Command { get; set; }

Enable

bool?

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

public bool? Enable { get; set; }

Hidden

bool?

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

public bool? Hidden { get; set; }

HtmlAttributes

IDictionary<string, object>

Specifies the HTML attributes of a ToolBar button.

public IDictionary<string, object> HtmlAttributes { get; set; }

Icon

string

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

public string Icon { get; set; }

Id

string

Specifies the ID of the button.

public string Id { get; set; }

ImageUrl

string

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

public string ImageUrl { get; set; }

Name

string

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

public string Name { get; set; }

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 string Overflow { get; set; }

Primary

bool?

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

public bool? Primary { get; set; }

ShowIcon

string

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

public string ShowIcon { get; set; }

ShowText

string

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

public string ShowText { get; set; }

SpriteCssClass

string

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

public string SpriteCssClass { get; set; }

Template

string

Specifies what element will be added in the ToolBar wrapper. Items with template does not have a type.

public string Template { get; set; }

TemplateHandler

string

The handler for the Template

public string TemplateHandler { get; set; }

TemplateId

string

The id for the Template

public string TemplateId { get; set; }

Text

string

Sets the text of the button.

public string Text { get; set; }

Togglable

bool?

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

public bool? Togglable { get; set; }

Toggle

ClientHandlerDescriptor

Specifies the toggle event handler of the button. Applicable only for commands of type button and togglable: true.

public ClientHandlerDescriptor Toggle { get; set; }

Type

string

Specifies the type of toolbar item to be rendered. Supported types include button, separator, spacer, splitButton, buttonGroup, and template as defined by the ToolBar component.

public string Type { get; set; }

Methods

Serialize(IDictionary<string, object>)

Serialize current instance to Dictionary

protected override void Serialize(IDictionary<string, object> json)

Parameters:jsonIDictionary<string, object>

Overrides: JsonObject.Serialize(IDictionary<string, object>)