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

WidgetBase

Class

Definition

Namespace:Kendo.Mvc.UI

Assembly:Kendo.Mvc.dll

Syntax:

public abstract class WidgetBase : IWidget, IHtmlAttributesContainer, IScriptableComponent

Inheritance: objectWidgetBase

Derived Classes: AIPromptActionSheetAppBarArcGaugeAvatarBadgeBarcodeBottomNavigationBreadcrumbButtonButtonGroupCalendarCaptchaChainOfThoughtChartBreadcrumbChartWizard<T>Chart<T>ChatCheckBoxCheckBoxGroupCheckpointChipChipListCircularGaugeCircularProgressBarCitationColorGradientColorPaletteColorPickerContextMenuDataSourceWidget<T>DateInputDatePickerBaseDateRangePickerDiagram<TShapeModel, TConnectionModel>DialogDockManagerDrawerDropDownButtonDropDownTreeEditorExpansionPanelFileManagerFilter<T>FlatColorPickerFloatingActionButtonForm<T>Gantt<TTaskModel, TDependenciesModel>GaugeGridLayoutGrid<T>ImageEditorInlineAIPromptListBaseListBoxListView<T>LoaderMapMaskedTextBoxMediaPlayerMenuMultiViewCalendarNotificationNumericTextBox<T>OTPInputOrgChart<T>PDFViewerPagerPanelBarPivotConfiguratorPivotConfiguratorButtonPivotConfiguratorV2PivotContainerPivotGridV2<TModel>PivotGrid<TModel>PopoverProgressBarPromptBoxPropertyGrid<T>QRCodeRadioButtonRadioGroupRangeSlider<T>RatingReasoningRecurrenceEditorResponsivePanelSankeyScheduler<TModel>ScrollViewSegmentedControlSignatureSkeletonContainerSlider<T>SmartPasteButtonSortableSpeechToTextButtonSplitButtonSplitterSpreadsheetStackLayoutStepperSwitchTabStripTaskBoard<TCard, TColumn>TextAreaTextBox<T>TileLayoutTimeDurationPickerTimeline<T>TimezoneEditorToggleButtonToolBarToolCallTooltipTreeList<T>TreeMapTreeViewUploadWindowWizard...

Implements: IHtmlAttributesContainerIScriptableComponentIWidget

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

Constructors

WidgetBase(ViewContext, IJavaScriptInitializer, ViewDataDictionary)

protected WidgetBase(ViewContext viewContext, IJavaScriptInitializer initializer, ViewDataDictionary viewData = null)

Parameters:viewContextViewContextinitializerIJavaScriptInitializerviewDataViewDataDictionary

WidgetBase(ViewContext, ViewDataDictionary)

Initializes a new instance of the WidgetBase class.

protected WidgetBase(ViewContext viewContext, ViewDataDictionary viewData = null)

Parameters:viewContextViewContext

The ViewContext object

viewDataViewDataDictionary

The ViewDataDictionary generator.

Properties

Events

IDictionary<string, object>

Gets the client events of the grid.

public IDictionary<string, object> Events { get; }

Property Value:

The client events.

HasClientComponent

bool

public bool HasClientComponent { get; set; }

HasDeferredInitialization

bool

public bool HasDeferredInitialization { get; set; }

HtmlAttributes

IDictionary<string, object>

Gets the HTML attributes.

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

Property Value:

The HTML attributes.

Implements: IHtmlAttributesContainer.HtmlAttributes

Id

string

Gets the id.

public virtual string Id { get; }

Property Value:

The id.

Implements: IWidget.Id

Initializer

IJavaScriptInitializer

public IJavaScriptInitializer Initializer { get; set; }

IsInClientTemplate

bool

public bool IsInClientTemplate { get; }

Implements: IScriptableComponent.IsInClientTemplate

IsSelfInitialized

bool

public bool IsSelfInitialized { get; set; }

Implements: IScriptableComponent.IsSelfInitialized

ModelMetadata

public ModelMetadata ModelMetadata { get; set; }

Implements: IWidget.ModelMetadata

Name

string

Gets or sets the name.

public string Name { get; set; }

Property Value:

The name.

Implements: IWidget.Name

ScriptAttributes

IDictionary<string, object>

Sets the JavaScript attributes to the initialization script.

public IDictionary<string, object> ScriptAttributes { get; }

Selector

string

public string Selector { get; }

Implements: IScriptableComponent.Selector

ShouldSanitezeId

bool

public bool ShouldSanitezeId { get; set; }

ViewContext

Gets or sets the view context to rendering a view.

public ViewContext ViewContext { get; }

Property Value:

The view context.

Implements: IWidget.ViewContext

ViewData

ViewDataDictionary

public ViewDataDictionary ViewData { get; }

Implements: IWidget.ViewData

Methods

DeferStyles()

public virtual void DeferStyles()

GetHtml(bool)

public string GetHtml(bool includeScript = true)

Parameters:includeScriptboolReturns:

string

GetInitializator()

public string GetInitializator()

Returns:

string

Render()

Renders the component.

public void Render()

Serialize()

public virtual IDictionary<string, object> Serialize()

Returns:

IDictionary<string, object>

SerializeSettings()

protected virtual Dictionary<string, object> SerializeSettings()

Returns:

Dictionary<string, object>

ToClientTemplate()

public MvcHtmlString ToClientTemplate()

Returns:

MvcHtmlString

ToHtmlString()

public string ToHtmlString()

Returns:

string

VerifySettings()

public virtual void VerifySettings()

WriteDeferredStyles(TextWriter)

Writes the deferred styes.

public virtual void WriteDeferredStyles(TextWriter writer)

Parameters:writerTextWriter

The writer.

WriteHtml(HtmlTextWriter)

Writes the HTML.

protected virtual void WriteHtml(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

WriteInitializationScript(TextWriter)

Writes the initialization script.

public virtual void WriteInitializationScript(TextWriter writer)

Parameters:writerTextWriter

The writer.

Implements: IScriptableComponent.WriteInitializationScript(TextWriter)

WriteLicensingScript(TextWriter)

protected virtual void WriteLicensingScript(TextWriter writer)

Parameters:writerTextWriter

WriteTrialMessage(HtmlTextWriter)

protected virtual void WriteTrialMessage(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter