C# Class YamuiFramework.HtmlRenderer.WinForms.HtmlPanel

Provides HTML rendering using the text property.
WinForms control that will render html content in it's client rectangle.
If AutoScroll is true and the layout of the html resulted in its content beyond the client bounds of the panel it will show scrollbars (horizontal/vertical) allowing to scroll the content.
If AutoScroll is false html content outside the client bounds will be clipped.
The control will handle mouse and keyboard events on it to support html text selection, copy-paste and mouse clicks.

The major differential to use HtmlPanel or HtmlLabel is size and scrollbars.
If the size of the control depends on the html content the HtmlLabel should be used.
If the size is set by some kind of layout then HtmlPanel is more suitable, also shows scrollbars if the html contents is larger than the control client rectangle.

AutoScroll:

Allows showing scrollbars if html content is placed outside the visible boundaries of the panel.

LinkClicked event:

Raised when the user clicks on a link in the html.
Allows canceling the execution of the link.

StylesheetLoad event:

Raised when a stylesheet is about to be loaded by file path or URI by link element.
This event allows to provide the stylesheet manually or provide new source (file or uri) to load from.
If no alternative data is provided the original source will be used.

ImageLoad event:

Raised when an image is about to be loaded by file path or URI.
This event allows to provide the image manually, if not handled the image will be loaded from file or download from URI.

RenderError event:

Raised when an error occurred during html rendering.

Inheritance: System.Windows.Forms.ScrollableControl

ファイルを表示 Open project: jcaillon/3P

Protected Properties

Property	Type	Description
_baseCssData	YamuiFramework.HtmlRenderer.Core.Core.CssData
_baseRawCssData	string
_borderStyle	BorderStyle
_htmlContainer	HtmlContainer
_lastScrollOffset	Point
_text	string
_textRenderingHint	TextRenderingHint
_useSystemCursors	bool

Private Properties

Property	Type	Description
OnBoxClicked	void
OnImageLoad	void
OnLinkClicked	void
OnRefresh	void
OnRenderError	void
OnScrollChange	void
OnStylesheetLoad	void
WndProc	void
YamuiThemeManagerOnOnCssChanged	void

Public Methods

Method	Description
GetElementRectangle ( string elementId ) : RectangleF?	Get the rectangle of html element as calculated by html layout. Element if found by id (id attribute on the html element). Note: to get the screen rectangle you need to adjust by the hosting control.
GetHtml ( ) : string	Get html from the current DOM tree with inline style.
HtmlPanel ( ) : System	Creates a new HtmlPanel and sets a basic css for it's styling.
ScrollToElement ( string elementId ) : void	Adjust the scrollbar of the panel on html element by the given id. The top of the html element rectangle will be at the top of the panel, if there is not enough height to scroll to the top the scroll will be at maximum.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Release the html container resources.
InvokeMouseMove ( ) : void	call mouse move to handle paint after scroll or html change affecting mouse cursor.
IsInputKey ( Keys keyData ) : bool	Used to add arrow keys to the handled keys in OnKeyDown.
OnBorderStyleChanged ( EventArgs e ) : void	Raises the BorderStyleChanged event.
OnBoxClicked ( YamuiFramework.HtmlRenderer.Core.Core.Entities.BoxClickedEventArgs e ) : void	Propagate the BoxClicked event from root container.
OnClick ( EventArgs e ) : void	Set focus on the control for keyboard scrollbars handling.
OnImageLoad ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlImageLoadEventArgs e ) : void	Propagate the image load event from root container.
OnKeyDown ( KeyEventArgs e ) : void	Handle key down event for selection, copy and scrollbars handling.
OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void	Perform the layout of the html in the control.
OnLinkClicked ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlLinkClickedEventArgs e ) : void	Propagate the LinkClicked event from root container.
OnMouseDoubleClick ( MouseEventArgs e ) : void	Handle mouse double click to select word under the mouse.
OnMouseDown ( MouseEventArgs e ) : void	Handle mouse down to handle selection.
OnMouseLeave ( EventArgs e ) : void	Handle mouse leave to handle cursor change.
OnMouseMove ( MouseEventArgs e ) : void	Handle mouse move to handle hover cursor and text selection.
OnMouseUp ( MouseEventArgs e ) : void	Handle mouse up to handle selection and link click.
OnPaint ( PaintEventArgs e ) : void	Perform paint of the html in the control.
OnRefresh ( HtmlRefreshEventArgs e ) : void	Handle html renderer invalidate and re-layout as requested.
OnRenderError ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlRenderErrorEventArgs e ) : void	Propagate the Render Error event from root container.
OnScrollChange ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlScrollEventArgs e ) : void	On html renderer scroll request adjust the scrolling of the panel to the requested location.
OnStylesheetLoad ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlStylesheetLoadEventArgs e ) : void	Propagate the stylesheet load event from root container.
PerformHtmlLayout ( ) : void	Perform html container layout by the current panel client size.
UpdateScroll ( Point location ) : void	Adjust the scrolling of the panel to the requested location.

Private Methods

Method	Description
OnBoxClicked ( object sender, YamuiFramework.HtmlRenderer.Core.Core.Entities.BoxClickedEventArgs e ) : void
OnImageLoad ( object sender, YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlImageLoadEventArgs e ) : void
OnLinkClicked ( object sender, YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlLinkClickedEventArgs e ) : void
OnRefresh ( object sender, HtmlRefreshEventArgs e ) : void
OnRenderError ( object sender, YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlRenderErrorEventArgs e ) : void
OnScrollChange ( object sender, YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlScrollEventArgs e ) : void
OnStylesheetLoad ( object sender, YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlStylesheetLoadEventArgs e ) : void
WndProc ( Message &m ) : void
YamuiThemeManagerOnOnCssChanged ( ) : void

Method Details

Dispose() protected method

Release the html container resources.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

GetElementRectangle() public method

Get the rectangle of html element as calculated by html layout.
Element if found by id (id attribute on the html element).
Note: to get the screen rectangle you need to adjust by the hosting control.

public GetElementRectangle ( string elementId ) : RectangleF?
elementId	string	the id of the element to get its rectangle
return	RectangleF?

GetHtml() public method

Get html from the current DOM tree with inline style.

public GetHtml ( ) : string
return	string

HtmlPanel() public method

Creates a new HtmlPanel and sets a basic css for it's styling.

public HtmlPanel ( ) : System
return	System

InvokeMouseMove() protected method

call mouse move to handle paint after scroll or html change affecting mouse cursor.

protected InvokeMouseMove ( ) : void
return	void

IsInputKey() protected method

Used to add arrow keys to the handled keys in OnKeyDown.

protected IsInputKey ( Keys keyData ) : bool
keyData	Keys
return	bool

OnBorderStyleChanged() protected method

Raises the BorderStyleChanged event.

protected OnBorderStyleChanged ( EventArgs e ) : void
e	System.EventArgs
return	void

OnBoxClicked() protected method

Propagate the BoxClicked event from root container.

protected OnBoxClicked ( YamuiFramework.HtmlRenderer.Core.Core.Entities.BoxClickedEventArgs e ) : void
e	YamuiFramework.HtmlRenderer.Core.Core.Entities.BoxClickedEventArgs
return	void

OnClick() protected method

Set focus on the control for keyboard scrollbars handling.

protected OnClick ( EventArgs e ) : void
e	System.EventArgs
return	void

OnImageLoad() protected method

Propagate the image load event from root container.

protected OnImageLoad ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlImageLoadEventArgs e ) : void
e	YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlImageLoadEventArgs
return	void

OnKeyDown() protected method

Handle key down event for selection, copy and scrollbars handling.

protected OnKeyDown ( KeyEventArgs e ) : void
e	System.Windows.Forms.KeyEventArgs
return	void

OnLayout() protected method

Perform the layout of the html in the control.

protected OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void
levent	System.Windows.Forms.LayoutEventArgs
return	void

OnLinkClicked() protected method

Propagate the LinkClicked event from root container.

protected OnLinkClicked ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlLinkClickedEventArgs e ) : void
e	YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlLinkClickedEventArgs
return	void

OnMouseDoubleClick() protected method

Handle mouse double click to select word under the mouse.

protected OnMouseDoubleClick ( MouseEventArgs e ) : void
e	MouseEventArgs
return	void

OnMouseDown() protected method

Handle mouse down to handle selection.

protected OnMouseDown ( MouseEventArgs e ) : void
e	MouseEventArgs
return	void

OnMouseLeave() protected method

Handle mouse leave to handle cursor change.

protected OnMouseLeave ( EventArgs e ) : void
e	System.EventArgs
return	void

OnMouseMove() protected method

Handle mouse move to handle hover cursor and text selection.

protected OnMouseMove ( MouseEventArgs e ) : void
e	MouseEventArgs
return	void

OnMouseUp() protected method

Handle mouse up to handle selection and link click.

protected OnMouseUp ( MouseEventArgs e ) : void
e	MouseEventArgs
return	void

OnPaint() protected method

Perform paint of the html in the control.

protected OnPaint ( PaintEventArgs e ) : void
e	PaintEventArgs
return	void

OnRefresh() protected method

Handle html renderer invalidate and re-layout as requested.

protected OnRefresh ( HtmlRefreshEventArgs e ) : void
e	HtmlRefreshEventArgs
return	void

OnRenderError() protected method

Propagate the Render Error event from root container.

protected OnRenderError ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlRenderErrorEventArgs e ) : void
e	YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlRenderErrorEventArgs
return	void

OnScrollChange() protected method

On html renderer scroll request adjust the scrolling of the panel to the requested location.

protected OnScrollChange ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlScrollEventArgs e ) : void
e	YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlScrollEventArgs
return	void

OnStylesheetLoad() protected method

Propagate the stylesheet load event from root container.

protected OnStylesheetLoad ( YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlStylesheetLoadEventArgs e ) : void
e	YamuiFramework.HtmlRenderer.Core.Core.Entities.HtmlStylesheetLoadEventArgs
return	void

PerformHtmlLayout() protected method

Perform html container layout by the current panel client size.

protected PerformHtmlLayout ( ) : void
return	void

ScrollToElement() public method

Adjust the scrollbar of the panel on html element by the given id.
The top of the html element rectangle will be at the top of the panel, if there is not enough height to scroll to the top the scroll will be at maximum.

public ScrollToElement ( string elementId ) : void
elementId	string	the id of the element to scroll to
return	void

UpdateScroll() protected method

Adjust the scrolling of the panel to the requested location.

protected UpdateScroll ( Point location ) : void
location	Point	the location to adjust the scroll to
return	void

Property Details

_baseCssData protected_oe property

the base stylesheet data used in the control

protected CssData,YamuiFramework.HtmlRenderer.Core.Core _baseCssData
return	YamuiFramework.HtmlRenderer.Core.Core.CssData

_baseRawCssData protected_oe property

the raw base stylesheet data used in the control

protected string _baseRawCssData
return	string

_borderStyle protected_oe property

The current border style of the control

protected BorderStyle _borderStyle
return	BorderStyle

_htmlContainer protected_oe property

Underline html container instance.

protected HtmlContainer,YamuiFramework.HtmlRenderer.WinForms _htmlContainer
return	HtmlContainer

_lastScrollOffset protected_oe property

The last position of the scrollbars to know if it has changed to update mouse

protected Point _lastScrollOffset
return	Point

_text protected_oe property

the current html text set in the control

protected string _text
return	string

_textRenderingHint protected_oe property

The text rendering hint to be used for text rendering.

protected TextRenderingHint _textRenderingHint
return	TextRenderingHint

_useSystemCursors protected_oe property

If to use cursors defined by the operating system or .NET cursors

protected bool _useSystemCursors
return	bool