ImageSelector Class

Image selection dialog.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.DocumentEngine.Web.UI.ImageSelector

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class ImageSelector : WebControl, 
	INamingContainer, ICallbackEventHandler, IDialogControl

The ImageSelector type exposes the following members.

Constructors

	Name	Description
Public method	ImageSelector()	Constructor.
Public method	ImageSelector(String)	Constructor with default image path.
Public method	ImageSelector(String, Boolean)	Constructor with default image path.

Fields

	Name	Description
Protected field	mBtnClearPath	Clear path button.
Protected field	mBtnSelectImage	Select image button.
Protected field	mHidAlt	Hidden alternate text
Protected field	mHidDefaultValue	Hidden default value field.
Protected field	mHidFullUrl	Hidden Full URL.
Protected field	mHidPreviewUrl	Hidden preview URL.
Protected field	mHidValue	Hidden value field.
Protected field	mImgImagePreview	Preview image.
Protected field	mLtlScript	Script literal.
Protected field	mPnlHeader	Header panel.
Protected field	mPnlSelector	Selector panel.
Protected field	mTxtImagePath	Image path field.

Properties

	Name	Description
Public property	AlternateText	Gets or sets the alternate text value for the image
Public property	ClearPathButton	Clear path button.
Public property	Culture	Interface culture of the control.
Public property	DefaultValue	Default value.
Public property	DialogConfig	Configuration of the dialog for inserting Images.
Public property	Enabled	Enabled. (Overrides WebControl.Enabled.)
Public property	EnableOpenInFull	Enable open in full size behavior.
Public property	ImageCssClass	CSS class of the image preview.
Public property	ImageHeight	Height of the image preview.
Public property	ImageMaxSideSize	Image max side size.
Public property	ImagePathTextBox	Image path textbox.
Public property	ImagePreviewControl	Image preview control.
Public property	ImageStyle	CSS style of the image preview.
Public property	ImageWidth	Width of the image preview.
Public property	IsLiveSite	Indicates if control is used in live site mode.
Public property	SelectImageButton	Button invoking the image selection dialog.
Public property	ShowClearButton	Indicates if the Clear button should be displayed.
Public property	ShowImagePreview	Indicates if the image preview be displayed.
Public property	ShowTextBox	Indicates if the path textbox should be displayed.
Protected property	TagKey	Overrides the generation of the SPAN tag with custom tag. (Overrides WebControl.TagKey.)
Public property	UseImagePath	Indicates whether image path (TRUE) or path with node guid (FALSE) should be returned to the textbox field.
Public property	Value	Selector value: UseImagePath is set to FALSE -> selector value is Node GUID, UseImagePath is set to TRUE -> selector value is file path.

Methods

	Name	Description
Protected method	CreateChildControls	Renders the control at run-time. (Overrides Control.CreateChildControls().)
Public method	GetCallbackResult	Prepares the callback result.
Protected method	InitControls	Initializes controls.
Protected method	LoadDisplayValues	Returns the display text for the given selector value.
Protected method	OnLoad	Load event handler. (Overrides Control.OnLoad(EventArgs).)
Public method	RaiseCallbackEvent	Raises the callback event.
Protected method	Render	Renders the control at design-time. (Overrides WebControl.Render(HtmlTextWriter).)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
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	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)