Class SkeletonBuilder

Inheritance
System.Object
ControlBuilder
SkeletonBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.Notifications
Assembly: Syncfusion.EJ2.dll
Syntax
public class SkeletonBuilder : ControlBuilder

Constructors

SkeletonBuilder()

Declaration
public SkeletonBuilder()

SkeletonBuilder(Skeleton)

Declaration
public SkeletonBuilder(Skeleton model)
Parameters
Type Name Description
Skeleton model

Fields

model

Declaration
public Skeleton model
Field Value
Type Description
Skeleton

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

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

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

CssClass(String)

Defines single/multiple classes (separated by space) to be used for customization of Skeleton.

Declaration
public SkeletonBuilder CssClass(string cssClass)
Parameters
Type Name Description
System.String cssClass
Returns
Type Description
SkeletonBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration
public SkeletonBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
SkeletonBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public SkeletonBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
SkeletonBuilder

Height(String)

Defines the height of the Skeleton. Height is not required when shape is "Circle" and "Square".

Declaration
public SkeletonBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type Description
SkeletonBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public SkeletonBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
SkeletonBuilder

Label(String)

Defines the 'aria-label' for Skeleton accessibility.

Declaration
public SkeletonBuilder Label(string label)
Parameters
Type Name Description
System.String label
Returns
Type Description
SkeletonBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public SkeletonBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
SkeletonBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
System.Web.HtmlString

Shape(SkeletonType)

Defines the shape of the Skeleton. {% codeBlock src='skeleton/shape/index.md' %}{% endcodeBlock %}

Declaration
public SkeletonBuilder Shape(SkeletonType shape)
Parameters
Type Name Description
SkeletonType shape
Returns
Type Description
SkeletonBuilder

ShimmerEffect(ShimmerEffect)

Defines the animation effect of the Skeleton. {% codeBlock src='skeleton/shimmerEffect/index.md' %}{% endcodeBlock %}

Declaration
public SkeletonBuilder ShimmerEffect(ShimmerEffect shimmerEffect)
Parameters
Type Name Description
ShimmerEffect shimmerEffect
Returns
Type Description
SkeletonBuilder

Visible(Boolean)

Defines the visibility state of Skeleton.

Declaration
public SkeletonBuilder Visible(bool visible = true)
Parameters
Type Name Description
System.Boolean visible
Returns
Type Description
SkeletonBuilder

Width(String)

Defines the width of the Skeleton. Width will be prioritized and used as dimension when shape is "Circle" and "Square".

Declaration
public SkeletonBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
SkeletonBuilder