CMSAbstractNewDocumentControl Class

NewDocumentControl abstract class

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          CMS.ExtendedControls.InlineUserControl
            CMS.UIControls.CMSUserControl
              CMS.UIControls.CMSAbstractNewDocumentControl

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

Syntax

public abstract class CMSAbstractNewDocumentControl : CMSUserControl

The CMSAbstractNewDocumentControl type exposes the following members.

Constructors

	Name	Description
Public method	CMSAbstractNewDocumentControl	Constructor

Methods

	Name	Description
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	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.)
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	GetLinkDialogUrl	Returns Correct URL of the copy or move dialog.
Public method	GetSelectionUrl	Gets the selected item URL
Public method	GetString	Returns localized string. (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 (Overrides CMSUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
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	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
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	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
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.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mAccessDeniedPage	Access denied page (Inherited from CMSUserControl.)
Protected field	mCMSDeskAccessDeniedPage	CMSDesk access denied page (Inherited from CMSUserControl.)
Protected field	mControlContext	Control context (Inherited from CMSUserControl.)
Protected field	mControlGUID	Control GUID (Inherited from CMSUserControl.)
Protected field	mDisplayMode	Display mode (Inherited from CMSUserControl.)
Protected field	mRelativePath	Relative path (Inherited from CMSUserControl.)
Protected field	mUseCMSDeskAccessDeniedPage	Indicates whether CMSDesk access denied page should be used (Inherited from CMSUserControl.)
Protected field	mViewStateTracked	If true, the ViewState has been already tracked. (Inherited from InlineUserControl.)
Protected field	properties	Control properties. (Inherited from InlineUserControl.)

Properties

	Name	Description
Public property	AllowNewABTest	Indicates whether 'New AB test page variant' may be offered.
Public property	AllowNewLink	Indicates whether 'Link an existing document' may be offered.
Public property	Caption	Title text.
Public property	ClientTypeClick	Script called when user selects a document type.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	ControlGUID	Unique ID of the control within the given request. (Inherited from CMSUserControl.)
Public property	ConvertDocumentID	Document ID to convert, if set, the selection is used for conversion of the document type
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	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from AbstractUserControl.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	HeadingLevel	Gets and sets title level. By default set to 4, i.e. generates h4.
Public property	IsCMSDesk	Determines whether the current control lies on the page that is currently located under the CMS Desk. (Inherited from CMSUserControl.)
Protected property	IsInDialog	Gets the value that indicates whether current control is in dialog page
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	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	NewVariantUrl	URL to redirect to when selecting 'New A/B test page variant'.
Public property	NoDataAsError	Indicates whether "No data" message is to be displayed as error.
Public property	NoDataMessage	Message to be displayed when no applicable document type found.
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Public property	ParentCulture	Culture of the parent TreeNode which will be used for new document.
Public property	ParentNode	TreeNode which the document types will be offered for.
Public property	ParentNodeID	ID of the TreeNode which the document types will be offered for.
Public property	ProductSelectionUrl	Selection link URL for product document types.
Public property	RedirectWhenNoChoice	Control automatically selects document type, when there are no other options (+ 'new A/B test' and 'new linked document' links are disabled).
Public property	RelativePath	Page relative path. (Inherited from CMSUserControl.)
Public property	SelectedItemID	Gets or sets the selected item ID
Public property	SelectionUrl	Selection link URL.
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	Tree	TreeProvider object to be used for nodes handling.
Public property	TypeName	Returns the object type name. (Inherited from CMSUserControl.)
Public property	UIContext	Control's UI Context (Inherited from AbstractUserControl.)
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.)
Public property	Where	Where condition used to restrict listed document types.