Class DashboardWidgetHelper

Namespace

Dynamicweb.Dashboard.Widgets

Assembly

Dynamicweb.Core.dll

Contains helper methods to work with widgets

public static class DashboardWidgetHelper

Inheritance

object

DashboardWidgetHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Create(Type)

Creates the AddIn instance.

public static DashboardWidget? Create(Type widgetType)

Parameters

widgetType Type

Type of the AddIn.

Returns

DashboardWidget

GetAllWidgetsTypes()

Gets the all widgets AddIn's classes.

public static IEnumerable<Type> GetAllWidgetsTypes()

Returns

IEnumerable<Type>

GetDescription(Type)

Gets the AddIn description attribute.

public static string GetDescription(Type type)

Parameters

type Type

The widget type

Returns

string

GetIcon(Type, KnownIcon)

Gets the AddIn icon attribute.

public static KnownIcon GetIcon(Type type, KnownIcon defaultIcon)

Parameters

type Type

The widget type

defaultIcon KnownIcon

Default icon if icon attribute not specified

Returns

KnownIcon

GetName(DashboardWidget)

Gets widget friendly name.

public static string GetName(DashboardWidget widget)

Parameters

widget DashboardWidget

The widget

Returns

string

GetName(Type, string)

Gets widget type friendly name or default.

public static string GetName(Type type, string defaultName)

Parameters

type Type

The widget type

defaultName string

The default value

Returns

string

GetParametersCount(DashboardWidget)

Gets widget AddIn parameters count

public static int GetParametersCount(DashboardWidget widget)

Parameters

widget DashboardWidget

Returns

int

GetSystemName(Type)

Gets widget system name used as unique id

public static string GetSystemName(Type type)

Parameters

type Type

The widget type

Returns

string