HeaderActions Class

HeaderActions 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.HeaderActions

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 10.0.0

Syntax

public abstract class HeaderActions : AbstractUserControl

The HeaderActions type exposes the following members.

Constructors

	Name	Description
Protected method	HeaderActions

Fields

	Name	Description
Public field	ActionControlCreated	Event fired before and after every action control construction.
Public field Static member	TYPE_HYPERLINK	Hyper link button type
Public field Static member	TYPE_LINKBUTTON	Link button type
Public field Static member	TYPE_SAVEBUTTON	Save button type

Properties

	Name	Description
Public property	ActionsList	Gets or sets the list of actions
Protected property	ActionsPanel	Panel for actions.
Public property	AdditionalControls	Additional controls list
Public property	AdditionalControlsCssClass	Additional controls CSS class
Protected property	AdditionalControlsPanel	Panel for additional controls.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	Enabled	Indicates if control is enabled.
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	PanelCssClass	Gets or sets CssClass of the panel where all the actions are placed.
Public property	PerformFullPostBack	Indicates if the actions should perform full post-back
Protected property	ProcessedBaseButtons	List of processed base buttons
Public property	RenderContainer	Indicates if container should be rendered
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Protected property	ShortcutAction	Action that is connected with a keyboard shortcut.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	UpdatePanel	Update panel
Public property	UseBasicStyles	Indicates if basic styles should be used
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	UseSmallIcons	Indicates if small icons should be used for actions

Methods

	Name	Description
Public method	AddAction	Adds given action to the ActionsList.
Public method	AddActions	Adds the list of header actions to the ActionsList.
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	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	Clear	Clears content rendered by header actions control.
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.)
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.)
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	HasAnyVisibleAction	Indicates if the menu has any action to display.
Protected method	CheckPermissions	Returns true if user has permission for given resource. Returns true for empty resource name or permission.
Public method	InsertAction	Inserts action to the ActionsList at specified index.
Protected method	IsActionVisible	Indicates if given action can be added to the header.
Public method	IsVisible	Indicates if the menu has content to display.
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.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	RaiseActionPerformed	Raises the action performed event.
Public method	ReloadAdditionalControls	Reloads additional controls panel from the list AdditionalControls.
Public method	ReloadData	Reloads the action panel - creates actions from the ActionsList.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
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.)

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	ActionPerformed	Event which raises when LinkButton is used for action and its Command event raises.