Show / Hide Table of Contents

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
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
List<string>

RequiresAuthentication

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

Scripts

Declaration
public List<WidgetResourceItem> Scripts { get; }
Property Value
Type Description
List<WidgetResourceItem>

Styles

Declaration
public List<WidgetResourceItem> Styles { get; }
Property Value
Type Description
List<WidgetResourceItem>

ViewComponentType

Declaration
public Type ViewComponentType { get; }
Property Value
Type Description
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
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
Type[] bundleContributorTypes
Returns
Type Description
WidgetDefinition

Extension Methods

AbpObjectExtensions.As<T>(object)
AbpObjectExtensions.To<T>(object)
LockExtensions.Locking(object, Action)
LockExtensions.Locking<TResult>(object, Func<TResult>)
AbpObjectExtensions.If<T>(T, bool, Action<T>)
AbpObjectExtensions.If<T>(T, bool, Func<T, T>)
AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)
AbpObjectExtensions.IsIn<T>(T, params T[])
AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)
AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)
AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)
AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)
AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)
AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)
LockExtensions.Locking<T>(T, Action<T>)
LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)
In this article
Back to top Powered by ABP.IO Platform