ModuleListPageSearchOptions Class

Definition

Retrieves search fields for a module list. This class cannot be inherited.

public ref class ModuleListPageSearchOptions sealed
public sealed class ModuleListPageSearchOptions
type ModuleListPageSearchOptions = class
Public NotInheritable Class ModuleListPageSearchOptions
Inheritance
ModuleListPageSearchOptions

Examples

The following example shows a possible way to set the display options.

protected override void OnSearch(
    ModuleListPageSearchOptions options) {

    if (options.ShowAll) {
        _searchText = null;
    } else {
        _searchField = options.Field.Name;
        _searchText = options.Text.ToLowerInvariant();
    }

    ReloadPage();
}

Remarks

This class is used to filter searches on a module list.

Constructors

ModuleListPageSearchOptions()

Initializes a new instance of the ModuleListPageSearchOptions class.

ModuleListPageSearchOptions(String)

Initializes a new instance of the ModuleListPageSearchOptions class by using the specified search text.

ModuleListPageSearchOptions(String, ModuleListPageSearchField)

Initializes a new instance of the ModuleListPageSearchOptions class by using the specified search text and field.

Properties

Field

Gets the value of the field parameter that is passed to the constructor.

ShowAll

Gets a value indicating whether all the items in the module list should be shown.

Text

Gets the value of the text parameter that is passed to the constructor.

Applies to