Table of Contents

Class UserSmartSearchDataProvider

Namespace
Dynamicweb.Security.UserManagement.SmartSearchProviders
Assembly
Dynamicweb.Core.dll

A smart search data provider. Inherit from ConfigurableAddIn class

[AddInLabel("Users")]
[AddInDescription("Users data provider")]
public class UserSmartSearchDataProvider : SmartSearchDataProvider<IEnumerable<User>>, ICloneable
Inheritance
UserSmartSearchDataProvider
Implements
Inherited Members

Constructors

UserSmartSearchDataProvider()

public UserSmartSearchDataProvider()

Methods

ConvertToRuleField(CustomField)

protected static SmartSearchRuleField? ConvertToRuleField(CustomField field)

Parameters

field CustomField

Returns

SmartSearchRuleField

GetFieldDataSource(CustomFieldOptions)

protected static ISmartSearchRuleFieldDatasource GetFieldDataSource(CustomFieldOptions fieldOptions)

Parameters

fieldOptions CustomFieldOptions

Returns

ISmartSearchRuleFieldDatasource

GetPredifinedDataFields()

protected static List<SmartSearchRuleField> GetPredifinedDataFields()

Returns

List<SmartSearchRuleField>

GetUserCustomDataFields()

protected static List<SmartSearchRuleField> GetUserCustomDataFields()

Returns

List<SmartSearchRuleField>

OnExecuteQuery(int, SmartSearchRuleGroupCollection, SmartSearchSortInfo[])

Called when execute smart search query.

protected override IEnumerable<User> OnExecuteQuery(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules, SmartSearchSortInfo[] SortParams)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRuleGroupCollection

The query rules.

SortParams SmartSearchSortInfo[]

The sort params.

Returns

IEnumerable<User>

OnGetCount(int, SmartSearchRuleGroupCollection)

Called when get count of the query results.

protected override int OnGetCount(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules)

Parameters

ResultsLimit int

The results limit.

QueryRules SmartSearchRuleGroupCollection

The query rules.

Returns

int

OnGetPreviewData(int, SmartSearchRuleGroupCollection, SmartSearchSortInfo[])

Exec query and fill data fields

protected override DataTable OnGetPreviewData(int ResultsLimit, SmartSearchRuleGroupCollection QueryRules, SmartSearchSortInfo[] SortParams)

Parameters

ResultsLimit int
QueryRules SmartSearchRuleGroupCollection
SortParams SmartSearchSortInfo[]

Returns

DataTable

OnGetRulesDataFields()

Get data fields for rules

protected override List<SmartSearchRuleField> OnGetRulesDataFields()

Returns

List<SmartSearchRuleField>

OnGetSortingDataFields()

Get data fields for sorting

protected override List<SmartSearchRuleField> OnGetSortingDataFields()

Returns

List<SmartSearchRuleField>
To top