Table of Contents

Class SearchPage<TFilter>

Namespace
InSite.Common.Web.UI
Assembly
InSite.UI.dll
public abstract class SearchPage<TFilter> : PortalBasePage, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, INamingContainer, IFilterResolutionService, IHttpHandler, IAdminPage, IHasTranslator, IHasWebRoute, IFinder where TFilter : Filter

Type Parameters

TFilter
Inheritance
SearchPage<TFilter>
Implements
Derived
Inherited Members

Constructors

SearchPage()

public SearchPage()

Fields

CsvSeparator

protected const string CsvSeparator = ","

Field Value

string

Properties

EntityName

public virtual string EntityName { get; }

Property Value

string

IsClearCriteria

protected virtual bool IsClearCriteria { get; }

Property Value

bool

Linker

protected SearchPage<TFilter>.ControlLinker Linker { get; }

Property Value

SearchPage<TFilter>.ControlLinker

SearchResultTitle

protected virtual string SearchResultTitle { get; }

Property Value

string

Methods

DeleteRecords(Guid[][])

protected virtual bool DeleteRecords(Guid[][] keys)

Parameters

keys Guid[][]

Returns

bool

DeleteRecords(int[][])

protected virtual bool DeleteRecords(int[][] keys)

Parameters

keys int[][]

Returns

bool

DisableForm()

Hides the search Criteria and search Results panels.

protected void DisableForm()

GetDefaultDownloadColumns()

protected IEnumerable<DownloadColumn> GetDefaultDownloadColumns()

Returns

IEnumerable<DownloadColumn>

GetExportColumns()

protected virtual IEnumerable<DownloadColumn> GetExportColumns()

Returns

IEnumerable<DownloadColumn>

GetExportData(int?)

protected virtual IList GetExportData(int? take)

Parameters

take int?

Returns

IList

IsQueryStringValid(NameValueCollection, string[], string[], Alert)

Returns true if the URL has no unexpected parameters. Otherwise, adds an alert message and returns false.

protected bool IsQueryStringValid(NameValueCollection queryString, string[] requiredParameters, string[] optionalParameters, Alert alert)

Parameters

queryString NameValueCollection
requiredParameters string[]
optionalParameters string[]
alert Alert

Returns

bool

LoadSavedFilter()

protected virtual bool LoadSavedFilter()

Returns

bool

LoadSearchedResults()

protected virtual void LoadSearchedResults()

OnBubbleEvent(object, EventArgs)

protected override bool OnBubbleEvent(object source, EventArgs args)

Parameters

source object
args EventArgs

Returns

bool

OnClearing(SearchCriteriaController<TFilter>)

protected virtual void OnClearing(SearchCriteriaController<TFilter> criteria)

Parameters

criteria SearchCriteriaController<TFilter>

OnGridRowCommand(SearchResultsRowCommandArgs)

protected virtual void OnGridRowCommand(SearchResultsRowCommandArgs e)

Parameters

e SearchResultsRowCommandArgs

OnInit(EventArgs)

protected override void OnInit(EventArgs e)

Parameters

e EventArgs

OnLoad(EventArgs)

protected override void OnLoad(EventArgs e)

Parameters

e EventArgs

OnPreRender(EventArgs)

protected override void OnPreRender(EventArgs e)

Parameters

e EventArgs

OnSearching(TFilter)

protected virtual void OnSearching(TFilter filter)

Parameters

filter TFilter

SetDownloadsVisiblity(bool)

protected virtual void SetDownloadsVisiblity(bool visible)

Parameters

visible bool

SetupMainAccordionIndex(bool)

protected void SetupMainAccordionIndex(bool hasResults)

Parameters

hasResults bool