Table of Contents

Class LayoutBuilderListBaseClass

Namespace
Contensive.BaseClasses.LayoutBuilder
Assembly
CPBase.dll

A tabular list of data rows with filters on the left.

public abstract class LayoutBuilderListBaseClass : LayoutBuilderBaseClass
Inheritance
LayoutBuilderListBaseClass
Inherited Members

Constructors

LayoutBuilderListBaseClass(CPBaseClass)

A tabular list of data rows with filters on the left.

protected LayoutBuilderListBaseClass(CPBaseClass cp)

Parameters

cp CPBaseClass

Properties

addCsvDownloadCurrentPage

See allowDownloadButton for download details.

[Obsolete("Deprecated. See allowDownloadButton for download details.", false)]
public abstract bool addCsvDownloadCurrentPage { get; set; }

Property Value

bool

columnCaption 

public abstract string columnCaption { get; set; }

Property Value

string

columnCaptionClass 

public abstract string columnCaptionClass { get; set; }

Property Value

string

columnCellClass 

public abstract string columnCellClass { get; set; }

Property Value

string

columnDownloadable 

public abstract bool columnDownloadable { get; set; }

Property Value

bool

columnName 

public abstract string columnName { get; set; }

Property Value

string

columnSortable 

public abstract bool columnSortable { get; set; }

Property Value

bool

columnVisible 

public abstract bool columnVisible { get; set; }

Property Value

bool

columnWidthPercent 

public abstract int columnWidthPercent { get; set; }

Property Value

int

excludeRowFromDownload 

public abstract bool excludeRowFromDownload { get; set; }

Property Value

bool

formId 

[Obsolete("Deprecated. use addHidden() to add a formId hidden tag", false)]
public abstract string formId { get; set; }

Property Value

string

formid

deprecated. Use warningMessage instead

[Obsolete("Deprecated. Use addFormHidden()", false)]
public override string formid { get; set; }

Property Value

string

guid 

[Obsolete("Deprecated. Saved reports are no longer supported.", false)]
public abstract string guid { get; set; }

Property Value

string

name 

[Obsolete("Deprecated. Saved reports are no longer supported.", false)]
public abstract string name { get; set; }

Property Value

string

paginationPageNumber

1-based page number

public abstract int paginationPageNumber { get; }

Property Value

int

paginationPageSize

records per page to be displayed. If the user has not changed it, this is paginationPageSizeDefault

public abstract int paginationPageSize { get; }

Property Value

int

paginationPageSizeDefault

The default records per page to be displayed. The user may make changes, reflected in paginationPageSize

public abstract int paginationPageSizeDefault { get; set; }

Property Value

int

paginationRecordAlias

In the pagination section, this phrase replaces the word 'records' in '# records found'

public abstract string paginationRecordAlias { get; set; }

Property Value

string

recordCount

The total records in the dataset, not just what is displayed on the page

public abstract int recordCount { get; set; }

Property Value

int

reportRowLimit

Add padding around the body

public abstract int reportRowLimit { get; }

Property Value

int

sqlOrderBy

The sql orderby clause used to order the data set. Created from the user clicking on a column header.

public abstract string sqlOrderBy { get; }

Property Value

string

sqlSearchTerm

The sql search term used to filter the data set when a user types the term into the search box.

public abstract string sqlSearchTerm { get; }

Property Value

string

Methods

addColumn() 

public abstract void addColumn()

addColumn(ReportListColumnBaseClass) 

public abstract void addColumn(ReportListColumnBaseClass column)

Parameters

column ReportListColumnBaseClass

addRow() 

public abstract void addRow()

addRowClass(string) 

public abstract void addRowClass(string styleClass)

Parameters

styleClass string

addRowEllipseMenuItem(string, string)

adds this name/url as an ellipse menu item to the current column

public abstract void addRowEllipseMenuItem(string name, string url)

Parameters

name string
url string

paginationReset()

reset pagination back to page 1. Use to force the view to page when when the query filter changes. Mus tbe called before accessing pagination fields or query elements.

public abstract void paginationReset()

setCell(bool) 

public abstract void setCell(bool content)

Parameters

content bool

setCell(bool, bool) 

public abstract void setCell(bool content, bool downloadContent)

Parameters

content bool
downloadContent bool

setCell(double) 

public abstract void setCell(double content)

Parameters

content double

setCell(double, double) 

public abstract void setCell(double content, double downloadContent)

Parameters

content double
downloadContent double

setCell(int) 

public abstract void setCell(int content)

Parameters

content int

setCell(int, int) 

public abstract void setCell(int content, int downloadContent)

Parameters

content int
downloadContent int

setCell(DateTime?) 

public abstract void setCell(DateTime? content)

Parameters

content DateTime?

setCell(DateTime?, DateTime?) 

public abstract void setCell(DateTime? content, DateTime? downloadContent)

Parameters

content DateTime?
downloadContent DateTime?

setCell(string)

set the cell content for the current row.

public abstract void setCell(string content)

Parameters

content string

setCell(string, bool)

set the cell content for the current row.

public abstract void setCell(string reportContent, bool downloadContent)

Parameters

reportContent string
downloadContent bool

setCell(string, DateTime)

set the cell content for the current row.

public abstract void setCell(string reportContent, DateTime downloadContent)

Parameters

reportContent string
downloadContent DateTime

setCell(string, double)

set the cell content for the current row.

public abstract void setCell(string reportContent, double downloadContent)

Parameters

reportContent string
downloadContent double

setCell(string, int)

set the cell content for the current row.

public abstract void setCell(string reportContent, int downloadContent)

Parameters

reportContent string
downloadContent int

setCell(string, string)

set the cell content for the current row.

public abstract void setCell(string reportContent, string downloadContent)

Parameters

reportContent string
downloadContent string
Edit this page