Interface IFacetFilter
An SAPUI5 facet filter object.
Inherited Members
Namespace: HP.LFT.SDK.SAP.UI5
Assembly: HP.LFT.SDK.dll
Syntax
public interface IFacetFilter : IWebElement, ITestObject, IClickable, IWebTestObject, IWebDescriber, ITestObjectDescriber, ILocationInfoProvider, ISupportsNativeObject, IVisibleProvider, ISupportDragAndDrop, IEnabledProvider
Properties
ControlType
The type of facet filter object.
Declaration
ControlType ControlType { get; }
Property Value
| Type | Description |
|---|---|
| ControlType |
Remarks
Possible values: ControlType
Desktop
Additional functionality provided by IDesktopFacetFilterBehavior.
Declaration
IDesktopFacetFilterBehavior Desktop { get; }
Property Value
| Type | Description |
|---|---|
| IDesktopFacetFilterBehavior |
Filters
A collection of all filters in a facet filter.
Declaration
ReadOnlyCollection<string> Filters { get; }
Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<string> |
Mobile
Additional functionality provided by IMobileFacetFilterBehavior.
Declaration
IMobileFacetFilterBehavior Mobile { get; }
Property Value
| Type | Description |
|---|---|
| IMobileFacetFilterBehavior |
Mode
The visual display of the facet filter.
Declaration
FacetFilterMode Mode { get; }
Property Value
| Type | Description |
|---|---|
| FacetFilterMode |
Remarks
Possible values: FacetFilterMode
Methods
GetSelectedKeysCountFor(string)
Returns the number of selected keys in the specific filter list.
Declaration
uint GetSelectedKeysCountFor(string filterListTitle)
Parameters
| Type | Name | Description |
|---|---|---|
| string | filterListTitle |
|
Returns
| Type | Description |
|---|---|
| uint | Number of selected keys |
GetSelectedKeysCountFor(uint)
Returns the number of selected keys in the specific filter list.
Declaration
uint GetSelectedKeysCountFor(uint filterListIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | filterListIndex |
|
Returns
| Type | Description |
|---|---|
| uint | Number of selected keys |
GetSelectedKeysFor(string)
Get selected filter keys in the specific filter list.
Declaration
ReadOnlyCollection<string> GetSelectedKeysFor(string filterListTitle)
Parameters
| Type | Name | Description |
|---|---|---|
| string | filterListTitle | the title of the filter list |
Returns
| Type | Description |
|---|---|
| ReadOnlyCollection<string> | A list of the filter keys (names) that are selected in the specified filter list, separated by semicolons (;). |
GetSelectedKeysFor(uint)
Returns the selected filter keys in the specific filter list.
Declaration
ReadOnlyCollection<string> GetSelectedKeysFor(uint filterListIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | filterListIndex | the index of the filter list |
Returns
| Type | Description |
|---|---|
| ReadOnlyCollection<string> | Returns a collection of all selected keys |