UniMatrix Class

UniMatrix base class.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.UIControls.CMSUserControl
              CMS.UIControls.UniMatrix

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 10.0.0

Syntax

public abstract class UniMatrix : CMSUserControl, 
	ICallbackEventHandler, IUniPageable

The UniMatrix type exposes the following members.

Constructors

	Name	Description
Protected method	UniMatrix

Fields

	Name	Description
Protected field	disabledColumns	List of columns which are disabled
Protected field	ds	DataSet with the content
Protected field	mLoaded	Indicates if the content was already loaded or not
Protected field	mTotalRows	Total number of rows

Properties

	Name	Description
Public property	AddFillingColumn	If true, the filling column is added to the table to move columns to the left
Public property	AddGlobalObjectSuffix	Gets or sets the value that indicates whether '(global)' suffix should be added to the global objects
Public property	ColumnItemDisplayNameColumn	Display name column of the column.
Public property	ColumnItemIDColumn	ID column of the column.
Public property	ColumnItemTooltipColumn	Tooltip column of the column.
Public property	ColumnOrderIndex	Gets order in which data will be rendered.
Public property	ColumnsCount	Number of expected matrix columns.
Public property	ColumnsPreferedOrder	Number of expected matrix columns.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ContentBeforeRow	Gets or sets HTML content to be rendered as additional content on the top of the matrix.
Public property	ContentBeforeRowCssClass	Gets or sets CSS class for content before rows.
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	ControlGUID	Unique ID of the control within the given request. (Inherited from CMSUserControl.)
Public property	CornerText	Text displayed in the upper left corner of UniMatrix, if filter is not shown.
Public property	CssClass	CSS class of the matrix control
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentResolver	Control's resolver (Inherited from CMSUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DefaultPageSize	Default page size at first load.
Public property	DisabledColumnMark	Mark HTML code for the disabled column in header.
Public property	DisabledRowMark	Mark HTML code for the disabled row in header.
Public property	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from CMSUserControl.)
Public property	Enabled	Gets or sets the enabled state of the control.
Public property	FilterLimit	Minimal count of entries for display filter.
Protected property	FilterWhere	Filter where condition.
Public property	FirstColumnClass	Sets or gets fixed width of first column.
Public property	HasData	Gets the value that indicates whether current matrix contains some data.
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IsCMSDesk	Determines whether the current control lies on the page that is currently located under the CMS Desk. (Inherited from CMSUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	ItemsPerPage	Default number of items per page.
Public property	ItemTooltipColumn	Tooltip column of the item.
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	NoRecordsMessage	Gets or sets the message which is displayed if there are no records.
Public property	OrderBy	Base order of the items for the query.
Public property	Pager	UniPager control of UniMatrix.
Public property	PagerDataItem	Pager data item object.
Public property	PagerForceNumberOfResults	Gets or sets the number of result. Enables proceed "fake" datasets, where number of results in the dataset is not correspondent to the real number of results This property must be equal -1 if should be disabled
Public property	PageSizeOptions	Page size options for pager. Numeric values or macro ##ALL## separated with comma.
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	QueryName	Query name to get the data.
Public property	QueryParameters	Query parameters to get the data.
Public property	RelativePath	Page relative path. (Inherited from CMSUserControl.)
Public property	ResourcePrefix	Prefix for the resource strings which will be used for the strings of the selector. Default is "General". (Overrides AbstractUserControl.ResourcePrefix.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	RowItemCodeNameColumn	Gets or sets the codename column name.
Public property	RowItemDisplayNameColumn	Display name column of the row.
Public property	RowItemIDColumn	ID column of the row.
Public property	RowItemTooltipColumn	Tooltip column of the row.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	ShowContentBeforeRow	Indicates if content before rows should be displayed.
Public property	ShowFilterRow	If true, the filter row is shown.
Public property	ShowHeaderRow	If true, the header row is shown.
Public property	SiteIDColumnName	Gets or sets the site id column name
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	TypeName	Returns the object type name. (Inherited from CMSUserControl.)
Public property	UIContext	Control's UI Context (Inherited from CMSUserControl.)
Public property	UniPagerControl	Pager control.
Public property	UseCMSDeskAccessDeniedPage	Gets or sets the value that indicates whether CMSDesk access denied page should be used. (Inherited from CMSUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)
Public property	WhereCondition	Base where condition for the query.

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method Static member	AddFillingCell<TCell>	Adds the filling cell to the table
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	DisableColumn	Disables column with specified index.
Public method	EnableColumn	Enables column with specified index.
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	GenerateMatrixBody	Generate body of the matrix.
Protected method	GenerateMatrixHeader	Generate header of the matrix.
Protected method	GetAccessDeniedPageUrl	Returns access denied page with dependence on current setting. (Inherited from CMSUserControl.)
Public method	GetCallbackResult	Gets the callback result.
Protected method	GetColumnIndexes	Gets an array of indexes which are sorted according to ColumnsPreferedOrder. i.e: Permission are "A","B","C" .. desired permission order is "C","A","B", then columnOrderIndex will be [2,0,1]
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Protected method	GetOrderByClause	Gets matrix order by clause
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Protected method	IsColumnEditable	Returns true if the given column is editable.
Protected method	IsRowEditable	Returns true if the given row is editable.
Protected method	LoadData	Load matrix data
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	OnLoad override, setup access denied page with dependence on current usage. (Inherited from CMSUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	RaiseCallbackEvent	Processes the callback event.
Protected method	RaiseGetRowItemCssClass	Raises the OnGetRowItemCssClass event.
Protected method	RaiseOnItemChanged	Raises the OnItemChanged event.
Protected method	RaiseOnPageBinding	Raises the page binding event
Public method	ReBind	Evokes control databind.
Public method	RedirectToAccessDenied(String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(Int32, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(String, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToUIElementAccessDenied	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
Public method	ReloadData	Reloads the control data.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SetContext	Sets the control context. (Inherited from CMSUserControl.)
Protected method	SetFilterWhere	Sets the filter where condition
Protected method	SetPageSize	Sets the page size
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

Extension Methods

	Name	Description
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	DataLoaded	Fires when the data is loaded
Public event	CheckColumnPermissions	Fires when column permissions are checked
Public event	CheckRowPermissions	Fires when row permissions are checked
Public event	OnGetRowItemCssClass	Fires when data are checked for additional CSS class to be rendered.
Public event	OnItemChanged	Fires when the item changed.
Public event	OnPageBinding	Occurs when the control bind data.
Public event	OnPageChanged	Occurs when the pager change the page and current mode is postback => reload data