UniMatrix Class |
Namespace: CMS.UIControls
public abstract class UniMatrix : CMSUserControl, ICallbackEventHandler, IUniPageable
The UniMatrix type exposes the following members.
Name | Description | |
---|---|---|
disabledColumns |
List of columns which are disabled
| |
ds |
DataSet with the content
| |
mLoaded |
Indicates if the content was already loaded or not
| |
mTotalRows |
Total number of rows
|
Name | Description | |
---|---|---|
AddFillingColumn |
If true, the filling column is added to the table to move columns to the left
| |
AddGlobalObjectSuffix |
Gets or sets the value that indicates whether '(global)' suffix should be added to the global objects
| |
ColumnItemDisplayNameColumn |
Display name column of the column.
| |
ColumnItemIDColumn |
ID column of the column.
| |
ColumnItemTooltipColumn |
Tooltip column of the column.
| |
ColumnOrderIndex |
Gets order in which data will be rendered.
| |
ColumnsCount |
Number of expected matrix columns.
| |
ColumnsPreferedOrder |
Number of expected matrix columns.
| |
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
ContentBeforeRow |
Gets or sets HTML content to be rendered as additional content on the top of the matrix.
| |
ContentBeforeRowCssClass |
Gets or sets CSS class for content before rows.
| |
ControlContext |
Control context.
(Inherited from CMSUserControl.) | |
CornerText |
Text displayed in the upper left corner of UniMatrix, if filter is not shown.
| |
CssClass |
CSS class of the matrix control
| |
CurrentDocument |
Current document
(Inherited from AbstractUserControl.) | |
CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) | |
CurrentResolver |
Control's resolver
(Inherited from CMSUserControl.) | |
CurrentSite |
Current site
(Inherited from AbstractUserControl.) | |
CurrentUser |
Current user
(Inherited from AbstractUserControl.) | |
DefaultPageSize |
Default page size at first load.
| |
DisabledColumnMark |
Mark HTML code for the disabled column in header.
| |
DisabledRowMark |
Mark HTML code for the disabled row in header.
| |
DisplayMode |
Gets or sets display mode of the control.
(Inherited from CMSUserControl.) | |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditedObject |
Control's edited object
(Inherited from CMSUserControl.) | |
Enabled |
Gets or sets the enabled state of the control.
| |
FilterLimit |
Minimal count of entries for display filter.
| |
FilterWhere |
Filter where condition.
| |
FirstColumnClass |
Sets or gets fixed width of first column.
| |
HasData |
Gets the value that indicates whether current matrix contains some data.
| |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
IsCMSDesk |
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
ItemsPerPage |
Default number of items per page.
| |
ItemTooltipColumn |
Tooltip column of the item.
| |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
NoRecordsMessage |
Gets or sets the message which is displayed if there are no records.
| |
OrderBy |
Base order of the items for the query.
| |
Pager |
UniPager control of UniMatrix.
| |
PagerDataItem |
Pager data item object.
| |
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
| |
PageSizeOptions |
Page size options for pager.
Numeric values or macro ##ALL## separated with comma.
| |
Parameter |
Control parameter.
(Inherited from InlineUserControl.) | |
Properties |
Control properties.
(Inherited from InlineUserControl.) | |
QueryName |
Query name to get the data.
| |
QueryParameters |
Query parameters to get the data.
| |
ResourcePrefix |
Prefix for the resource strings which will be used for the strings of the selector.
Default is "General".
(Overrides AbstractUserControlResourcePrefix.) | |
ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) | |
RowItemCodeNameColumn |
Gets or sets the codename column name.
| |
RowItemDisplayNameColumn |
Display name column of the row.
| |
RowItemIDColumn |
ID column of the row.
| |
RowItemTooltipColumn |
Tooltip column of the row.
| |
ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) | |
ShowContentBeforeRow |
Indicates if content before rows should be displayed.
| |
ShowFilterRow |
If true, the filter row is shown.
| |
ShowHeaderRow |
If true, the header row is shown.
| |
SiteIDColumnName |
Gets or sets the site id column name
| |
StopProcessing |
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.) | |
UIContext |
Control's UI Context
(Inherited from CMSUserControl.) | |
UniPagerControl |
Pager control.
| |
UseCMSDeskAccessDeniedPage |
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.) | |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) | |
WhereCondition |
Base where condition for the query.
|
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddFillingCellTCell |
Adds the filling cell to the table
| |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
DisableColumn |
Disables column with specified index.
| |
EnableColumn |
Enables column with specified index.
| |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) | |
EvalDecimal |
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.) | |
EvalDouble |
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) | |
EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) | |
EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
GenerateMatrixBody |
Generate body of the matrix.
| |
GenerateMatrixHeader |
Generate header of the matrix.
| |
GetAccessDeniedPageUrl |
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.) | |
GetCallbackResult |
Gets the callback result.
| |
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]
| |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetOrderByClause |
Gets matrix order by clause
| |
GetString |
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
GetValueReturnType(String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
IsColumnEditable |
Returns true if the given column is editable.
| |
IsRowEditable |
Returns true if the given row is editable.
| |
LoadData |
Load matrix data
| |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnInit |
Init event handler.
(Inherited from AbstractUserControl.) | |
OnLoad |
Load event handler.
(Inherited from AbstractUserControl.) | |
OnPreRender |
PreRender event handler.
(Inherited from AbstractUserControl.) | |
RaiseCallbackEvent |
Processes the callback event.
| |
RaiseGetRowItemCssClass |
Raises the OnGetRowItemCssClass event.
| |
RaiseOnItemChanged |
Raises the OnItemChanged event.
| |
RaiseOnPageBinding |
Raises the page binding event
| |
ReBind |
Evokes control databind.
| |
RedirectToAccessDenied(String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(Int32, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(String, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToUIElementAccessDenied |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSUserControl.) | |
ReloadData |
Reloads the control data.
| |
Render |
Render event handler.
(Inherited from AbstractUserControl.) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) | |
SetContext |
Sets the control context.
(Inherited from CMSUserControl.) | |
SetFilterWhere |
Sets the filter where condition
| |
SetPageSize |
Sets the page size
| |
SetValue |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) |
Name | Description | |
---|---|---|
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.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |
Name | Description | |
---|---|---|
CheckColumnPermissions |
Fires when column permissions are checked
| |
CheckRowPermissions |
Fires when row permissions are checked
| |
DataLoaded |
Fires when the data is loaded
| |
OnGetRowItemCssClass |
Fires when data are checked for additional CSS class to be rendered.
| |
OnItemChanged |
Fires when the item changed.
| |
OnPageBinding |
Occurs when the control bind data.
| |
OnPageChanged |
Occurs when the pager change the page and current mode is postback => reload data
|