1 out of 1 rated this helpful - Rate this topic

ModuleListPageSearchOptions Class

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

System..::..Object
  Microsoft.Web.Management.Client..::..ModuleListPageSearchOptions

Namespace:  Microsoft.Web.Management.Client
Assembly:  Microsoft.Web.Management (in Microsoft.Web.Management.dll)
[SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public sealed class ModuleListPageSearchOptions

The ModuleListPageSearchOptions type exposes the following members.

  NameDescription
Public methodModuleListPageSearchOptions()()()()Initializes a new instance of the ModuleListPageSearchOptions class.
Public methodModuleListPageSearchOptions(String)Initializes a new instance of the ModuleListPageSearchOptions class by using the specified search text.
Public methodModuleListPageSearchOptions(String, ModuleListPageSearchField)Initializes a new instance of the ModuleListPageSearchOptions class by using the specified search text and field.
Top
  NameDescription
Public propertyFieldGets the value of the field parameter that is passed to the constructor.
Public propertyShowAllGets a value indicating whether all the items in the module list should be shown.
Public propertyTextGets the value of the text parameter that is passed to the constructor.
Top
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top

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

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();
}


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.