Class EcfListView
Inheritance
Namespace: Mediachase.Web.Console.Controls
Assembly: Mediachase.WebConsoleLib.dll
Version: 10.8.0Syntax
public class EcfListView : ListView
Constructors
EcfListView()
Declaration
public EcfListView()
Fields
ColumnWithCheckboxes
Declaration
public const int ColumnWithCheckboxes = 0
Field Value
Type | Description |
---|---|
System.Int32 |
DefaultCheckboxColumnWidth
Declaration
public const int DefaultCheckboxColumnWidth = 24
Field Value
Type | Description |
---|---|
System.Int32 |
DefaultColumnWidth
Declaration
public const int DefaultColumnWidth = 100
Field Value
Type | Description |
---|---|
System.Int32 |
DefaultFooterCellId
Declaration
public const string DefaultFooterCellId = "tdFooter"
Field Value
Type | Description |
---|---|
System.String |
DefaultFooterDivId
Declaration
public const string DefaultFooterDivId = "footerDiv"
Field Value
Type | Description |
---|---|
System.String |
DefaultHeaderHeight
Declaration
public const int DefaultHeaderHeight = 24
Field Value
Type | Description |
---|---|
System.Int32 |
DefaultInnerTableId
Declaration
public const string DefaultInnerTableId = "lvTable"
Field Value
Type | Description |
---|---|
System.String |
DefaultPageSize
Declaration
public const int DefaultPageSize = 20
Field Value
Type | Description |
---|---|
System.Int32 |
DefaultPagingDropdownId
Declaration
public const string DefaultPagingDropdownId = "ddPaging"
Field Value
Type | Description |
---|---|
System.String |
DefaultSortImageControlPrefix
Declaration
public const string DefaultSortImageControlPrefix = "img"
Field Value
Type | Description |
---|---|
System.String |
DefaultTableHeaderId
Declaration
public const string DefaultTableHeaderId = "headerTRow"
Field Value
Type | Description |
---|---|
System.String |
ExtenderPrimaryKeyAttributeSeparator
Declaration
public const string ExtenderPrimaryKeyAttributeSeparator = "::"
Field Value
Type | Description |
---|---|
System.String |
GridCommandParameterName
Declaration
public const string GridCommandParameterName = "GridCommand"
Field Value
Type | Description |
---|---|
System.String |
p_checkboxEnableDataField
Declaration
public const string p_checkboxEnableDataField = "checkboxEnableField"
Field Value
Type | Description |
---|---|
System.String |
p_currencyCodeDataField
Declaration
public const string p_currencyCodeDataField = "currencyCodeField"
Field Value
Type | Description |
---|---|
System.String |
p_dataNavigateUrlFields
Declaration
public const string p_dataNavigateUrlFields = "DataNavigateUrlFields"
Field Value
Type | Description |
---|---|
System.String |
p_dataNavigateUrlFormatString
Declaration
public const string p_dataNavigateUrlFormatString = "DataNavigateUrlFormatString"
Field Value
Type | Description |
---|---|
System.String |
p_dataTextEncode
Declaration
public const string p_dataTextEncode = "dataTextEncode"
Field Value
Type | Description |
---|---|
System.String |
p_dataTextFields
Declaration
public const string p_dataTextFields = "DataTextFields"
Field Value
Type | Description |
---|---|
System.String |
p_dataTextFormatString
Declaration
public const string p_dataTextFormatString = "DataTextFormatString"
Field Value
Type | Description |
---|---|
System.String |
p_navigateUrlKey
Declaration
public const string p_navigateUrlKey = "NavigateUrl"
Field Value
Type | Description |
---|---|
System.String |
Properties
AppId
Gets or sets the app id.
Declaration
public string AppId { get; set; }
Property Value
Type | Description |
---|---|
System.String | The app id. |
ClassName
Gets or sets the name of the class.
Declaration
public string ClassName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The name of the class. |
CurrentPageSize
Gets or sets the size of the current page.
Declaration
public int CurrentPageSize { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The size of the current page. |
FooterCssClass
Gets or sets the footer CSS class.
Declaration
public string FooterCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The footer CSS class. |
GridCssClass
Gets or sets the grid CSS class.
Declaration
public string GridCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The grid CSS class. |
GridInnerCssClass
Gets or sets the grid inner CSS class.
Declaration
public string GridInnerCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The grid inner CSS class. |
GridSelectedRowCssClass
Gets or sets the grid selected row CSS class.
Declaration
public string GridSelectedRowCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The grid selected row CSS class. |
HeaderCssClass
Gets or sets the header CSS class.
Declaration
public string HeaderCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The header CSS class. |
HeaderInnerCssClass
Gets or sets the header inner CSS class.
Declaration
public string HeaderInnerCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The header inner CSS class. |
ImagesBaseUrl
Gets or sets the images base URL.
Declaration
public string ImagesBaseUrl { get; set; }
Property Value
Type | Description |
---|---|
System.String | The images base URL. |
ImageUrlAscending
Gets or sets the image URL ascending.
Declaration
public string ImageUrlAscending { get; set; }
Property Value
Type | Description |
---|---|
System.String | The image URL ascending. |
ImageUrlDescending
Gets or sets the image URL descending.
Declaration
public string ImageUrlDescending { get; set; }
Property Value
Type | Description |
---|---|
System.String | The image URL descending. |
PagerDropdownCssClass
Gets or sets the pager dropdown CSS class.
Declaration
public string PagerDropdownCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The pager dropdown CSS class. |
PagerRowCssClass
Gets or sets the pager row CSS class.
Declaration
public string PagerRowCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The pager row CSS class. |
PagerTextCssClass
Gets or sets the pager text CSS class.
Declaration
public string PagerTextCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The pager text CSS class. |
PlaceName
Gets or sets the name of the place.
Declaration
public string PlaceName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The name of the place. |
PrimaryKeyId
Gets or sets the primary key id.
Declaration
public string PrimaryKeyId { get; set; }
Property Value
Type | Description |
---|---|
System.String | The primary key id. |
ShowCheckboxes
Gets or sets a value indicating whether [show checkboxes].
Declaration
public bool ShowCheckboxes { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
ShowPaging
Gets or sets a value indicating whether [show paging].
Declaration
public bool ShowPaging { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
SortDirectionDefault
Gets or sets the sort direction default.
Declaration
public SortDirection SortDirectionDefault { get; set; }
Property Value
Type | Description |
---|---|
System.Web.UI.WebControls.SortDirection | The sort direction default. |
SortExpression
Declaration
public override string SortExpression { get; }
Property Value
Type | Description |
---|---|
System.String |
SortExpressionDefault
Gets or sets the sort expression default.
Declaration
public string SortExpressionDefault { get; set; }
Property Value
Type | Description |
---|---|
System.String | The sort expression default. |
SortProperties
Gets or sets the sort properties.
Declaration
public SortViewState SortProperties { get; set; }
Property Value
Type | Description |
---|---|
SortViewState | The sort properties. |
TableAltRowCssClass
Gets or sets the table alt row CSS class.
Declaration
public string TableAltRowCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The table alt row CSS class. |
TableCellCssClass
Gets or sets the table cell CSS class.
Declaration
public string TableCellCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The table cell CSS class. |
TableCssClass
Gets or sets the table CSS class.
Declaration
public string TableCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The table CSS class. |
TableHeadingCellCssClass
Gets or sets the table heading cell CSS class.
Declaration
public string TableHeadingCellCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The table heading cell CSS class. |
TableHeadingRowCssClass
Gets or sets the table heading row CSS class.
Declaration
public string TableHeadingRowCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The table heading row CSS class. |
TableRowCssClass
Gets or sets the table row CSS class.
Declaration
public string TableRowCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The table row CSS class. |
TableSelectedRowCssClass
Gets or sets the table selected row CSS class.
Declaration
public string TableSelectedRowCssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | The table selected row CSS class. |
UserPreferences
Gets or sets the user preferences.
Declaration
public EcfListViewPreferences UserPreferences { get; }
Property Value
Type | Description |
---|---|
EcfListViewPreferences | The user preferences. |
ViewId
Gets or sets the view id.
Declaration
public string ViewId { get; set; }
Property Value
Type | Description |
---|---|
System.String | The view id. |
Methods
CreateChildControls(IEnumerable, Boolean)
Creates the child controls.
Declaration
protected override int CreateChildControls(IEnumerable dataSource, bool dataBinding)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.IEnumerable | dataSource | The data source. |
System.Boolean | dataBinding | if set to |
Returns
Type | Description |
---|---|
System.Int32 |
GetAdminView()
Gets the admin view.
Declaration
public AdminView GetAdminView()
Returns
Type | Description |
---|---|
AdminView |
GetCheckedCollection()
Gets the checked collection.
Declaration
public string[] GetCheckedCollection()
Returns
Type | Description |
---|---|
System.String[] |
GetCheckedCollection(Page, String)
Returns collection of checked items (primary keys)
Declaration
public static string[] GetCheckedCollection(Page currentPage, string listViewId)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.Page | currentPage | The current page. |
System.String | listViewId | The list view id. |
Returns
Type | Description |
---|---|
System.String[] |
GetCheckedDataItemCollection(Page, String)
Returns collection of checked items (data items)
Declaration
public static ListViewDataItem[] GetCheckedDataItemCollection(Page currentPage, string lvId)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.Page | currentPage | The current page. |
System.String | lvId | The lv id. |
Returns
Type | Description |
---|---|
System.Web.UI.WebControls.ListViewDataItem[] |
GetDataCellValue(Object)
Gets the data cell value.
Declaration
public static string GetDataCellValue(object val)
Parameters
Type | Name | Description |
---|---|---|
System.Object | val | The val. |
Returns
Type | Description |
---|---|
System.String |
GetDataCellValue(Object, Boolean)
Gets the data cell value.
Declaration
public static string GetDataCellValue(object val, bool keepOriginalFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Object | val | The val. |
System.Boolean | keepOriginalFormat | Indicates if val should be HTML encoded (=false) or keep its original format (=true). |
Returns
Type | Description |
---|---|
System.String |
GetDataCellValue(Object, String, CultureInfo)
Gets formatted data cell value.
Declaration
public static string GetDataCellValue(object val, string format, CultureInfo ci)
Parameters
Type | Name | Description |
---|---|---|
System.Object | val | The val. |
System.String | format | Format string. |
System.Globalization.CultureInfo | ci | The culture to use for formatting. |
Returns
Type | Description |
---|---|
System.String |
GetDataCellValue(Object, String, CultureInfo, Boolean)
Gets formatted data cell value.
Declaration
public static string GetDataCellValue(object val, string format, CultureInfo ci, bool keepOriginalFormat)
Parameters
Type | Name | Description |
---|---|---|
System.Object | val | The val. |
System.String | format | Format string. |
System.Globalization.CultureInfo | ci | The culture to use for formatting. |
System.Boolean | keepOriginalFormat | Indicates if val should be HTML encoded (=false) or keep its original format (=true). |
Returns
Type | Description |
---|---|
System.String |
GetEvalString(Object, String)
Makes string that can be used in DataBinder.Eval function for the specified dataItem.
Declaration
public static string GetEvalString(object dataItem, string field)
Parameters
Type | Name | Description |
---|---|---|
System.Object | dataItem | The data item. |
System.String | field | The field. |
Returns
Type | Description |
---|---|
System.String |
GetPrimaryKeyIdStringItems(String)
Gets the primary key id string items.
Declaration
public static string[] GetPrimaryKeyIdStringItems(string primaryKey)
Parameters
Type | Name | Description |
---|---|---|
System.String | primaryKey | The primary key. |
Returns
Type | Description |
---|---|
System.String[] |
GetSavedPageSize(Page, String, Int32)
Declaration
public static int GetSavedPageSize(Page page, string viewId, int defaultValue)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.Page | page | |
System.String | viewId | |
System.Int32 | defaultValue |
Returns
Type | Description |
---|---|
System.Int32 |
GetSavedSorting(Page, String, SortViewState)
Declaration
public static SortViewState GetSavedSorting(Page page, string viewId, SortViewState defaultValue)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.Page | page | |
System.String | viewId | |
SortViewState | defaultValue |
Returns
Type | Description |
---|---|
SortViewState |
InnerGetCheckedCollection(Boolean)
Inners the get checked collection.
Declaration
protected string[] InnerGetCheckedCollection(bool skipEmptyItems)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | skipEmptyItems |
Returns
Type | Description |
---|---|
System.String[] |
InnerGetCheckedDataItemCollection()
Inners the get checked collection.
Declaration
protected ListViewDataItem[] InnerGetCheckedDataItemCollection()
Returns
Type | Description |
---|---|
System.Web.UI.WebControls.ListViewDataItem[] |
MakePrimaryKeyIdString(String[])
Makes the primary key id string.
Declaration
public static string MakePrimaryKeyIdString(params string[] ids)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | ids | The ids. |
Returns
Type | Description |
---|---|
System.String |
MakeSortExpression(SortViewState)
Declaration
public static string MakeSortExpression(SortViewState sorting)
Parameters
Type | Name | Description |
---|---|---|
SortViewState | sorting |
Returns
Type | Description |
---|---|
System.String |
OnDataBound(EventArgs)
Raises the System.Web.UI.WebControls.BaseDataBoundControl.DataBound event.
Declaration
protected override void OnDataBound(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e | An System.EventArgs object that contains the event data. |
OnItemCreated(ListViewItemEventArgs)
Raises the ItemCreated event.
Declaration
protected override void OnItemCreated(ListViewItemEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.WebControls.ListViewItemEventArgs | e | The System.Web.UI.WebControls.ListViewItemEventArgs instance containing the event data. |
OnLayoutCreated(EventArgs)
Raises the LayoutCreated event.
Declaration
protected override void OnLayoutCreated(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e | The System.EventArgs instance containing the event data. |
OnSorting(ListViewSortEventArgs)
Raises the Sorting event.
Declaration
protected override void OnSorting(ListViewSortEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.WebControls.ListViewSortEventArgs | e | The System.Web.UI.WebControls.ListViewSortEventArgs instance containing the event data. |
SavePageSize(Page, String, Int32)
Declaration
public static void SavePageSize(Page page, string viewId, int newSize)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.Page | page | |
System.String | viewId | |
System.Int32 | newSize |
SaveSorting(Page, String, SortViewState)
Declaration
public static void SaveSorting(Page page, string viewId, SortViewState newValue)
Parameters
Type | Name | Description |
---|---|---|
System.Web.UI.Page | page | |
System.String | viewId | |
SortViewState | newValue |
SetSortProperties(String)
Parses passed sortString
and assigns SortProperties for the view.
Declaration
public void SetSortProperties(string sortString)
Parameters
Type | Name | Description |
---|---|---|
System.String | sortString |
UncheckCheckedCollection()
Declaration
public void UncheckCheckedCollection()