Table of Contents

Class SearchResultsBaseGridController<TFilter>

Namespace
InSite.Common.Web.UI
Assembly
InSite.UI.dll
public abstract class SearchResultsBaseGridController<TFilter> : BaseSearchResultsController<TFilter>, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IFilterResolutionService, IAttributeAccessor, INamingContainer, IUserControlDesignerAccessor, ISearchResults where TFilter : Filter

Type Parameters

TFilter
Inheritance
SearchResultsBaseGridController<TFilter>
Implements
Derived
Inherited Members

Constructors

SearchResultsBaseGridController()

protected SearchResultsBaseGridController()

Properties

ColumnNames

protected string[] ColumnNames { get; }

Property Value

string[]

DefaultPageSize

protected virtual int DefaultPageSize { get; }

Property Value

int

ExportFileName

protected virtual string ExportFileName { get; }

Property Value

string

GridDataSource

public abstract object GridDataSource { get; set; }

Property Value

object

GridPageIndex

protected abstract int GridPageIndex { get; set; }

Property Value

int

GridPagerVisible

protected abstract bool GridPagerVisible { get; set; }

Property Value

bool

GridTotalItemCount

protected abstract int GridTotalItemCount { get; set; }

Property Value

int

GridVisible

protected abstract bool GridVisible { get; set; }

Property Value

bool

HasRows

public bool HasRows { get; }

Property Value

bool

IsFinder

protected virtual bool IsFinder { get; }

Property Value

bool

LastSearched

public override DateTimeOffset? LastSearched { get; }

Property Value

DateTimeOffset?

Linker

protected abstract SearchResultsBaseGridController<TFilter>.IControlLinker Linker { get; }

Property Value

SearchResultsBaseGridController<TFilter>.IControlLinker

PageSize

public int PageSize { get; set; }

Property Value

int

RefreshLastSearched

protected bool RefreshLastSearched { get; set; }

Property Value

bool

RowCount

public override int RowCount { get; }

Property Value

int

SortExpression

protected SearchSort SortExpression { get; set; }

Property Value

SearchSort

Update

protected SearchResultsBaseGridController<TFilter>.UpdateType Update { get; set; }

Property Value

SearchResultsBaseGridController<TFilter>.UpdateType

Methods

BindGrid()

protected void BindGrid()

CallUpdateDateTimeOffsets(IList, string)

public void CallUpdateDateTimeOffsets(IList list, string timeZoneId)

Parameters

list IList
timeZoneId string

Clear(TFilter)

public override void Clear(TFilter filter)

Parameters

filter TFilter

DeleteSearch()

public virtual void DeleteSearch()

GetColumns()

protected abstract IEnumerable<SearchResultsBaseGridController<TFilter>.IColumn> GetColumns()

Returns

IEnumerable<SearchResultsBaseGridController<TFilter>.IColumn>

GetColumnsSelectorDataSource()

public IEnumerable<string> GetColumnsSelectorDataSource()

Returns

IEnumerable<string>

GetCsvBytes()

protected virtual byte[] GetCsvBytes()

Returns

byte[]

GetDownloadColumns(IList)

protected virtual IEnumerable<DownloadColumn> GetDownloadColumns(IList dataList)

Parameters

dataList IList

Returns

IEnumerable<DownloadColumn>

GetExportData(TFilter, bool)

public override IListSource GetExportData(TFilter filter, bool empty)

Parameters

filter TFilter
empty bool

Returns

IListSource

GetExportFileName(string)

protected virtual string GetExportFileName(string defaultName)

Parameters

defaultName string

Returns

string

GetRowCount()

protected abstract int GetRowCount()

Returns

int

GetXlsxBytes()

protected virtual byte[] GetXlsxBytes()

Returns

byte[]

GridDataBind()

protected abstract void GridDataBind()

LoadSearch()

public override bool LoadSearch()

Returns

bool

LoadSearchSettings()

protected virtual Search<TFilter> LoadSearchSettings()

Returns

Search<TFilter>

OnExportButtonClick(string)

protected virtual void OnExportButtonClick(string commandName)

Parameters

commandName string

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

RefreshGrid()

public virtual void RefreshGrid()

SaveSearch(TFilter, bool)

public override void SaveSearch(TFilter filter, bool refreshLastSearched)

Parameters

filter TFilter
refreshLastSearched bool

SaveSearchSettings(TFilter, int, SearchSort, bool)

protected virtual void SaveSearchSettings(TFilter filter, int pageIndex, SearchSort sortExpression, bool refreshLastSearched)

Parameters

filter TFilter
pageIndex int
sortExpression SearchSort
refreshLastSearched bool

Search(TFilter, bool)

public override void Search(TFilter filter, bool refreshLastSearched = false)

Parameters

filter TFilter
refreshLastSearched bool

Search(TFilter, int)

protected virtual void Search(TFilter filter, int pageIndex)

Parameters

filter TFilter
pageIndex int

SearchWithCurrentPageIndex(TFilter)

public virtual void SearchWithCurrentPageIndex(TFilter filter)

Parameters

filter TFilter

SelectCount(TFilter)

protected abstract int SelectCount(TFilter filter)

Parameters

filter TFilter

Returns

int

SelectData(TFilter)

protected abstract IListSource SelectData(TFilter filter)

Parameters

filter TFilter

Returns

IListSource

SetGridVisibility(bool, bool)

protected virtual void SetGridVisibility(bool isVisible, bool showInstructions)

Parameters

isVisible bool
showInstructions bool

SetInstructionText(string)

protected virtual void SetInstructionText(string text)

Parameters

text string

SetupExportButton(DropDownButton)

protected virtual void SetupExportButton(DropDownButton button)

Parameters

button DropDownButton

UpdateDateTimeOffsets<T>(IEnumerable<T>, string)

protected virtual void UpdateDateTimeOffsets<T>(IEnumerable<T> objects, string timeZoneId) where T : class

Parameters

objects IEnumerable<T>
timeZoneId string

Type Parameters

T