Csla.Web.SelectObjectArgs Class Reference

Argument object used in the SelectObject event. More...

Inheritance diagram for Csla.Web.SelectObjectArgs:

Public Member Functions
	SelectObjectArgs (System.Web.UI.DataSourceSelectArguments args)
	Creates an instance of the object, initializing it with values from data binding. More...

Properties
object	BusinessObject [getset]
	Get or set a reference to the business object that is created and populated by the SelectObject event handler in the web page. More...
string	SortExpression [get]
	Gets the sort expression that should be used to sort the data being returned to the data source control. More...
string	SortProperty [get]
	Gets the property name for the sort if only one property/column name is specified. More...
ListSortDirection	SortDirection [get]
	Gets the sort direction for the sort if only one property/column name is specified. More...
int	StartRowIndex [get]
	Gets the index for the first row that will be displayed. More...
int	MaximumRows [get]
	Gets the maximum number of rows that should be returned as a result of this query. More...
bool	RetrieveTotalRowCount [get]
	Gets a value indicating whether the query should return the total row count through the Csla.Core.IReportTotalRowCount interface. More...

Detailed Description

Argument object used in the SelectObject event.

Definition at line 17 of file SelectObjectArgs.cs.

Constructor & Destructor Documentation

SelectObjectArgs()

Csla.Web.SelectObjectArgs.SelectObjectArgs

(

System.Web.UI.DataSourceSelectArguments

args

)

Creates an instance of the object, initializing it with values from data binding.

Parameters

args	Values provided from data binding.

Definition at line 137 of file SelectObjectArgs.cs.

Property Documentation

BusinessObject

object Csla.Web.SelectObjectArgs.BusinessObject

getset

Get or set a reference to the business object that is created and populated by the SelectObject event handler in the web page.

A reference to a CSLA .NET business object.

Definition at line 34 of file SelectObjectArgs.cs.

MaximumRows

int Csla.Web.SelectObjectArgs.MaximumRows

get

Gets the maximum number of rows that should be returned as a result of this query.

For paged collections, this is the page size.

Definition at line 109 of file SelectObjectArgs.cs.

RetrieveTotalRowCount

bool Csla.Web.SelectObjectArgs.RetrieveTotalRowCount

get

Gets a value indicating whether the query should return the total row count through the Csla.Core.IReportTotalRowCount interface.

Definition at line 124 of file SelectObjectArgs.cs.

SortDirection

ListSortDirection Csla.Web.SelectObjectArgs.SortDirection

get

Gets the sort direction for the sort if only one property/column name is specified.

If multiple properties/columns are specified for the sort, you must parse the value from SortExpression to find all the property names and sort directions for the sort.

Definition at line 81 of file SelectObjectArgs.cs.

SortExpression

string Csla.Web.SelectObjectArgs.SortExpression

get

Gets the sort expression that should be used to sort the data being returned to the data source control.

Definition at line 45 of file SelectObjectArgs.cs.

SortProperty

string Csla.Web.SelectObjectArgs.SortProperty

get

Gets the property name for the sort if only one property/column name is specified.

If multiple properties/columns are specified for the sort, you must parse the value from SortExpression to find all the property names and sort directions for the sort.

Definition at line 63 of file SelectObjectArgs.cs.

StartRowIndex

int Csla.Web.SelectObjectArgs.StartRowIndex

get

Gets the index for the first row that will be displayed.

This should be the first row in the resulting collection set into the BusinessObject property.

Definition at line 95 of file SelectObjectArgs.cs.