Interface IInputHTML

Interface which is between the Control and the HTMLParser.

Namespace: Syncfusion.Windows.Forms.HTMLUI

Assembly: Syncfusion.HTMLUI.Windows.dll

Syntax

public interface IInputHTML

Properties

ClientSize

Gets or sets the client size of the document.

Declaration

Size ClientSize { get; set; }

Property Value

Type
System.Drawing.Size

CompileErrors

Gets an array of script compile errors.

Declaration

string[] CompileErrors { get; }

Property Value

Type
System.String[]

CurrentDirectory

Gets or sets the current directory for this document.

Declaration

string CurrentDirectory { get; set; }

Property Value

Type
System.String

Document

Gets the reference of output document which will be infilled by converted HTML.

Declaration

XmlDocument Document { get; }

Property Value

Type
System.Xml.XmlDocument

FileName

Gets the source for parser as file; Null otherwise. Property has the higher priority.

Declaration

string FileName { get; }

Property Value

Type
System.String

Formats

Gets the format manager object.

Declaration

FormatManager Formats { get; }

Property Value

Type
FormatManager

IsFileName

Gets a value indicating whether input HTML document is loaded from file.

Declaration

bool IsFileName { get; }

Property Value

Type
System.Boolean

IsStream

Gets a value indicating whether input HTML document is loaded from stream.

Declaration

bool IsStream { get; }

Property Value

Type
System.Boolean

IsUri

Gets a value indicating whether input HTML document is loaded by Uri.

Declaration

bool IsUri { get; }

Property Value

Type
System.Boolean

Margins

Gets the margins for the document.

Declaration

Margins Margins { get; }

Property Value

Type
Margins

Remarks

This property exposes leftmargin, topmargin, rightmargin and bottommargin of the BODY tag.

RenderException

Gets the exception object which occurred while document parsing and rendering.

Declaration

Exception RenderException { get; }

Property Value

Type
System.Exception

RenderRoot

Gets the instance to the Body tag element.

Declaration

IHTMLElement RenderRoot { get; }

Property Value

Type
IHTMLElement

Remarks

This element is the root for rendering.

Root

Gets the root element of the document. In most cases this is HTML tag.

Declaration

IHTMLElement Root { get; }

Property Value

Type
IHTMLElement

StartPoint

Gets or sets the point where the document will start to paint.

Declaration

[Obsolete("Don't use this property. Use Margins property instead.")]
Point StartPoint { get; set; }

Property Value

Type
System.Drawing.Point

Stream

Gets the source specified as stream; Null otherwise. Has the lowest priority.

Declaration

Stream Stream { get; }

Property Value

Type
System.IO.Stream

Uri

Gets the source for parser specified by URI; Null otherwise. Second property by priority for source checks.

Declaration

Uri Uri { get; }

Property Value

Type
System.Uri

Methods

BeginUpdate()

Disables the momentary reaction of the document on some attributes changing.

Declaration

void BeginUpdate()

ClientToGlobal(Point)

Converts the point from client coordinates to global coordinates.

Declaration

Point ClientToGlobal(Point point)

Parameters

Type	Name	Description
System.Drawing.Point	point	Point in client coordinates.

Returns

Type	Description
System.Drawing.Point	Point in global coordinates.

Draw(PaintEventArgs, Point)

Draws the document to the specified region.

Declaration

void Draw(PaintEventArgs e, Point location)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Graphics context.
System.Drawing.Point	location	Start location for the drawing.

EndUpdate()

Enables the momentary reaction of the document on some attributes changing.

Declaration

void EndUpdate()

GetControlByElement(IHTMLElement)

Returns the custom control with the specified parent tag element.

Declaration

Control GetControlByElement(IHTMLElement parent)

Parameters

Type	Name	Description
IHTMLElement	parent	Parent element containing the custom control.

Returns

Type	Description
System.Windows.Forms.Control	Control contained in the element if it exists; NULL otherwise.

GetCSSFormatsToElementHash()

Creates and returns the hashtable where key is UniqueID of element and value is Array of Formats which influence on element rendering.

Declaration

Hashtable GetCSSFormatsToElementHash()

Returns

Type	Description
System.Collections.Hashtable	Hashtable of output document. UniqueID-to-Array of Formats

GetElementByUniqueId(String)

Returns the html element by its unique ID, if such exists; NULL otherwise.

Declaration

IHTMLElement GetElementByUniqueId(string uniqueID)

Parameters

Type	Name	Description
System.String	uniqueID	Unique ID of the element.

Returns

Type	Description
IHTMLElement	Element object by its unique ID.

GetElementByUserId(String)

Returns the html element by its ID, defined in the HTML document if such exists; NULL otherwise.

Declaration

IHTMLElement GetElementByUserId(string userID)

Parameters

Type	Name	Description
System.String	userID	ID defined in the HTML document.

Returns

Type	Description
IHTMLElement	Element by its ID defined in HTML document by id attribute.

GetElementsByName(String)

Returns an array of elements with the specified tag name.

Declaration

IHTMLElement[] GetElementsByName(string name)

Parameters

Type	Name	Description
System.String	name	Name of the tag.

Returns

Type	Description
IHTMLElement[]	Array of elements with the specified name; NULL otherwise.

GetElementsByNameHash()

Creates and returns the hashtable where key is Tag Name (Element.Name) and value is Array of elements with current name.

Declaration

Hashtable GetElementsByNameHash()

Returns

Type	Description
System.Collections.Hashtable	Hashtable of output document. Element Name-to-Array of Elements

GetElementsByUniqueIdHash()

Creates and return the hashtable where key is element's UniqueID and value is element reference.

Declaration

Hashtable GetElementsByUniqueIdHash()

Returns

Type	Description
System.Collections.Hashtable	Hashtable of output document. UniqueID-to-Element

GetElementsByUserIdHash()

Creates and returns the hashtable where key is UserID (id attribute specified by user for tag) and value is element reference.

Declaration

Hashtable GetElementsByUserIdHash()

Returns

Type	Description
System.Collections.Hashtable	Hashtable of output document. UserID-to-Element

GlobalToClient(Point)

Converts the point from global coordinates to client coordinates.

Declaration

Point GlobalToClient(Point point)

Parameters

Type	Name	Description
System.Drawing.Point	point	Point in global coordinates.

Returns

Type	Description
System.Drawing.Point	Point in client coordinates.

Recalculate()

Recalculates the document corresponding to the specified properties.

Declaration

void Recalculate()