Click or drag to resize
ExternalEditControl Class
Base class for controls which provide external edit action
Inheritance Hierarchy

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

The ExternalEditControl type exposes the following members.

Constructors
  NameDescription
Protected methodExternalEditControl
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.)
Protected methodDisableButton
Performs actions necessary for disabling button.
Protected methodDisableButton(String)
Disables the button with the given error message
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.)
Protected methodGetEditScript
Gets the editing action script
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 methodGetString
Returns localized string.
(Inherited from AbstractUserControl.)
Protected methodGetUrl
Gets the URL of file for editing.
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 methodCheckEnable
Checks whether the button should be enabled or not.
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 methodInitFrom
Initializes edit control.
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
Control PreRender event.
(Overrides AbstractUserControlOnPreRender(EventArgs).)
Protected methodProcessRefreshScript
Check if the refresh script should be processed.
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 methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Public methodReloadData
Reloads control data without force reload.
(Inherited from CMSAdminControl.)
Public methodReloadData(Boolean)
Reload controls data.
(Overrides CMSAdminControlReloadData(Boolean).)
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 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 MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldbtnEdit
Edit icon
Protected fieldlblEdit
Edit label
Protected fieldmAccessDeniedPage
Access denied page
(Inherited from CMSUserControl.)
Protected fieldmCMSDeskAccessDeniedPage
CMSDesk access denied page
(Inherited from CMSUserControl.)
Protected fieldmControlContext
Control context
(Inherited from CMSUserControl.)
Protected fieldmControlGUID
Control GUID
(Inherited from CMSUserControl.)
Protected fieldmControlType
WbDav control type.
Protected fieldmDisplayMode
Display mode
(Inherited from CMSUserControl.)
Protected fieldmErrorMessage
Error message.
(Inherited from CMSAdminControl.)
Protected fieldmInfoMessage
Information message.
(Inherited from CMSAdminControl.)
Protected fieldmRedirectToAccessDeniedPage
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.)
Protected fieldmRelativePath
Relative path
(Inherited from CMSUserControl.)
Protected fieldmUseCMSDeskAccessDeniedPage
Indicates whether CMSDesk access denied page should be used
(Inherited from CMSUserControl.)
Protected fieldmViewStateTracked
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.)
Protected fieldproperties
Control properties.
(Inherited from InlineUserControl.)
Top
Properties
  NameDescription
Public propertyAccessDeniedPage
Access denied page URL.
(Inherited from CMSAdminControl.)
Public propertyAttachmentFieldName
Gets or sets attachment field name.
Protected propertyCompleteCssClass
Gets CSS class for icon consisting of CssClass and icon related classes.
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 propertyControlType
Gets type of control (attachment, media, metafile...).
Public propertyCssClass
Gets or sets the CSS class.
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 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 AbstractUserControl.)
Public propertyEnabled
Gets or sets state enable.
Public propertyEnabledResult
Returns TRUE if the icon is enabled.
Public propertyErrorMessage
Error message.
(Inherited from CMSAdminControl.)
Public propertyFileName
Gets or sets the name of file for editing.
Public propertyFormID
Client ID of the parent form.
Public propertyGroupID
Gets or sets Group ID.
Protected propertyGroupInfo
Gets group info.
Public propertyGroupName
Gets or sets the name of community group name.
Protected propertyGroupNode
Group parent node.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyCheckPermission
Indicates if the permissions should be checked.
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 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 propertyLabelCssClass
Gets or sets the css class of caption label.
Public propertyLabelText
Gets or sets the text of a caption label. If empty, no caption is rendered.
Public propertyMediaFileLibraryID
Gets or sets media library ID.
Public propertyMediaFilePath
Gets or sets media file path.
Protected propertyMediaLibraryInfo
Gets media library info.
Public propertyMediaLibraryName
Gets or sets media library name.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyMetaFileGUID
Gets or sets the GUID of meta file for editing.
Public propertyNodeAliasPath
Gets or sets node alias path.
Public propertyNodeCultureCode
Gets or sets document culture.
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Public propertyPerformFullPostback
Determines whether control should perform full postback.
Public propertyRedirectToAccessDeniedPage
Redirect to access denied if the access is not allowed.
(Inherited from CMSAdminControl.)
Public propertyRefreshScript
Gets or sets refresh script.
Public propertyRelativePath
Page relative path.
(Inherited from CMSUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Protected propertySiteInfo
Gets site info.
Public propertySiteName
Gets or sets site name.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Protected propertyTreeNode
Gets document.
Protected propertyTreeProvider
Gets tree provider.
Public propertyTypeName
Returns the object type name.
(Inherited from CMSUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
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.)
Protected propertyWorkflowInfo
Gets workflow info.
Protected propertyWorkflowManager
Gets workflow manager.
Protected propertyWorkflowScopeInfo
Gets node workflow scope.
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