CMSPreviewControl Class

Abstract preview control 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.CMSAdminControl
                CMS.UIControls.CMSPreviewControl

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

Syntax

public abstract class CMSPreviewControl : CMSAdminControl

The CMSPreviewControl type exposes the following members.

Constructors

	Name	Description
Protected method	CMSPreviewControl

Fields

	Name	Description
Public field Static member	CSSSTYLESHEET	Css stylesheet constant
Public field Static member	DEVICELAYUOT	Device layout constant
Public field Static member	MASTERPAGE	Maser page constant
Public field Static member	PAGELAYOUT	Page layout constant
Public field Static member	PAGETEMPLATELAYOUT	Page template layout constant
Public field Static member	THEME	Theme constant
Public field Static member	TRANSFORMATION	Transformation constant
Public field Static member	WEBPARTCONTAINER	Web part container constant
Public field Static member	WEBPARTCSS	Web part css constant
Public field Static member	WEBPARTLAYOUT	web part layout constant

Properties

	Name	Description
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
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	DefaultAliasPath	Default alias path for preview
Public property	DefaultPreviewPath	If set this path is automatically used when first opened.
Public property	DialogMode	Indicates whether page is in dialog mode
Public property	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DisplayTitlePane	If true title is added to toolbar in vertical position
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from CMSUserControl.)
Public property	ErrorMessage	Error message. (Inherited from CMSAdminControl.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IgnoreSessionValues	Indicates whether session values should be ignored when first load.
Public property	InfoMessage	Information message. (Inherited from CMSAdminControl.)
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	IsInPreview	If true, the control is shown in preview mode
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	LoadSessionValues	Indicates whether session values should be ignored. This is used when edited in dialog (or special cases) mode to read actual aliaspath and culture.
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Public property	ParentClientID	ClientID of parent wrapper element (pane content)
Public property	PreviewInitialized	If true, preview was initialized
Public property	PreviewObjectName	Object name, used for session key, under preview information is stored
Public property	PreviewObjectPreferredDocument	Default preview settings for object
Public property	PreviewURLSuffix	Part of URL parameters, added to preview iframe URL
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	RedirectToAccessDeniedPage	Redirect to access denied if the access is not allowed. (Inherited from CMSAdminControl.)
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.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	ShowPreview	If true, preview can be shown.
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	UIContext	Control's UI Context (Inherited from CMSUserControl.)
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.)

Methods

	Name	Description
Public method	AccessDenied(String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AccessDenied(Int32, String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
Public method	AccessDenied(String, String)	Ensure access denied actions due to settings. (Inherited from CMSAdminControl.)
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	CheckPermissions(String, String)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	CheckPermissions(String, String, Int32)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	CheckPermissions(String, String, String)	Check permissions for specified resource and permission type, return false is user doesn't have permissions. (Inherited from CMSAdminControl.)
Public method	ClearForm	Clears control. (Inherited from CMSAdminControl.)
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	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (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	GetAccessDeniedPageUrl	Returns access denied page with dependence on current setting. (Inherited from CMSUserControl.)
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	GetPreviewStateFromCookies	Parse preview state from cookies and returns value based on given key
Protected method	GetPreviewURL	Returns url for preview, based on object type and parameters
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.)
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	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	RaiseOnCheckPermissions(String, CMSAdminControl)	Raises the OnCheckPermissions event, returns true when event was fired. (Inherited from CMSAdminControl.)
Public method	RaiseOnCheckPermissions(String, String, CMSAdminControl)	Raises the OnCheckPermissions event, returns true when event was fired. (Inherited from CMSAdminControl.)
Public method	RaiseOnNotAllowed	Raises the OnNotAllowed event. (Inherited from CMSAdminControl.)
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	RegisterInitScripts	Register initialization scripts
Protected method	RegisterRefreshScript	Registers script for refresh preview
Public method	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
Public method	ReloadData()	Reloads control data without force reload. (Inherited from CMSAdminControl.)
Public method	ReloadData(Boolean)	Reloads control data. (Inherited from CMSAdminControl.)
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.)
Public method	SetPreviewStateToCookies	Insert (or replace) new preview state value based on given key
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (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	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	StoreNewPreferredDocument	Save new preview document settings
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	OnCheckPermissions	On check permissions event. (Inherited from CMSAdminControl.)
Public event	OnCheckPermissionsExtended	On check permissions event. (Inherited from CMSAdminControl.)
Public event	OnNotAllowed	On not allowed event. (Inherited from CMSAdminControl.)