Class AccordionPropertiesBuilder

Represents the Accordion Properties.

Inheritance

System.Object

AccordionPropertiesBuilder

Implements

IPropertiesBuilder

System.Web.IHtmlString

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.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class AccordionPropertiesBuilder : IPropertiesBuilder, IHtmlString

Constructors

AccordionPropertiesBuilder()

Initializes a new instance of the AccordionPropertiesBuilder class.

Declaration

public AccordionPropertiesBuilder()

AccordionPropertiesBuilder(Accordion)

Initializes a new instance of the AccordionPropertiesBuilder class.

Declaration

public AccordionPropertiesBuilder(Accordion accordion)

Parameters

Type	Name	Description
Accordion	accordion	Accepts the Accordion properties

Fields

accordion

Initializes a new instance of the AccordionPropertiesBuilder class.

Declaration

public Accordion accordion

Field Value

Type	Description
Accordion

Properties

ItemsCollection

Gets or sets the Accordion Item collections.

Declaration

public List<AccordionBaseItem> ItemsCollection { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<AccordionBaseItem>

Methods

AjaxSettings(Action<jQueryAjaxOptionsBuilder>)

Specifies the ajaxSettings option to load the content to the accordion control with object argument.

Declaration

public AccordionPropertiesBuilder AjaxSettings(Action<jQueryAjaxOptionsBuilder> ajaxOptions)

Parameters

Type	Name	Description
System.Action<jQueryAjaxOptionsBuilder>	ajaxOptions	ajaxSettings

Returns

Type	Description
AccordionPropertiesBuilder	This method returns object value

AllowKeyboardNavigation()

Accordion headers can be expanded and collapsed on keyboard action.

Declaration

public AccordionPropertiesBuilder AllowKeyboardNavigation()

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

AllowKeyboardNavigation(Boolean)

Accordion headers can be expanded and collapsed on keyboard action with boolean argument.

Declaration

public AccordionPropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)

Parameters

Type	Name	Description
System.Boolean	allowKeyboardNavigation	allowKeyboardNavigation

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

ClientSideEvents(Action<AccordionClientSideEventsBuilder>)

Specify the Accordion ClientSide Events

Declaration

public AccordionPropertiesBuilder ClientSideEvents(Action<AccordionClientSideEventsBuilder> clientSideEvents)

Parameters

Type	Name	Description
System.Action<AccordionClientSideEventsBuilder>	clientSideEvents	client side events

Returns

Type	Description
AccordionPropertiesBuilder	This method returns accordion properties builder value

CollapseSpeed(String)

To set the Accordion headers Collapse Speed with string argument.

Declaration

public AccordionPropertiesBuilder CollapseSpeed(string collapseSpeed)

Parameters

Type	Name	Description
System.String	collapseSpeed	collapseSpeed

Returns

Type	Description
AccordionPropertiesBuilder	This method returns string value

Collapsible()

Specifies the collapsible state of accordion control.

Declaration

public AccordionPropertiesBuilder Collapsible()

Returns

Type	Description
AccordionPropertiesBuilder

Collapsible(Boolean)

Specifies the collapsible state of accordion control with boolean argument.

Declaration

public AccordionPropertiesBuilder Collapsible(bool collapsible)

Parameters

Type	Name	Description
System.Boolean	collapsible	collapsible

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

CssClass(String)

Sets the root CSS class for Accordion theme, which is used customize.

Declaration

public AccordionPropertiesBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass	cssClass

Returns

Type	Description
AccordionPropertiesBuilder	This method returns string value

CustomIcon(Action<CustomIconBuilder>)

Allows you to set the custom header Icon. It accepts two key values “header”, ”selectedHeader” with object argument.

Declaration

public AccordionPropertiesBuilder CustomIcon(Action<CustomIconBuilder> iconCSS)

Parameters

Type	Name	Description
System.Action<CustomIconBuilder>	iconCSS	customIcon

Returns

Type	Description
AccordionPropertiesBuilder	This method returns object value

DisableItems(List<Int32>)

Disables the specified indexed items in accordion with array argument.

Declaration

public AccordionPropertiesBuilder DisableItems(List<int> disabledItems)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	disabledItems	disabledItems

Returns

Type	Description
AccordionPropertiesBuilder	This method returns number value

EnableAnimation()

Specifies the animation behavior in accordion.

Declaration

public AccordionPropertiesBuilder EnableAnimation()

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

EnableAnimation(Boolean)

Specifies the animation behavior in accordion with boolean argument.

Declaration

public AccordionPropertiesBuilder EnableAnimation(bool enableanimation)

Parameters

Type	Name	Description
System.Boolean	enableanimation

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

Enabled()

With this enabled property, you can enable or disable the Accordion.

Declaration

public AccordionPropertiesBuilder Enabled()

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

Enabled(Boolean)

With this enabled property, you can enable or disable the Accordion with boolean argument.

Declaration

public AccordionPropertiesBuilder Enabled(bool enabled)

Parameters

Type	Name	Description
System.Boolean	enabled	enabled

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

EnabledItems(List<Int32>)

Used to enable the disabled items in accordion with array argument.

Declaration

public AccordionPropertiesBuilder EnabledItems(List<int> enabledItems)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	enabledItems	enabledItems

Returns

Type	Description
AccordionPropertiesBuilder	This method returns number value

EnableMultipleOpen()

Multiple content panels to activate at a time.

Declaration

public AccordionPropertiesBuilder EnableMultipleOpen()

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

EnableMultipleOpen(Boolean)

Multiple content panels to activate at a time with boolean argument.

Declaration

public AccordionPropertiesBuilder EnableMultipleOpen(bool multipleOpen)

Parameters

Type	Name	Description
System.Boolean	multipleOpen	enableMultipleOpen

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

EnablePersistence()

Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5 local storage.

Declaration

public AccordionPropertiesBuilder EnablePersistence()

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

EnablePersistence(Boolean)

Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5 local storage with boolean argument.

Declaration

public AccordionPropertiesBuilder EnablePersistence(bool persist)

Parameters

Type	Name	Description
System.Boolean	persist	enablePersistence

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

EnableRTL()

Display headers and panel text from right-to-left.

Declaration

public AccordionPropertiesBuilder EnableRTL()

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

EnableRTL(Boolean)

Display headers and panel text from right-to-left with boolean argument.

Declaration

public AccordionPropertiesBuilder EnableRTL(bool rtl)

Parameters

Type	Name	Description
System.Boolean	rtl	enableRTL

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

Events(String)

The events API binds the action for activating the accordion header. Users can activate the header by using mouse actions such as mouse-over, mouse-up, mouse-down, and so on with string argument.

Declaration

public AccordionPropertiesBuilder Events(string events)

Parameters

Type	Name	Description
System.String	events	events

Returns

Type	Description
AccordionPropertiesBuilder	This method returns string value

ExpandSpeed(String)

To set the Accordion headers Expand Speed with string argument.

Declaration

public AccordionPropertiesBuilder ExpandSpeed(string expandSpeed)

Parameters

Type	Name	Description
System.String	expandSpeed	expandSpeed

Returns

Type	Description
AccordionPropertiesBuilder	This method returns string value

HeaderSize(String)

Sets the height for Accordion items header with string argument.

Declaration

public AccordionPropertiesBuilder HeaderSize(string headerSize)

Parameters

Type	Name	Description
System.String	headerSize	headerSize

Returns

Type	Description
AccordionPropertiesBuilder	This method returns string value

Height(String)

Specifies height of the accordion with string argument.

Declaration

public AccordionPropertiesBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height	height

Returns

Type	Description
AccordionPropertiesBuilder	This method returns string value

HeightAdjustMode(HeightAdjustMode)

Specifies the possible values for the status of height adjust mode.

Declaration

public AccordionPropertiesBuilder HeightAdjustMode(HeightAdjustMode heightAdjustMode)

Parameters

Type	Name	Description
HeightAdjustMode	heightAdjustMode	heightAdjustMode

Returns

Type	Description
AccordionPropertiesBuilder	This method returns enum|string value

HtmlAttributes(IDictionary<String, Object>)

It allows to define the characteristics of the Accordion control. It will helps to extend the capability of an HTML element.

Declaration

public AccordionPropertiesBuilder HtmlAttributes(IDictionary<string, object> itemHtmlAttributes)

Parameters

Type	Name	Description
System.Collections.Generic.IDictionary<System.String, System.Object>	itemHtmlAttributes	html Attributes

Returns

Type	Description
AccordionPropertiesBuilder	This method returns object value

Items(Action<AccordionBaseItemAdder>)

Specify the Accordion Items

Declaration

public AccordionPropertiesBuilder Items(Action<AccordionBaseItemAdder> items)

Parameters

Type	Name	Description
System.Action<AccordionBaseItemAdder>	items	items

Returns

Type	Description
AccordionPropertiesBuilder	This method returns accordion properties builder value

Render()

Renders this instance.

Declaration

public void Render()

SelectedItemIndex(Int32)

The given index header will activate (open). If collapsible is set to true, and a negative value is given, then all headers are collapsed. Otherwise, the first panel is activated with integer argument.

Declaration

public AccordionPropertiesBuilder SelectedItemIndex(int selectedItemIndex)

Parameters

Type	Name	Description
System.Int32	selectedItemIndex	selectedItemIndex

Returns

Type	Description
AccordionPropertiesBuilder	This method returns number value

SelectedItems(List<Int32>)

Activate the specified indexed items of the accordion with array argument.

Declaration

public AccordionPropertiesBuilder SelectedItems(List<int> selectedItems)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Int32>	selectedItems	selectedItems

Returns

Type	Description
AccordionPropertiesBuilder	This method returns number value

ShowRoundedCorner()

Displays rounded corner borders on the Accordion control’s panels and headers.

Declaration

public AccordionPropertiesBuilder ShowRoundedCorner()

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

ShowRoundedCorner(Boolean)

Displays rounded corner borders on the Accordion control’s panels and headers with boolean argument.

Declaration

public AccordionPropertiesBuilder ShowRoundedCorner(bool roundedCorner)

Parameters

Type	Name	Description
System.Boolean	roundedCorner	showRoundedCorner

Returns

Type	Description
AccordionPropertiesBuilder	This method returns boolean value

ToHtmlString()

Returns an HTML-encoded string.

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

Width(String)

Specifies width of the accordion with string argument.

Declaration

public AccordionPropertiesBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width	width

Returns

Type	Description
AccordionPropertiesBuilder	This method returns string value

Implements

IPropertiesBuilder

System.Web.IHtmlString