Click or drag to resize
UniMatrix Class
UniMatrix base class.
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 10.0.0
Syntax
C#
public abstract class UniMatrix : CMSUserControl, 
	ICallbackEventHandler, IUniPageable

The UniMatrix type exposes the following members.

Constructors
  NameDescription
Protected methodUniMatrix
Top
Fields
  NameDescription
Protected fielddisabledColumns
List of columns which are disabled
Protected fieldds
DataSet with the content
Protected fieldmLoaded
Indicates if the content was already loaded or not
Protected fieldmTotalRows
Total number of rows
Top
Properties
  NameDescription
Public propertyAddFillingColumn
If true, the filling column is added to the table to move columns to the left
Public propertyAddGlobalObjectSuffix
Gets or sets the value that indicates whether '(global)' suffix should be added to the global objects
Public propertyColumnItemDisplayNameColumn
Display name column of the column.
Public propertyColumnItemIDColumn
ID column of the column.
Public propertyColumnItemTooltipColumn
Tooltip column of the column.
Public propertyColumnOrderIndex
Gets order in which data will be rendered.
Public propertyColumnsCount
Number of expected matrix columns.
Public propertyColumnsPreferedOrder
Number of expected matrix columns.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContentBeforeRow
Gets or sets HTML content to be rendered as additional content on the top of the matrix.
Public propertyContentBeforeRowCssClass
Gets or sets CSS class for content before rows.
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyControlGUID
Unique ID of the control within the given request.
(Inherited from CMSUserControl.)
Public propertyCornerText
Text displayed in the upper left corner of UniMatrix, if filter is not shown.
Public propertyCssClass
CSS class of the matrix control
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDefaultPageSize
Default page size at first load.
Public propertyDisabledColumnMark
Mark HTML code for the disabled column in header.
Public propertyDisabledRowMark
Mark HTML code for the disabled row in header.
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyEnabled
Gets or sets the enabled state of the control.
Public propertyFilterLimit
Minimal count of entries for display filter.
Protected propertyFilterWhere
Filter where condition.
Public propertyFirstColumnClass
Sets or gets fixed width of first column.
Public propertyHasData
Gets the value that indicates whether current matrix contains some data.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyItemsPerPage
Default number of items per page.
Public propertyItemTooltipColumn
Tooltip column of the item.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNoRecordsMessage
Gets or sets the message which is displayed if there are no records.
Public propertyOrderBy
Base order of the items for the query.
Public propertyPager
UniPager control of UniMatrix.
Public propertyPagerDataItem
Pager data item object.
Public propertyPagerForceNumberOfResults
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 propertyPageSizeOptions
Page size options for pager. Numeric values or macro ##ALL## separated with comma.
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyQueryName
Query name to get the data.
Public propertyQueryParameters
Query parameters to get the data.
Public propertyRelativePath
Page relative path.
(Inherited from CMSUserControl.)
Public propertyResourcePrefix
Prefix for the resource strings which will be used for the strings of the selector. Default is "General".
(Overrides AbstractUserControlResourcePrefix.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyRowItemCodeNameColumn
Gets or sets the codename column name.
Public propertyRowItemDisplayNameColumn
Display name column of the row.
Public propertyRowItemIDColumn
ID column of the row.
Public propertyRowItemTooltipColumn
Tooltip column of the row.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowContentBeforeRow
Indicates if content before rows should be displayed.
Public propertyShowFilterRow
If true, the filter row is shown.
Public propertyShowHeaderRow
If true, the header row is shown.
Public propertySiteIDColumnName
Gets or sets the site id column name
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTypeName
Returns the object type name.
(Inherited from CMSUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from CMSUserControl.)
Public propertyUniPagerControl
Pager control.
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWhereCondition
Base where condition for the query.
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodStatic memberAddFillingCellTCell
Adds the filling cell to the table
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodDisableColumn
Disables column with specified index.
Public methodEnableColumn
Enables column with specified index.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodGenerateMatrixBody
Generate body of the matrix.
Protected methodGenerateMatrixHeader
Generate header of the matrix.
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
Public methodGetCallbackResult
Gets the callback result.
Protected methodGetColumnIndexes
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 methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Protected methodGetOrderByClause
Gets matrix order by clause
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Protected methodIsColumnEditable
Returns true if the given column is editable.
Protected methodIsRowEditable
Returns true if the given row is editable.
Protected methodLoadData
Load matrix data
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
OnLoad override, setup access denied page with dependence on current usage.
(Inherited from CMSUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodRaiseCallbackEvent
Processes the callback event.
Protected methodRaiseGetRowItemCssClass
Raises the OnGetRowItemCssClass event.
Protected methodRaiseOnItemChanged
Raises the OnItemChanged event.
Protected methodRaiseOnPageBinding
Raises the page binding event
Public methodReBind
Evokes control databind.
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Public methodReloadData
Reloads the control data.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetContext
Sets the control context.
(Inherited from CMSUserControl.)
Protected methodSetFilterWhere
Sets the filter where condition
Protected methodSetPageSize
Sets the page size
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventDataLoaded
Fires when the data is loaded
Public eventCheckColumnPermissions
Fires when column permissions are checked
Public eventCheckRowPermissions
Fires when row permissions are checked
Public eventOnGetRowItemCssClass
Fires when data are checked for additional CSS class to be rendered.
Public eventOnItemChanged
Fires when the item changed.
Public eventOnPageBinding
Occurs when the control bind data.
Public eventOnPageChanged
Occurs when the pager change the page and current mode is postback => reload data
Top
See Also