Class WidgetDefinition

Inheritance
object
WidgetDefinition
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
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

AutoInitialize

Declaration
public bool AutoInitialize { get; set; }
Property Value
Type Description
bool

DisplayName

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

Name

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

RefreshUrl

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

RequiredPolicies

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

RequiresAuthentication

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

Scripts

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

Styles

Declaration
public List<WidgetResourceItem> Styles { get; }
Property Value
Type Description
System.Collections.Generic.List<T><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
string refreshUrl
Returns
Type Description
WidgetDefinition

WithRequiredPolicies(params string[])

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

WithRequiresAuthentication(bool)

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

WithScripts(params string[])

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

WithScripts(params Type[])

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

WithStyles(params string[])

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

WithStyles(params Type[])

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

Extension Methods