UniGridActions Class

UniGrid actions definition.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataBoundControl
        System.Web.UI.WebControls.DataBoundControl
          CMS.UIControls.UniGridConfig.AbstractConfiguration
            CMS.UIControls.UniGridConfig.UniGridActions

Namespace: CMS.UIControls.UniGridConfig
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0

Syntax

public class UniGridActions : AbstractConfiguration

The UniGridActions type exposes the following members.

Constructors

	Name	Description
Public method	UniGridActions()	Empty constructor.
Public method	UniGridActions(XElement)	Constructor.

Properties

	Name	Description
Public property	Actions	List of the actions.
Public property	Caption	Specifies the resource string used as the tooltip of the context menu arrow icon. Must begin and end with the $ character. Sample value: "$General.Delete$"
Public property	ContextMenu	The relative path to a control (.ascx file) that implements a context menu for the action column of header. Controls created for this purpose must inherit from the CMS.Base.Web.UI.CMSContextMenuControl class. Sample value: "~/CMSAdminControls/UI/UniGrid/Controls/ObjectMenu.ascx"
Public property	CssClass	Specifies the name of the CSS class from the stylesheet to be used for the actions column.
Public property	Parameters	A list of columns used as parameters in the onclick or menuparameter attributes of child action elements separated by semicolons. Sample value: "AttachmentGUID;AttachmentFormGUID"
Public property	ShowHeader	Indicates whether the header of the actions column should be displayed. The default value is true.
Public property	Width	Determines the width of the actions column in the UniGrid. Sample values: "30%", "100px"

Methods

	Name	Description
Public method	GetAction	Obsolete. Returns UniGrid action with specified name.
Public method	GetActionByName	Returns UniGrid action with specified name.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
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	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)