Click or drag to resize
CMSPreviewControl Class
Abstract preview control class
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 10.0.0
Syntax
C#
public abstract class CMSPreviewControl : CMSAdminControl

The CMSPreviewControl type exposes the following members.

Constructors
  NameDescription
Protected methodCMSPreviewControl
Top
Fields
  NameDescription
Public fieldStatic memberCSSSTYLESHEET
Css stylesheet constant
Public fieldStatic memberDEVICELAYUOT
Device layout constant
Public fieldStatic memberMASTERPAGE
Maser page constant
Public fieldStatic memberPAGELAYOUT
Page layout constant
Public fieldStatic memberPAGETEMPLATELAYOUT
Page template layout constant
Public fieldStatic memberTHEME
Theme constant
Public fieldStatic memberTRANSFORMATION
Transformation constant
Public fieldStatic memberWEBPARTCONTAINER
Web part container constant
Public fieldStatic memberWEBPARTCSS
Web part css constant
Public fieldStatic memberWEBPARTLAYOUT
web part layout constant
Top
Properties
  NameDescription
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyControlGUID
Unique ID of the control within the given request.
(Inherited from CMSUserControl.)
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 propertyDefaultAliasPath
Default alias path for preview
Public propertyDefaultPreviewPath
If set this path is automatically used when first opened.
Public propertyDialogMode
Indicates whether page is in dialog mode
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDisplayTitlePane
If true title is added to toolbar in vertical position
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyErrorMessage
Error message.
(Inherited from CMSAdminControl.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIgnoreSessionValues
Indicates whether session values should be ignored when first load.
Public propertyInfoMessage
Information message.
(Inherited from CMSAdminControl.)
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsInPreview
If true, the control is shown in preview mode
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 propertyLoadSessionValues
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 propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Public propertyParentClientID
ClientID of parent wrapper element (pane content)
Public propertyPreviewInitialized
If true, preview was initialized
Public propertyPreviewObjectName
Object name, used for session key, under preview information is stored
Public propertyPreviewObjectPreferredDocument
Default preview settings for object
Public propertyPreviewURLSuffix
Part of URL parameters, added to preview iframe URL
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyRedirectToAccessDeniedPage
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.)
Public propertyRelativePath
Page relative path.
(Inherited from CMSUserControl.)
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowPreview
If true, preview can be shown.
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 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.)
Top
Methods
  NameDescription
Public methodAccessDenied(String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAccessDenied(Int32, String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
Public methodAccessDenied(String, String)
Ensure access denied actions due to settings.
(Inherited from CMSAdminControl.)
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 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 methodClearForm
Clears control.
(Inherited from CMSAdminControl.)
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 methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
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.)
Public methodGetPreviewStateFromCookies
Parse preview state from cookies and returns value based on given key
Protected methodGetPreviewURL
Returns url for preview, based on object type and parameters
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.)
Public methodCheckPermissions(String, String)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodCheckPermissions(String, String, Int32)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
Public methodCheckPermissions(String, String, String)
Check permissions for specified resource and permission type, return false is user doesn't have permissions.
(Inherited from CMSAdminControl.)
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 methodRaiseOnCheckPermissions(String, CMSAdminControl)
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.)
Public methodRaiseOnCheckPermissions(String, String, CMSAdminControl)
Raises the OnCheckPermissions event, returns true when event was fired.
(Inherited from CMSAdminControl.)
Public methodRaiseOnNotAllowed
Raises the OnNotAllowed event.
(Inherited from CMSAdminControl.)
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 methodRegisterInitScripts
Register initialization scripts
Protected methodRegisterRefreshScript
Registers script for refresh preview
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Public methodReloadData
Reloads control data without force reload.
(Inherited from CMSAdminControl.)
Public methodReloadData(Boolean)
Reloads control data.
(Inherited from CMSAdminControl.)
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.)
Public methodSetPreviewStateToCookies
Insert (or replace) new preview state value based on given key
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 methodStoreNewPreferredDocument
Save new preview document settings
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 eventOnCheckPermissions
On check permissions event.
(Inherited from CMSAdminControl.)
Public eventOnCheckPermissionsExtended
On check permissions event.
(Inherited from CMSAdminControl.)
Public eventOnNotAllowed
On not allowed event.
(Inherited from CMSAdminControl.)
Top
See Also