ContentMediaView Class

Base class for content media view control

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.MediaView
                CMS.UIControls.ContentMediaView

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

Syntax

public abstract class ContentMediaView : MediaView

The ContentMediaView type exposes the following members.

Constructors

	Name	Description
Protected method	ContentMediaView

Fields

	Name	Description
Public field	OnAction	Event fired when some action takes place. (Inherited from MediaView.)

Properties

	Name	Description
Public property	AttachmentNodeParentID	Gets or sets ID of the parent node.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	Config	Gets current dialog configuration. (Inherited from MediaView.)
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	CurrentOffset	Gets currently selected page size.
Public property	CurrentPage	Gets or sets currently selected page.
Public property	CurrentPageSize	Gets currently selected page size.
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	DataSource	Data source which is set to the inner view control. (Inherited from MediaView.)
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 CMSUserControl.)
Public property	FolderPath	Path to the displayed media folder (Inherited from MediaView.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	InfoText	Gets or sets text of the information label.
Public property	InnerMediaControl	Inner media view control
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	IsFullListingMode	Indicates whether the content tree is displaying more than max tree nodes.
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	ListViewControl	Gets a UniGrid control used to display files in LIST view mode.
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	OutputFormat	Gets or sets the OutputFormat (needed for correct dialog type reckognition).
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	ResizeToHeight	Height of attachment. (Inherited from MediaView.)
Public property	ResizeToMaxSideSize	Max side size of attachment. (Inherited from MediaView.)
Public property	ResizeToWidth	Width of attachment. (Inherited from MediaView.)
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	SelectableContent	Type of the content which can be selected. (Inherited from MediaView.)
Public property	SelectedItem	Selected item. (Inherited from MediaView.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	SiteObj	Gets the site attachments are related to.
Public property	SourceType	Type of the files which are displayed. (Inherited from MediaView.)
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	TotalRecords	Sets or gets total records count. (Inherited from MediaView.)
Public property	TreeNodeObj	Gets the node attachments are related to.
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	UsePermanentUrls	Indicates whether permanent URLs should be used for the currently processed file type. (Inherited from MediaView.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	ViewMode	Gets or sets a view mode used to display files. (Overrides MediaView.ViewMode.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)

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	AddURLDimensionsAndResolve	Returns URL, resolved if not in media selector, with size parameters added.
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	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	GetArgumentSet	Returns argument set for the passed file data row.
Public method Static member	GetArgumentsTable	Returns arguments table for the passed argument.
Public method	GetAttachmentItemUrl	Returns URL for the attachment specified by arguments.
Public method	GetContentItemUrl	Creates URL for node. If node belongs to current site, a relative URL is returned. Otherwise, an absolute URL returned.
Protected method	GetCurrentSiteId	Returns current site ID respecting link document option. (Inherited from MediaView.)
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	GetItemUrl	Returns URL of the media item according site settings.
Public method	GetMetaFileItemUrl	Returns URL for the metafile specified by arguments.
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.)
Protected method	InitializeControlScripts	Initializes scripts used by the control.
Protected method	InnerMedia_GetArgumentSet	Returns argument set according passed DataRow and flag indicating whether the set is obtained for selected item.
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	Initialize control (Overrides AbstractUserControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	PageSizeDropDownList_SelectedIndexChanged	Reloads data when page size changed in thumbnails view mode.
Public method	RaiseListReloadRequired	Raised when list view reload is required. (Inherited from MediaView.)
Public method	RaiseOnAction	Raised when specified action occurs. (Inherited from MediaView.)
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.)
Protected method	SetupControls	Initializes all nested controls.
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	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	ListReloadRequired	Event fired when UniGrid's page changed. (Inherited from MediaView.)