Class WidgetDefinition

Inheritance
System.Object
WidgetDefinition
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Volo.Abp.AspNetCore.Mvc.UI.Widgets
Assembly: Volo.Abp.AspNetCore.Mvc.UI.Widgets.dll
Syntax
public class WidgetDefinition

Constructors

WidgetDefinition(Type, ILocalizableString)

Declaration
public WidgetDefinition(Type viewComponentType, ILocalizableString displayName = null)
Parameters
Type Name Description
System.Type viewComponentType
ILocalizableString displayName

Properties

DisplayName

Display name of the widget.

Declaration
public ILocalizableString DisplayName { get; set; }
Property Value
Type Description
ILocalizableString

Name

Unique name of the widget.

Declaration
public string Name { get; }
Property Value
Type Description
System.String

RefreshUrl

Declaration
public string RefreshUrl { get; set; }
Property Value
Type Description
System.String

RequiredPolicies

Declaration
public List<string> RequiredPolicies { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

RequiresAuthentication

Set true to make this Widget available only for authenticated users. This property is not considered if RequiredPolicies is already set.

Declaration
public bool RequiresAuthentication { get; set; }
Property Value
Type Description
System.Boolean

Scripts

Declaration
public List<WidgetResourceItem> Scripts { get; }
Property Value
Type Description
System.Collections.Generic.List<WidgetResourceItem>

Styles

Declaration
public List<WidgetResourceItem> Styles { get; }
Property Value
Type Description
System.Collections.Generic.List<WidgetResourceItem>

ViewComponentType

Declaration
public Type ViewComponentType { get; }
Property Value
Type Description
System.Type

WidgetAttribute

Declaration
public WidgetAttribute WidgetAttribute { get; }
Property Value
Type Description
WidgetAttribute

Methods

WithRefreshUrl(String)

Declaration
public WidgetDefinition WithRefreshUrl(string refreshUrl)
Parameters
Type Name Description
System.String refreshUrl
Returns
Type Description
WidgetDefinition

WithRequiredPolicies(String[])

Declaration
public WidgetDefinition WithRequiredPolicies(params string[] policyNames)
Parameters
Type Name Description
System.String[] policyNames
Returns
Type Description
WidgetDefinition

WithRequiresAuthentication(Boolean)

Set true to make this Widget available only for authenticated users. This value is not considered if RequiredPolicies is already set.

Declaration
public WidgetDefinition WithRequiresAuthentication(bool value = true)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
WidgetDefinition

WithScripts(String[])

Declaration
public WidgetDefinition WithScripts(params string[] files)
Parameters
Type Name Description
System.String[] files
Returns
Type Description
WidgetDefinition

WithScripts(Type[])

Declaration
public WidgetDefinition WithScripts(params Type[] bundleContributorTypes)
Parameters
Type Name Description
System.Type[] bundleContributorTypes
Returns
Type Description
WidgetDefinition

WithStyles(String[])

Declaration
public WidgetDefinition WithStyles(params string[] files)
Parameters
Type Name Description
System.String[] files
Returns
Type Description
WidgetDefinition

WithStyles(Type[])

Declaration
public WidgetDefinition WithStyles(params Type[] bundleContributorTypes)
Parameters
Type Name Description
System.Type[] bundleContributorTypes
Returns
Type Description
WidgetDefinition

Extension Methods