WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class HTMLUIControl - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class HTMLUIControl

    HTMLUIControl renders an HTML document.

    Inheritance
    System.Object
    HTMLUIControl
    Implements
    INonClientPaintingSupport
    System.ComponentModel.ISupportInitialize
    Namespace: Syncfusion.Windows.Forms.HTMLUI
    Assembly: Syncfusion.HTMLUI.Windows.dll
    Syntax
    public class HTMLUIControl : ScrollableControl, INonClientPaintingSupport, ISupportInitialize
    Remarks

    The HTMLUIControl loads and renders an HTML document with the appropriate styles. The control also exposes the HTML elements as objects for programmatic manipulation.

    Constructors

    HTMLUIControl()

    Initializes a new instance of the HTMLUIControl class.

    Declaration
    public HTMLUIControl()

    Properties

    AutoRunScripts

    Gets or sets a value indicating whether the scripts in the body of the loaded HTML document must be executed.

    Declaration
    public bool AutoRunScripts { get; set; }
    Property Value
    Type Description
    System.Boolean

    Border3DStyle

    Gets or sets the style of the 3D border.

    Declaration
    public Border3DStyle Border3DStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Border3DStyle

    One of the Border3DStyle values. Default is Border3DStyle.Sunken.

    BorderColor

    Gets or sets the color of the 2D border.

    Declaration
    public Color BorderColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    BorderSides

    Gets or sets the border sides of the control that will be drawn.

    Declaration
    public Border3DSide BorderSides { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Border3DSide

    One of the System.Windows.Forms.Border3DSide values. Default is Border3DSide.All.

    BorderSingle

    Gets or sets the 2D border style.

    Declaration
    public ButtonBorderStyle BorderSingle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ButtonBorderStyle

    One of the System.Windows.Forms.ButtonBorderStyle values. Default is ButtonBorderStyle.Solid.

    BorderStyle

    Gets or sets the border style of the control.

    Declaration
    public BorderStyle BorderStyle { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.BorderStyle

    One of the BorderStyle values. Default is BorderStyle.Fixed3D.

    BorderWidth

    Gets or sets the value for BorderThickness.

    Declaration
    public int BorderWidth { get; set; }
    Property Value
    Type Description
    System.Int32

    ClickedButton

    Gets the clicked mouse button.

    Declaration
    protected MouseButtons ClickedButton { get; }
    Property Value
    Type Description
    System.Windows.Forms.MouseButtons

    ClickedPoint

    Gets the point where the mouse was clicked.

    Declaration
    public Point ClickedPoint { get; }
    Property Value
    Type Description
    System.Drawing.Point

    CreateParams

    Overrides the CreateParams

    Declaration
    protected override CreateParams CreateParams { get; }
    Property Value
    Type Description
    System.Windows.Forms.CreateParams

    CSSParser

    Gets an instance of the LiteCSSParser.

    Declaration
    public static HTMLUICSSParser CSSParser { get; }
    Property Value
    Type Description
    HTMLUICSSParser

    DefaultFormat

    Gets an access to default format used as base for document rendering.

    Declaration
    public IHTMLFormat DefaultFormat { get; }
    Property Value
    Type Description
    IHTMLFormat

    DisplayText

    Gets the internal appearance of the document's HTML data.

    Declaration
    public string DisplayText { get; }
    Property Value
    Type Description
    System.String

    Document

    Gets the parsed and displayed document.

    Declaration
    public IInputHTML Document { get; }
    Property Value
    Type Description
    IInputHTML
    Remarks

    The IInputHTML document defines the various elements of the HTML document loaded into the HTMLUIControl. The document provides access to all the elements in the HTML document.

    EnableMultithreading

    Gets or sets a value indicating whether a separate thread is used for document loading.

    Declaration
    public bool EnableMultithreading { get; set; }
    Property Value
    Type Description
    System.Boolean

    Font

    Overrides the font property.

    Declaration
    public override Font Font { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    FormatManager

    Gets an instance of the Format manager.

    Declaration
    public FormatManager FormatManager { get; }
    Property Value
    Type Description
    FormatManager

    History

    Gets the history of the documents loaded by the control in this session.

    Declaration
    public History History { get; }
    Property Value
    Type Description
    History

    HTMLParser

    Gets an instance of the HTMLUIParser.

    Declaration
    public static HTMLUIParser HTMLParser { get; }
    Property Value
    Type Description
    HTMLUIParser

    Increase

    Gets the increase in height needed to accommodate the title.

    Declaration
    protected int Increase { get; }
    Property Value
    Type Description
    System.Int32

    IsLoading

    Gets a value indicating whether the document is loading.

    Declaration
    protected bool IsLoading { get; }
    Property Value
    Type Description
    System.Boolean

    IsOriginalTextCached

    Gets or sets a value indicating whether the original text of the document will be stored.

    Declaration
    public bool IsOriginalTextCached { get; set; }
    Property Value
    Type Description
    System.Boolean

    NeedDefaultMargin

    Gets or sets a value indicating whether the default margin is needed.

    Declaration
    public bool NeedDefaultMargin { get; set; }
    Property Value
    Type Description
    System.Boolean

    Recalculate

    Gets or sets a value indicating whether the size and position must be recalculated.

    Declaration
    protected bool Recalculate { get; set; }
    Property Value
    Type Description
    System.Boolean

    Scripts

    Gets the collection of scripts in the document.

    Declaration
    public ScriptManagerExCollection Scripts { get; }
    Property Value
    Type Description
    ScriptManagerExCollection

    SelectedElements

    Gets an array of selected elements in the document.

    Declaration
    public IHTMLElement[] SelectedElements { get; }
    Property Value
    Type Description
    IHTMLElement[]

    SelectedText

    Gets the selected text displayed in the control.

    Declaration
    public string SelectedText { get; }
    Property Value
    Type Description
    System.String

    ShowTitle

    Gets or sets a value indicating whether the Text will be displayed.

    Declaration
    public virtual bool ShowTitle { get; set; }
    Property Value
    Type Description
    System.Boolean

    SizeToFit

    Specifies that the size of the image on a HTMLUI that automatically gets adjust to fit on a HTMLUI.

    Declaration
    public bool SizeToFit { get; set; }
    Property Value
    Type Description
    System.Boolean

    StartupDocument

    Gets or sets the path to the start up document for the control.

    Declaration
    public string StartupDocument { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    The startup document is the document that will be loaded by the HTMLUIControl initially.

    StartupFolder

    Gets or sets the startup folder for the start up document of the control.

    Declaration
    public string StartupFolder { get; set; }
    Property Value
    Type Description
    System.String

    Text

    Gets or sets the HTML rendered by the HTMLUIControl.

    Declaration
    public override string Text { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    Any text set to this property will be parsed by the control and rendered. If IsOriginalTextCached property is set to true and document is loaded from this property or from local file using method, this property will return original data /// entered for loading; Otherwise, this property will return DisplayText property content.

    ThreadDocument

    Gets of data while data is loading.

    Declaration
    protected InputHTML ThreadDocument { get; }
    Property Value
    Type Description
    InputHTML

    Title

    Gets or sets the Title of the HTMLUIControl / the document loaded into the control.

    Declaration
    public virtual string Title { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    The Title value can be set explicitly or this is auto extracted from the Title tag of the HTML document.

    ToolTip

    Gets the ToolTip control.

    Declaration
    protected ToolTip ToolTip { get; }
    Property Value
    Type Description
    System.Windows.Forms.ToolTip

    Methods

    AbortLoadThread()

    Aborts thread which loads a new document.

    Declaration
    protected void AbortLoadThread()

    Back()

    Loads the previous document from history.

    Declaration
    public void Back()

    Back(Int32)

    Loads the document from history according to the index.

    Declaration
    public void Back(int index)
    Parameters
    Type Name Description
    System.Int32 index

    Index of moving in the history. Must be less then zero.

    BeginInit()

    Invoked when initialization begins.

    Declaration
    public void BeginInit()

    BeginUpdate()

    Stops redrawing the control until the call of EndUpdate method.

    Declaration
    public virtual void BeginUpdate()

    ClientToVirtual(Point)

    Converts client coordinates to virtual coordinates of control.

    Declaration
    public Point ClientToVirtual(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Point coordinates in client coordinates.

    Returns
    Type Description
    System.Drawing.Point

    Coordinates in global coordinates.

    CreateAccessibilityInstance()

    Declaration
    protected override AccessibleObject CreateAccessibilityInstance()
    Returns
    Type Description
    System.Windows.Forms.AccessibleObject

    DisplayFindForm()

    Displays the find form for searching the text content of the HTMLUI control's current document.

    Declaration
    public void DisplayFindForm()

    Dispose(Boolean)

    Override Dispose

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    bool variable

    EndInit()

    Invoked when initialization ends.

    Declaration
    public void EndInit()

    EndUpdate()

    Continues redrawing the control after the previous BeginUpdate method call.

    Declaration
    public virtual void EndUpdate()

    Forward()

    Loads next document from history.

    Declaration
    public void Forward()

    Forward(Int32)

    Loads the document from history according to the index.

    Declaration
    public void Forward(int index)
    Parameters
    Type Name Description
    System.Int32 index

    Index of moving in the history. Must be greater then zero.

    GetBubblingEventArgs(EventArgs)

    Converts the EventArgs object to BubblingEventArgs type if possible.

    Declaration
    public static BubblingEventArgs GetBubblingEventArgs(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    EventArgs object.

    Returns
    Type Description
    BubblingEventArgs

    BubblingEventArgs object if converting was successful, Null otherwise.

    GetBublingEventArgs(EventArgs)

    Converts the EventArgs object to BubblingEventArgs type if possible.

    Declaration
    [Obsolete("GetBublingEventArgs is deprecated, please use GetBubblingEventArgs instead.")]
    public static BubblingEventArgs GetBublingEventArgs(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    EventArgs object.

    Returns
    Type Description
    BubblingEventArgs

    BubblingEventArgs object if converting was successful, Null otherwise.

    GetElementAtClientPoint(Point)

    Overloaded. Returns the tag element which contains the specified point.

    Declaration
    public IHTMLElement GetElementAtClientPoint(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Coordinates are expressed relative to the upper-left corner of the control's client area.

    Returns
    Type Description
    IHTMLElement

    Element which contains the point.

    GetElementAtClientPoint(Int32, Int32)

    Returns the tag element which contains the specified point.

    Declaration
    public IHTMLElement GetElementAtClientPoint(int x, int y)
    Parameters
    Type Name Description
    System.Int32 x

    X coordinate of the point expressed relative to left corner of the control client area.

    System.Int32 y

    Y coordinate of the point expressed relative to left corner of the control client area.

    Returns
    Type Description
    IHTMLElement

    Element which contains the point.

    GetElementAtVirtualPoint(Point)

    Returns the tag element which contains the specified point.

    Declaration
    public IHTMLElement GetElementAtVirtualPoint(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Coordinates are expressed relative to the upper-left corner of the control's virtual rectangle.

    Returns
    Type Description
    IHTMLElement

    Element which contains the point.

    GetElementAtVirtualPoint(Int32, Int32)

    Returns the tag element which contains the point with defined coordinates.

    Declaration
    public IHTMLElement GetElementAtVirtualPoint(int x, int y)
    Parameters
    Type Name Description
    System.Int32 x

    X coordinate of the point expressed relative to the left corner of the control virtual rectangle.

    System.Int32 y

    Y coordinate of the point expressed relative to the left corner of the control virtual rectangle.

    Returns
    Type Description
    IHTMLElement

    Element by coordinates.

    LoadCSS(Stream)

    Loads styles from the specified CSS document from a System.IO.Stream and refreshes current document using the styles.

    Declaration
    public virtual void LoadCSS(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    Input stream with CSS styles.

    Remarks

    A stream passing to this method must support Seek operation.

    LoadCSS(String)

    Loads styles from the specified CSS file and refreshes current document using the styles.

    Declaration
    public virtual void LoadCSS(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    Input file with CSS styles.

    LoadCSSFromString(String)

    Updates the specified CSS style in the form of string to the HTML document.

    Declaration
    public virtual void LoadCSSFromString(string style)
    Parameters
    Type Name Description
    System.String style

    The CSS style as string.

    LoadFromString(String)

    Loads HTML code from string.

    Declaration
    public virtual void LoadFromString(string html)
    Parameters
    Type Name Description
    System.String html

    Html file

    LoadHTML(Stream)

    Loads the specified HTML document from a and renders it.

    Declaration
    public virtual void LoadHTML(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    Input stream reference.

    Remarks

    A stream passing to this method must support Seek operation.

    LoadHTML(String)

    Loads the specified HTML file into the HTMLUIControl and renders it.

    Declaration
    public virtual void LoadHTML(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    Source file name.

    LoadHTML(Uri)

    Loads the specified HTML document from a System.Uri into the HTMLUIControl and renders it.

    Declaration
    public virtual void LoadHTML(Uri uri)
    Parameters
    Type Name Description
    System.Uri uri

    Source file name by URI.

    LoadThread()

    Loads document in a new thread.

    Declaration
    protected void LoadThread()

    OnBorder3DStyleChanged()

    Raises the Border3DStyleChanged event.

    Declaration
    protected virtual void OnBorder3DStyleChanged()
    Remarks

    Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

    The OnBorder3DStyleChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBorder3DStyleChanged in a derived class, be sure to call the base class's OnBorder3DStyleChanged method so that registered delegates receive the event.

    OnBorderColorChanged()

    Raises the BorderColorChanged event.

    Declaration
    protected virtual void OnBorderColorChanged()
    Remarks

    Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

    The OnBorderColorChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBorderColorChanged in a derived class, be sure to call the base class's OnBorderColorChanged method so that registered delegates receive the event.

    OnBorderSidesChanged()

    Raises the BorderSidesChanged event.

    Declaration
    protected virtual void OnBorderSidesChanged()
    Remarks

    Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

    The OnBorderSidesChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OmBorderSidesChanged in a derived class, be sure to call the base class's OnBorderSidesChanged method so that registered delegates receive the event.

    OnBorderSingleChanged()

    Raises the BorderSingleChanged event.

    Declaration
    protected virtual void OnBorderSingleChanged()
    Remarks

    Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

    The OnBorderSingleChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBorderSingleChanged in a derived class, be sure to call the base class's OnBorderSingleChanged method so that registered delegates receive the event.

    OnBorderStyleChanged()

    Raises the BorderStyleChanged event.

    Declaration
    protected virtual void OnBorderStyleChanged()
    Remarks

    The OnBorderStyleChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBorderStyleChanged in a derived class, be sure to call the base class's OnBorderStyleChanged method so that registered delegates receive the event.

    OnClick(EventArgs)

    Overrides Click event

    Declaration
    protected override void OnClick(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    Event Data

    OnDoubleClick(EventArgs)

    Overrides DoubleClick event

    Declaration
    protected override void OnDoubleClick(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    Event Data

    OnGotFocus(EventArgs)

    Overloaded. Raised when control has got focus.

    Declaration
    protected override void OnGotFocus(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An EventArgs which contains event data.

    OnKeyDown(KeyEventArgs)

    Overloaded. Used for shortcuts invoked within the control.

    Declaration
    protected override void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.KeyEventArgs e

    Event data.

    OnLayout(LayoutEventArgs)

    Overloaded. Raises the Layout event. Also it prevents invoking of the base method while code running is between BeginUpdate / EndUpdate method calls.

    Declaration
    protected override void OnLayout(LayoutEventArgs levent)
    Parameters
    Type Name Description
    System.Windows.Forms.LayoutEventArgs levent

    Event data.

    OnLeave(EventArgs)

    Overloaded. Raised when control has lost focus.

    Declaration
    protected override void OnLeave(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An EventArgs which contains event data.

    OnLinkClicked(Object, LinkForwardEventArgs)

    Raises the LinkClicked event.

    Declaration
    protected virtual void OnLinkClicked(object sender, LinkForwardEventArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    LinkForwardEventArgs args

    An LinkForwardEventArgs with event data.

    OnLoadError(Object, LoadErrorEventArgs)

    Raises the LoadError event.

    Declaration
    protected virtual void OnLoadError(object sender, LoadErrorEventArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    LoadErrorEventArgs args

    Event data.

    OnLoadFinished(Object, EventArgs)

    Called after a document has been loaded.

    Declaration
    protected virtual void OnLoadFinished(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.EventArgs e

    An System.EventArgs with event data.

    OnLoadStarted(Object, EventArgs)

    Called after a document loading has started.

    Declaration
    protected virtual void OnLoadStarted(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.EventArgs e

    An System.EventArgs with event data.

    OnLostFocus(EventArgs)

    Overloaded. Raised when control has lost focus.

    Declaration
    protected override void OnLostFocus(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    Event arguments.

    OnMouseDown(MouseEventArgs)

    Overrides MouseDown event

    Declaration
    protected override void OnMouseDown(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs e

    Event Data

    OnMouseMove(MouseEventArgs)

    Overrides MouseMove event

    Declaration
    protected override void OnMouseMove(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs e

    Event Data

    OnMouseUp(MouseEventArgs)

    Overrides MouseUp event

    Declaration
    protected override void OnMouseUp(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseEventArgs e

    MouseEventArgs instance

    OnPaint(PaintEventArgs)

    Overrides paint event

    Declaration
    protected override void OnPaint(PaintEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    PaintEventArgs instance

    OnPaintBackground(PaintEventArgs)

    Overrides PaintBackGround event

    Declaration
    protected override void OnPaintBackground(PaintEventArgs pevent)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs pevent

    PaintEventArgs instance

    OnPreRenderDocument(Object, PreRenderDocumentArgs)

    Raises the PreRenderDocument event.

    Declaration
    protected virtual void OnPreRenderDocument(object sender, PreRenderDocumentArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    PreRenderDocumentArgs args

    Event data.

    OnResize(EventArgs)

    Overrides Resize event

    Declaration
    protected override void OnResize(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    Event data

    OnShowTitleChanged(ValueChangedEventArgs)

    Raises the ShowTitleChanged event.

    Declaration
    protected virtual void OnShowTitleChanged(ValueChangedEventArgs args)
    Parameters
    Type Name Description
    ValueChangedEventArgs args

    ValueChangedEventArgs instance

    OnSystemColorsChanged(Object, EventArgs)

    Triggers when System colors are changed

    Declaration
    protected virtual void OnSystemColorsChanged(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    System.EventArgs e

    EventArgs instance

    OnTitleChanged(ValueChangedEventArgs)

    Raises the TitleChanged event.

    Declaration
    protected virtual void OnTitleChanged(ValueChangedEventArgs args)
    Parameters
    Type Name Description
    ValueChangedEventArgs args

    Event Data

    ParseDocument(InputHTML)

    Parses input HTML document and converts it to an XML document with additional HTML elements objects tree.

    Declaration
    public virtual void ParseDocument(InputHTML document)
    Parameters
    Type Name Description
    InputHTML document

    Document to parse.

    PrepareDocument(IInputHTML)

    Prepares document object. Parses and renders it. It may be used for non-visual rendering. It does not assign controls to any properties such as a document.

    Declaration
    public void PrepareDocument(IInputHTML document)
    Parameters
    Type Name Description
    IInputHTML document

    Object containing HTML data.

    Remarks

    This method is suitable for rendering documents if HTMLUI control is used without graphic interface.

    PrepareDocument(IInputHTML, Boolean)

    Prepares document object. It may be used for non-visual rendering. It does not assign controls to any properties such as a document.

    Declaration
    public void PrepareDocument(IInputHTML document, bool layout)
    Parameters
    Type Name Description
    IInputHTML document

    Object containing HTML data.

    System.Boolean layout

    If true - layouts elements, otherwise - just parses and creates elements.

    Remarks

    This method is suitable for rendering documents if HTMLUI control is used without graphic interface.

    ProcessDialogKey(Keys)

    Overloaded. Processes a dialog key for handling Tab command key.

    Declaration
    protected override bool ProcessDialogKey(Keys keyData)
    Parameters
    Type Name Description
    System.Windows.Forms.Keys keyData

    One of the Key values that represents the key to process.

    Returns
    Type Description
    System.Boolean

    True if the key was processed by the control; false otherwise.

    RaiseLinkClicked(Object, LinkForwardEventArgs)

    Raises the LinkClicked event.

    Declaration
    protected void RaiseLinkClicked(object sender, LinkForwardEventArgs args)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    LinkForwardEventArgs args

    Event Data

    RaiseLoadError(LoadErrorEventArgs)

    Raises the LoadError event.

    Declaration
    protected void RaiseLoadError(LoadErrorEventArgs args)
    Parameters
    Type Name Description
    LoadErrorEventArgs args

    Event Data

    RaiseLoadFinished(EventArgs)

    Raises the LoadFinished event.

    Declaration
    protected void RaiseLoadFinished(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    Event Data

    RaiseLoadStarted(EventArgs)

    Raises the LoadStarted event.

    Declaration
    protected void RaiseLoadStarted(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    Event Data

    RaisePreRenderDocument(PreRenderDocumentArgs)

    Raises the PreRenderDocument event.

    Declaration
    protected void RaisePreRenderDocument(PreRenderDocumentArgs args)
    Parameters
    Type Name Description
    PreRenderDocumentArgs args

    Event Data

    RaiseShowTitleChanged(ValueChangedEventArgs)

    Raises the ShowTitleChanged event.

    Declaration
    protected void RaiseShowTitleChanged(ValueChangedEventArgs args)
    Parameters
    Type Name Description
    ValueChangedEventArgs args

    Event Data

    RaiseTitleChanged(ValueChangedEventArgs)

    Raises the TitleChanged event.

    Declaration
    protected void RaiseTitleChanged(ValueChangedEventArgs args)
    Parameters
    Type Name Description
    ValueChangedEventArgs args

    Event data

    RecalculateDocument()

    Recalculates current document and changes the view of control.

    Declaration
    protected void RecalculateDocument()

    RecalculateDocument(InputHTML)

    Recalculates current document and changes the view of control.

    Declaration
    protected void RecalculateDocument(InputHTML document)
    Parameters
    Type Name Description
    InputHTML document

    InputHtml document

    ResetBorder3DStyle()

    To reset Border3DStyle

    Declaration
    public void ResetBorder3DStyle()

    ResetBorderColor()

    To reset Border color

    Declaration
    public void ResetBorderColor()

    ResetBorderSides()

    To reset BorderSides

    Declaration
    public void ResetBorderSides()

    ResetBorderSingle()

    To reset BorderSingle

    Declaration
    public void ResetBorderSingle()

    ResetBorderStyle()

    To reset BorderStyle

    Declaration
    public void ResetBorderStyle()

    ResetBorderWidth()

    Resets the BorderWidth property to it's default value.

    Declaration
    public void ResetBorderWidth()

    ScrollToElement(IHTMLElement)

    Scrolls control in such way that the specified element is visible.

    Declaration
    public void ScrollToElement(IHTMLElement element)
    Parameters
    Type Name Description
    IHTMLElement element

    Tag Element.

    ScrollToRectangle(Rectangle, IInputHTML)

    Scrolls control to the specified rectangle. Tries to show the whole rectangle in the client area.

    Declaration
    public void ScrollToRectangle(Rectangle rect, IInputHTML document)
    Parameters
    Type Name Description
    System.Drawing.Rectangle rect

    Rectangle structure.

    IInputHTML document

    Document in which this rectangle exists.

    ScrollToText(Text)

    Scrolls control to the specified text object.

    Declaration
    protected void ScrollToText(Text textObj)
    Parameters
    Type Name Description
    Text textObj

    Text object.

    SelectAll()

    Select all the text in the control.

    Declaration
    public virtual void SelectAll()

    ShouldSerializeBorder3DStyle()

    To Specify BorderSides to be serialized or not

    Declaration
    public bool ShouldSerializeBorder3DStyle()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBorderColor()

    To Specify BorderColor to be serialized or not

    Declaration
    public bool ShouldSerializeBorderColor()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBorderSides()

    To Specify BorderSides to be serialized or not

    Declaration
    public bool ShouldSerializeBorderSides()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBorderSingle()

    To Specify BorderSingle to be serialized or not

    Declaration
    public bool ShouldSerializeBorderSingle()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBorderStyle()

    To Specify BorderStyle to be serialized or not

    Declaration
    public bool ShouldSerializeBorderStyle()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeBorderWidth()

    Indicates whether the current value of the BorderWidth property is to be serialized.

    Declaration
    protected bool ShouldSerializeBorderWidth()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeDefaultFormat()

    Indicates whether DefaultFormat property should be serialized.

    Declaration
    protected virtual bool ShouldSerializeDefaultFormat()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeDisplayText()

    Indicates whether DisplayText property is persisted.

    Declaration
    protected virtual bool ShouldSerializeDisplayText()
    Returns
    Type Description
    System.Boolean

    bool value

    ShouldSerializeText()

    Indicates whether Text property is serialized.

    Declaration
    protected virtual bool ShouldSerializeText()
    Returns
    Type Description
    System.Boolean

    bool value

    VirtualToClient(Point)

    Converts virtual coordinates to client coordinates of control.

    Declaration
    public Point VirtualToClient(Point point)
    Parameters
    Type Name Description
    System.Drawing.Point point

    Coordinates in global coordinates.

    Returns
    Type Description
    System.Drawing.Point

    Coordinates in client coordinates.

    WndProc(ref Message)

    Override WndProc

    Declaration
    protected override void WndProc(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m

    Events

    Border3DStyleChanged

    Occurs when the HTMLUI Control Border3DStyle is changed

    Declaration
    public event EventHandler Border3DStyleChanged
    Event Type
    Type Description
    System.EventHandler

    BorderColorChanged

    Occurs when the HTMLUI Control BorderColor is changed

    Declaration
    public event EventHandler BorderColorChanged
    Event Type
    Type Description
    System.EventHandler

    BorderSidesChanged

    Occurs when the HTMLUI Control BorderSides is changed

    Declaration
    public event EventHandler BorderSidesChanged
    Event Type
    Type Description
    System.EventHandler

    BorderSingleChanged

    Occurs when the HTMLUI Control Border2DStyle is changed

    Declaration
    public event EventHandler BorderSingleChanged
    Event Type
    Type Description
    System.EventHandler

    BorderStyleChanged

    Occurs when the HTMLUI Control BorderStyle is changed

    Declaration
    public event EventHandler BorderStyleChanged
    Event Type
    Type Description
    System.EventHandler

    LinkClicked

    Event that is to be raised after the hyperlink was clicked and before the hyperlink tries to load a new resource.

    Declaration
    public event LinkForwardEventHandler LinkClicked
    Event Type
    Type Description
    LinkForwardEventHandler

    LoadError

    Event that is to be raised when an error occurs during HTML document loading / rendering.

    Declaration
    public event LoadErrorEventHandler LoadError
    Event Type
    Type Description
    LoadErrorEventHandler

    LoadFinished

    Event that is to be raised after the HTML document is loaded.

    Declaration
    public event EventHandler LoadFinished
    Event Type
    Type Description
    System.EventHandler

    LoadStarted

    Event that is to be raised when loading of a new HTML document has started.

    Declaration
    public event EventHandler LoadStarted
    Event Type
    Type Description
    System.EventHandler

    PreRenderDocument

    Event that is to be raised when a tree of elements has been created, but their size and location have not been calculated yet.

    Declaration
    public event PreRenderDocumentEventHandler PreRenderDocument
    Event Type
    Type Description
    PreRenderDocumentEventHandler

    ShowTitleChanged

    Event that is to be raised after the ShowTitle property is changed.

    Declaration
    public event ValueChangedEventHandler ShowTitleChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    TitleChanged

    Event that is to be raised after the Title property is changed.

    Declaration
    public event ValueChangedEventHandler TitleChanged
    Event Type
    Type Description
    ValueChangedEventHandler

    Explicit Interface Implementations

    INonClientPaintingSupport.NonClientPaint(PaintEventArgs, Rectangle, Rectangle)

    To draw the border at non client area

    Declaration
    IntPtr INonClientPaintingSupport.NonClientPaint(PaintEventArgs e, Rectangle displayRect, Rectangle windowRectInScreen)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e
    System.Drawing.Rectangle displayRect
    System.Drawing.Rectangle windowRectInScreen
    Returns
    Type Description
    System.IntPtr

    Implements

    INonClientPaintingSupport
    System.ComponentModel.ISupportInitialize
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved