MacroEditor Class

Macro editor control

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.PlaceHolder
      CMS.Base.Web.UI.CMSPlaceHolder
        CMS.UIControls.MacroEditor

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

Syntax

public class MacroEditor : CMSPlaceHolder, 
	ICallbackEventHandler

The MacroEditor type exposes the following members.

Constructors

	Name	Description
Public method	MacroEditor

Properties

	Name	Description
Protected property	ASCXResolver	Gets or sets context resolver used for getting autocomplete options in ASCX Mode.
Public property	ASCXRootObject	Gets or sets the root object the fields of which will be used as root help in ASCX mode.
Public property	AutoCompletionObject	Gets the name of java script object of the auto completion extender.
Public property	Editor	Gets the editor control.
Public property	EditorFocusLostScript	Gets or sets the code which is executed when editor lost focus.
Public property	Enabled	Gets or sets a value indicating whether the Web server control is enabled.
Public property	Height	Gets or sets the height of the editor
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSPlaceHolder.)
Public property	LeftOffset	Gets or sets the left offset of the autocomplete control (to pos it correctly).
Public property	MixedMode	Indicates whether the editor is in pure currentText editing mode (whole currentText is considered as currentText) or mixed mode, where auto completion is fired only inside {%%} environment.
Public property	NamespaceUsings	Gets or sets the list of currentText namespaces for which the methods are permanently available (visible in AutoCompletion without any context). The namespaces are used only for root hints
Protected property Static member	PredefinedSnippets	Gets the list of predefined snippets.
Public property	ReadOnly	Gets or sets whether the control is read only
Public property	Resolver	Gets or sets context resolver used for getting autocomplete options.
Public property	ResolverName	Gets or sets the name of the resolver to use. This property is used if Resolver property is not explicitly set.
Public property	ShortID	Short ID of the control. (Inherited from CMSPlaceHolder.)
Public property	ShowAutoCompletionAbove	If true, tree is shown above the editor, otherwise it is below (default pos is below).
Public property	ShowOnlyInnerSources	If true, no global objects are shown, only inner sources (named data sources, etc.) are shown as hints.
Public property	SingleLineMode	Determines whether the editor is in single line mode (i.e. only one line of text can be edited).
Public property	SyntaxHighlightingEnabled	Gets if syntax highlighting is enabled for this control.
Public property	Text	Gets or sets the editor currentText.
Public property	TopOffset	Gets or sets the top offset of the autocomplete control (to pos it correctly).
Public property	UseAutoComplete	Indicates whether the autocompletion feature is enabled or not.
Public property	Width	Gets or sets the width of the editor

Methods

	Name	Description
Public method	Append(String[])	Appends the given content to the placeholder (Inherited from CMSPlaceHolder.)
Public method	Append(Control)	Appends the given control to the placeholder (Inherited from CMSPlaceHolder.)
Public method	Clear	Clears the placeholder content (Inherited from CMSPlaceHolder.)
Protected method	CreateChildControls	Creates inner controls (Overrides Control.CreateChildControls().)
Protected method	FinishCurrent	Appends the given content to the placeholder (Inherited from CMSPlaceHolder.)
Public method	GetCallbackResult	Gets the callback result
Protected method	OnInit	Init event handler. (Inherited from CMSPlaceHolder.)
Protected method	OnPreRender	PreRender event handler (Overrides CMSPlaceHolder.OnPreRender(EventArgs).)
Public method	RaiseCallbackEvent	Processes the callback
Protected method	Render	Render event handler (Overrides Control.Render(HtmlTextWriter).)

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.)