See Also

HtmlBox Class  | Dart.PowerWEB.TextBox Namespace

See Also PowerWEB TextBox for ASP.NET

HtmlBox Class Members

Dart.PowerWEB.TextBox Namespace : HtmlBox Class

HtmlBox overview

Public Constructors

Public Constructor HtmlBox Constructor Overloaded.  Initializes a new instance of the HtmlBox control.

Public Properties

Public Property AccessKey (Inherited from System.Web.UI.WebControls.WebControl)Gets or sets the access key that allows you to quickly navigate to the Web server control.
Public Property AppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
Public Property AssociatedControlID (Inherited from System.Web.UI.WebControls.Label)Gets or sets the identifier for a server control that the Label control is associated with.
Public Property Attributes (Inherited from System.Web.UI.WebControls.WebControl)Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
Public Property AutoSaveFrequency Gets or sets a value which indicates the number of keystrokes between AutoSave events.
Public Property AutoSaveInterval Gets or sets a value which indicates the number of seconds between AutoSave events.
Public Property BackColor Overridden. Gets or sets the background color of the control.
Public Property BackgroundImageName Gets or sets the name of the background image to display as the background of the HtmlBox.
Public Property BasePath Gets or sets the base path value for url conversions.
Public Property Blocking Gets or sets the blocking state of the control.
Public Property BorderColor Overridden. Gets or sets the border color of the control.
Public Property BorderStyle Overridden. Gets or sets the border style of the control.
Public Property BorderWidth Overridden. Gets or sets the border width of the control
Public Property BottomMargin Gets or sets the amount of space (in pixels) between the bottom edge of the editor and the TabStrip.
Public Property BrowserType Gets or sets the type of browser as detected by the PowerWEB control.
Public Property BufferedScript Gets the client-side script which will be written to the response stream when the callback request is ended.
Public Property ButtonMode Gets or sets ButtonMode value specifying the current mode of the toolbar buttons.
Public Property ButtonStyle Gets a ButtonStyle object representing the style that will be applied to all classes derived from BaseToolbarButton on the toolbar.
Public Property CallbackType Gets or sets the type of callbacks performed by the PowerWEB control.
Public Property ClientID (Inherited from System.Web.UI.Control)Gets the server control identifier generated by ASP.NET.
Public Property ColorPaletteType Gets or sets a ColorPaletteType value representing the color palette that the user can select from when editing HTML.
Public Property CompatibleBrowser Gets a value indicating if the browser was detected to be compatible with the HtmlBox.
Public Property Controls Overridden.  Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
Public Property ControlStyle (Inherited from System.Web.UI.WebControls.WebControl)Gets the style of the Web server control. This property is used primarily by control developers.
Public Property ControlStyleCreated (Inherited from System.Web.UI.WebControls.WebControl)Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
Public Property CssClass (Inherited from System.Web.UI.WebControls.WebControl)Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
Public Property Debug Set to true to display a debug window which displays callback data in real-time as it is set/received.
Public Property DialogStyle Gets or sets a DialogStyle object representing the style that will be applied to all HtmlBoxDialog controls used by the HtmlBox.
Public Property DownlevelLabel Represents the label rendered to the user if the HtmlBox.DownlevelMode = DownlevelMode.Label.
Public Property DownlevelMode Controls whether the user sees a Label or a TextArea if their browser is incompatible with the HtmlBox.
Public Property DownlevelTextArea Represents the textarea control rendered to the user if the HtmlBox.DownlevelMode = DownlevelMode.TextArea.
Public Property DropDownStyle Gets a Style object representing the style that will be applied to all ToolbarDropDown controls used by the HtmlBox.
Public Property DynamicValidation Use to inject validation code into the initial Page render.
Public Property EnableCallback Gets or sets whether the control issues a callback.
Public Property Enabled Overridden. Gets or sets a value indicating whether the HtmlBox control is enabled.
Public Property EnableTheming (Inherited from System.Web.UI.WebControls.WebControl)Gets or sets a value indicating whether themes apply to this control.
Public Property EnableViewState (Inherited from System.Web.UI.Control)Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
Public Property ErrorBehavior Gets or sets how errors are handled by the control.
Public Property ErrorMessage Gets or sets the message that is displayed if an error occurs and ErrorBehavior is ErrorBehavior.ShowAlert.
Public Property Focus  
Public Property Font Overridden. Gets the font properties associated with the Web server control.
Public Property FontFormattingList High-level "helper" collection which provides font formatting values to applicable ToolbarDropDown controls.
Public Property FontNameList High-level "helper" collection which provides font name values to applicable ToolbarDropDown controls.
Public Property FontSizeList High-level "helper" collection which provides font size values to applicable ToolbarDropDown controls.
Public Property FontStyleList High-level "helper" collection which provides font style values to applicable ToolbarDropDown controls.
Public Property ForeColor Overridden. Gets or sets the foreground color (typically the color of the text) of the control.
Public Property HasAttributes (Inherited from System.Web.UI.WebControls.WebControl)Gets a value indicating whether the control has attributes set.
Public Property Height Overridden. Gets or sets the height of the control.
Public Property ID (Inherited from System.Web.UI.Control)Gets or sets the programmatic identifier assigned to the server control.
Public Property ImagesDirectory Gets or sets a virtual, relative, or absolute pathname of the directory containing all of the images used by the HtmlBox.
Public Property IsCallback Gets the callback state of the PowerWEB control.
Public Property IsLive Gets or sets whether a PowerWEB control updates itself in a callback.
Public Property IsPostbackFromUpload Gets a value specifying if the current page request was due to a postback from an HtmlBoxUpload control.
Public Property LayoutType Gets or sets the current LayoutType of the HtmlBox.
Public Property Left Gets or sets the left position of the PowerWEB control.
Public Property LocalizationFile Gets or sets a value specifying a file path to an XML file specifying localization strings.
Public Property LocalizationType Gets or sets a value which determines in what language strings are displayed
Public Property MenuStyle Gets a MenuStyle object representing the style that will be applied to all HtmlBoxMenu controls used by the HtmlBox.
Public Property NamingContainer (Inherited from System.Web.UI.Control)Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
Public Property Page (Inherited from System.Web.UI.Control)Gets a reference to the Page instance that contains the server control.
Public Property Parent (Inherited from System.Web.UI.Control)Gets a reference to the server control's parent control in the page control hierarchy.
Public Property PlaceholderFilename Gets or sets a virtual, relative, or absolute pathname of the directory containing all of the images used by the HtmlBox.
Public Property ProgressBar Gets the HtmlBoxProgressBar representing the progressbar used for the HtmlBox preload, if it is enabled.
Public Property ReadOnly Gets or sets a value which indicates whether the HtmlBox should be an active HTML editor, or a read-only document viewer.
Public Property RightClickBehavior Gets or sets a value which indicates how the HtmlBox should behave when it is right-clicked with the mouse.
Public Property RightClickMenu Gets an HtmlBoxMenu control representing the right-click menu displayed when the user right-clicks on the HtmlBox with the mouse.
Public Property SecureConnection Gets or sets a value which indicates if the HtmlBox is being requested by a secure connection.
Public Property Site (Inherited from System.Web.UI.Control)Gets information about the container that hosts the current control when rendered on a design surface.
Public Property SkinID (Inherited from System.Web.UI.WebControls.WebControl)Gets or sets the skin to apply to the control.
Public Property SpecialCharacterList High-level "helper" collection which provides special character values to applicable ToolbarDialogButton controls.
Public Property StartupMode Gets or sets a StartupMode value indicating the startup mode of the HtmlBox.
Public Property Style (Inherited from System.Web.UI.WebControls.WebControl)Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
Public Property TabIndex (Inherited from System.Web.UI.WebControls.WebControl)Gets or sets the tab index of the Web server control.
Public Property TabStrip Gets a HtmlBoxTabStrip object representing the tabstrip used by the HtmlBox.
Public Property Tag Gets or sets a convertible object that contains data about the control.
Public Property TemplateControl (Inherited from System.Web.UI.Control)Gets or sets a reference to the template that contains this control.
Public Property TemplateSourceDirectory (Inherited from System.Web.UI.Control)Gets the virtual directory of the Page or UserControl that contains the current server control.
Public Property Text Gets or sets the text displayed in the editor.
Public Property TextPlain Gets the value of the HtmlBox.Text property stripped of any HTML tags.
Public Property TextWindow Gets an HtmlBoxTextWindow control representing the actual editing window of the HtmlBox.
Public Property TextXhtml Gets the value of the HtmlBox.Text property converted to XHTML.
Public Property Toolbar Gets an HtmlBoxToolbar control representing the toolbar.
Public Property ToolTip (Inherited from System.Web.UI.WebControls.WebControl)Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
Public Property Top Gets or sets the top position of the PowerWEB control.
Public Property TopMargin Gets or sets the amount of space (in pixels) between the top edge of the editor and the toolbar.
Public Property UniqueID (Inherited from System.Web.UI.Control)Gets the unique, hierarchically qualified identifier for the server control.
Public Property UpdateAll Gets or sets which fields are posted to the server in a callback.
Public Property UploadedFilesDirectory Gets or sets a virtual, relative, or absolute pathname of the directory where all files are uploaded.
Public Property UrlType Gets or sets a value which determines how links are represented in the editor.
Public Property UseLineBreak Gets or sets a value which determines how enter key presses behave.
Public Property UseSection508Compliance Gets or sets whether the HtmlBox should be rendered in Section 508 compliant mode.
Public Property Visible Overridden. Gets or sets a value indicating whether the PowerWEB control is visible.
Public Property WaitElementID Gets or sets the message ID of the HTML element to display a message during a pending callback.
Public Property WaitMessage Gets or sets the message to display during a pending callback.
Public Property Width Overridden. Gets or sets the width of the control.

Public Methods

Public Method AddToolbarItem High-level "shortcut" method to quickly create, initialize, and add an item to the toolbar.
Public Method ApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
Public Method ApplyStyleSheetSkin (Inherited from System.Web.UI.Control)Applies the style properties defined in the page style sheet to the control.
Public Method Clear Clears the HtmlBox.
Public Method ClearStyles Clears the HtmlBox.
Public Method Clone Returns a deep copy of the current object.
Public Method CopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
Public Method DataBind (Inherited from System.Web.UI.Control)Binds a data source to the invoked server control and all its child controls.
Public Method Dispose (Inherited from System.Web.UI.Control)Enables a server control to perform final clean up before it is released from memory.
Public Method FindControl (Inherited from System.Web.UI.Control)Searches the current naming container for a server control with the specified id parameter.
Public Method Focus (Inherited from System.Web.UI.Control) Controls whether or not the HtmlBox receives the mouse focus when the page is loaded.
Sets input focus to a control.
Public Method GetCallbackEventReference Returns JavaScript that can be used to initiate a callback to the server.
Public Method GetScript Returns all JavaScript buffered up as a result of setting control properties.
Public Method GetScriptObjectReference Returns a client-side reference to the element.
Public Method GetScriptStyleReference Returns a client-side reference to the style object of the element.
Public Method GetViewState Returns the ViewState object used to save and restore state.
Public Method HasControls (Inherited from System.Web.UI.Control)Determines if the server control contains any child controls.
Public Method LoadSkin Load a predefined skin XML file.
Public Method MergeStyle (Inherited from System.Web.UI.WebControls.WebControl)Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
Public Method Refresh In a callback, updates the controls client-side representation.
Public Method RenderBeginTag Overridden.  Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
Public Method RenderControl (Inherited from System.Web.UI.Control)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
Public Method RenderEndTag Overridden.  Renders the HTML opening tag of the control into the specified writer. This method is used primarily by control developers.
Public Method Reset Returns the HtmlBox control to it's inital state.
Public Method ResolveClientUrl (Inherited from System.Web.UI.Control)Gets a URL that can be used by the browser.
Public Method ResolveUrl (Inherited from System.Web.UI.Control)Converts a URL into one that is usable on the requesting client.
Public Method SaveSkin Overloaded.  Save the current HtmlBox configuration as an XML skin file.
Public Method SetRenderMethodDelegate (Inherited from System.Web.UI.Control)Assigns an event handler delegate to render the server control and its content into its parent control.

Public Events

Public Event AutoSave Raised after a specified interval or keystroke count.
Public Event ContextMenuChanged Occurs when the right button of the PowerWEB control is clicked.
Public Event DataBinding (Inherited from System.Web.UI.Control)Occurs when the server control binds to a data source.
Public Event Disposed (Inherited from System.Web.UI.Control)Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
Public Event DoubleClick Occurs when the control is double-clicked.
Public Event FileUpload Raised after an attempted file upload.
Public Event GotFocus Occurs when the PowerWEB control gains focus.
Public Event HelpRequested Occurs when F1 is pressed while the control has focus.
Public Event Init (Inherited from System.Web.UI.Control)Occurs when the server control is initialized, which is the first step in its lifecycle.
Public Event KeyDown Occurs when a key is down while the control has focus.
Public Event KeyPress Occurs when a key is pressed while the control has focus.
Public Event KeyUp Occurs when a key is released while the control has focus.
Public Event Load (Inherited from System.Web.UI.Control)Occurs when the server control is loaded into the Page object.
Public Event LocationClick Occurs when the PowerWEB control is clicked, providing location data.
Public Event LostFocus Occurs when the PowerWEB control loses focus.
Public Event MouseDown Occurs when the mouse buttons are pressed while the PowerWEB control has focus.
Public Event MouseEnter Occurs when the mouse pointer enters the PowerWEB control.
Public Event MouseLeave Occurs when the mouse pointer leaves the PowerWEB control.
Public Event MouseUp Occurs when the mouse buttons are released while the PowerWEB control has focus.
Public Event PreRender (Inherited from System.Web.UI.Control)Occurs after the Control object is loaded but prior to rendering.
Public Event TextChanged Occurs when the content of the HtmlBox is changed upon server postback.
Public Event ToolbarButtonClick Raised when a postback is raised by a toolbar button click.
Public Event Unload (Inherited from System.Web.UI.Control)Occurs when the server control is unloaded from memory.

See Also

HtmlBox Class  | Dart.PowerWEB.TextBox Namespace


Send comments on this topic.

Documentation version 3.2.0.0.

© 2009 Dart Communications.  All rights reserved.