Class RVDateFilterMenuItemList
List of a date filter's menu items.
Inheritance
Implements
Inherited Members
Namespace: Reveal.Sdk
Assembly: Reveal.UI.Sdk.dll
Syntax
public class RVDateFilterMenuItemList : List<IRVDateFilterMenuItem>, IList<IRVDateFilterMenuItem>, ICollection<IRVDateFilterMenuItem>, IList, ICollection, IReadOnlyList<IRVDateFilterMenuItem>, IReadOnlyCollection<IRVDateFilterMenuItem>, IEnumerable<IRVDateFilterMenuItem>, IEnumerable
Constructors
RVDateFilterMenuItemList()
Declaration
public RVDateFilterMenuItemList()
Methods
Add(RVDateRange)
Add a new menu item for a date range.
Declaration
public RVDateFilterMenuOption Add(RVDateRange range)
Parameters
Type | Name | Description |
---|---|---|
RVDateRange | range | Date range to add |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
Add(RVDateRange, String)
Add a new menu item for a date range specifying a custom title.
Declaration
public RVDateFilterMenuOption Add(RVDateRange range, string title)
Parameters
Type | Name | Description |
---|---|---|
RVDateRange | range | Date range to add |
System.String | title | Custom title for the menu item |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
Add(RVDateRule)
Add a new menu item for a date rule.
Declaration
public RVDateFilterMenuOption Add(RVDateRule rule)
Parameters
Type | Name | Description |
---|---|---|
RVDateRule | rule | Date rule to add |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
Add(RVDateRule, String)
Add a new menu item for a date range specifying a custom title.
Declaration
public RVDateFilterMenuOption Add(RVDateRule rule, string title)
Parameters
Type | Name | Description |
---|---|---|
RVDateRule | rule | Date rule to add |
System.String | title | Custom title for the menu item |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
AddSeparator()
Add a menu separator to the items list.
Declaration
public RVDateFilterMenuSeparator AddSeparator()
Returns
Type | Description |
---|---|
RVDateFilterMenuSeparator | Reference to the separator that was created |
GetByTitle(String)
Retrieve an item given its title.
Declaration
public IRVDateFilterMenuItem GetByTitle(string title)
Parameters
Type | Name | Description |
---|---|---|
System.String | title | Item title to look for |
Returns
Type | Description |
---|---|
IRVDateFilterMenuItem | First item matching the specified title |
GetItemIndex(String)
Retrieve the index for a given item given its title.
Declaration
public int GetItemIndex(string title)
Parameters
Type | Name | Description |
---|---|---|
System.String | title | Item title to look for |
Returns
Type | Description |
---|---|
System.Int32 | Index for the first item matching the specified title |
Insert(Int32, RVDateRange)
Insert a new menu item for a date range.
Declaration
public RVDateFilterMenuOption Insert(int index, RVDateRange range)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Position to insert the new item |
RVDateRange | range | Date range to add. |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
Insert(Int32, RVDateRange, String)
Insert a new menu item for a date range specifying a custom title.
Declaration
public RVDateFilterMenuOption Insert(int index, RVDateRange range, string title)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Position to insert the new item |
RVDateRange | range | Date rule to add. |
System.String | title | Custom title for the menu item |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
Insert(Int32, RVDateRule)
Insert a new menu item for a date rule.
Declaration
public RVDateFilterMenuOption Insert(int index, RVDateRule rule)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Position to insert the new item |
RVDateRule | rule | Date rule to add. |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
Insert(Int32, RVDateRule, String)
Insert a new menu item for a date rule specifying a custom title.
Declaration
public RVDateFilterMenuOption Insert(int index, RVDateRule rule, string title)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Position to insert the new item |
RVDateRule | rule | Date rule to add. |
System.String | title | Custom title for the menu item |
Returns
Type | Description |
---|---|
RVDateFilterMenuOption | Menu option that was created |
InsertSeparator(Int32)
Insert a menu separator to the items list.
Declaration
public RVDateFilterMenuSeparator InsertSeparator(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | Position to insert the new item |
Returns
Type | Description |
---|---|
RVDateFilterMenuSeparator | Reference to the separator that was created |