10487 lines
579 KiB
XML
10487 lines
579 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Bunifu.UI.WinForms.BunifuToolTip</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuToolTip">
|
|
<summary>
|
|
Provides enhanced ToolTips with a set of customzation
|
|
options to distinctly match your design needs.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.#ctor(System.ComponentModel.IContainer)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> class with a specified container.
|
|
</summary>
|
|
<param name="container">An <see cref="T:System.ComponentModel.IContainer"/> that represents the container of the ToolTip.</param>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.Active">
|
|
<summary>
|
|
Gets or sets a value indicating whether the ToolTip is active.
|
|
Tooltips will only appear if this property is set to <see cref="!:true"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ConvertNewlinesToBreakTags">
|
|
<summary>
|
|
Gets or sets a value indicating whether to allow conversion
|
|
of newline characters in content to HTML break tags.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ShowAlways">
|
|
<summary>
|
|
Determines if the tool tip will be displayed always,
|
|
even when the parent window is not active.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ShowIcons">
|
|
<summary>
|
|
Gets or sets a value indicating whether the ToolTip will display
|
|
icons if the associated control or controls have specified one.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.OverrideToolTipTitles">
|
|
<summary>
|
|
When set to true, all ToolTip titles set in each control will be
|
|
replaced with the default ToolTip Title set in the Properties window.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.AlignTextWithTitle">
|
|
<summary>
|
|
When set to true, the <see cref="F:Bunifu.UI.WinForms.BunifuToolTip._toolTipText"/> will be aligned horizontally with the <see cref="P:Bunifu.UI.WinForms.BunifuToolTip.ToolTipTitle"/>
|
|
position. This is especially useful whenever the ToolTipIcon is set.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ShowShadows">
|
|
<summary>
|
|
Gets or sets a value indicating whether display-shadows
|
|
will be provided around the ToolTip's borders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ShowBorders">
|
|
<summary>
|
|
Gets or sets a value indicating whether standard
|
|
borders will be drawn around the ToolTip's region.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.AllowFading">
|
|
<summary>
|
|
When set to true, a fade effect is used
|
|
when ToolTips are shown or hidden.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.AllowAutoClose">
|
|
<summary>
|
|
When set to true, the ToolTip will be closed automatically when a set period
|
|
of time provided by the property 'AutoCloseDuration', is given. However, when
|
|
set to false, the ToolTip will be closed once the mouse leaves the associated control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.Padding">
|
|
<summary>
|
|
Gets or sets the ToolTip's inner padding between the container
|
|
and its content, that is, the Title and Text information. Use
|
|
the 'TextMargin' property to set the vertical distance between
|
|
the ToolTip's Title and Text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.Tag">
|
|
<summary>
|
|
Gets or sets the object that contains programmer-supplied data associated with the ToolTip.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ToolTipTitle">
|
|
<summary>
|
|
Gets or sets the global ToolTipTitle to be implemented
|
|
across all associated controls within the parent control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.Opacity">
|
|
<summary>
|
|
Gets or sets the opacity of transparency-level of the ToolTip.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.InitialDelay">
|
|
<summary>
|
|
Gets or sets the length of time, in milliseconds, it takes before the ToolTip is shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ReshowDelay">
|
|
<summary>
|
|
Gets or sets the length of time, in milliseconds, it takes before subsequent ToolTips are shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.AutoCloseDuration">
|
|
<summary>
|
|
Gets or sets the length of time, in milliseconds, that the ToolTip will be displayed.
|
|
This property is enabled whenever the property 'AllowAutoClose' is set to true.
|
|
The minimum required duration should be greater-than or equal-to 100 (milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.EntryAnimationSpeed">
|
|
<summary>
|
|
Gets or sets the ToolTip's entry animation speed in milliseconds.
|
|
(Default is 350 milliseconds)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ExitAnimationSpeed">
|
|
<summary>
|
|
Gets or sets the ToolTip's exit animation speed in milliseconds.
|
|
(Default is 200 milliseconds)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.IconMargin">
|
|
<summary>
|
|
Gets or sets the margin (distance) between the ToolTipIcon and ToolTipTitle.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.TextMargin">
|
|
<summary>
|
|
Gets or sets the ToolTip's Text margin, that is,
|
|
the distance between the Title and the Text. (Default is 2)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.BackColor">
|
|
<summary>
|
|
Gets or sets the ToolTip's background color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.BorderColor">
|
|
<summary>
|
|
Gets or sets the ToolTip's border color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.TitleForeColor">
|
|
<summary>
|
|
Gets or sets the ToolTip's Title Fore Color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.TextForeColor">
|
|
<summary>
|
|
Gets or sets the ToolTip's Text ForeColor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.TitleFont">
|
|
<summary>
|
|
Gets or sets the ToolTip's Title Font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.TextFont">
|
|
<summary>
|
|
Gets or sets the ToolTip's Text Font.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.SetToolTip(System.Windows.Forms.Control,System.String)">
|
|
<summary>
|
|
Associates ToolTip text with the specified control.
|
|
</summary>
|
|
<param name="control">The <see cref="T:System.Windows.Forms.Control"/> to associate the ToolTip text with.</param>
|
|
<param name="text">The ToolTip text to display when the pointer is on the control.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.GetToolTip(System.Windows.Forms.Control)">
|
|
<summary>
|
|
Retrieves the ToolTip text associated with the specified control.
|
|
</summary>
|
|
<param name="control">
|
|
The <see cref="T:System.Windows.Forms.Control"/> for which to retrieve the
|
|
<see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> text.
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> containing the ToolTip text for the specified control.</returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.SetToolTipIcon(System.Windows.Forms.Control,System.Drawing.Image)">
|
|
<summary>
|
|
Associates ToolTip icon with the specified control.
|
|
</summary>
|
|
<param name="control">The <see cref="T:System.Windows.Forms.Control"/> to associate the ToolTip icon with.</param>
|
|
<param name="text">The ToolTip icon to be applied when the ToolTip is displayed.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.GetToolTipIcon(System.Windows.Forms.Control)">
|
|
<summary>
|
|
Retrieves the ToolTip icon associated with the specified control.
|
|
</summary>
|
|
<param name="control">
|
|
The <see cref="T:System.Windows.Forms.Control"/> for which to retrieve the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> icon.
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> containing the ToolTip icon for the specified control.</returns>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.SetToolTipTitle(System.Windows.Forms.Control,System.String)">
|
|
<summary>
|
|
Associates ToolTip title with the specified control.
|
|
</summary>
|
|
<param name="control">The <see cref="T:System.Windows.Forms.Control"/> to associate the ToolTip title with.</param>
|
|
<param name="text">The ToolTip title to display when the pointer is on the control.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.GetToolTipTitle(System.Windows.Forms.Control)">
|
|
<summary>
|
|
Retrieves the ToolTip title associated with the specified control.
|
|
</summary>
|
|
<param name="control">
|
|
The <see cref="T:System.Windows.Forms.Control"/> for which to retrieve the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> title.
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> containing the ToolTip title for the specified control.</returns>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.Visible">
|
|
<summary>
|
|
Determines if the ToolTip is currently visible.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.DisplayControl">
|
|
<summary>
|
|
Gets or sets a control that will be displayed in the
|
|
ToolTip in-place of the standard ToolTip's view.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ClickToShowDisplayControl">
|
|
<summary>
|
|
Gets or sets a value indicating whether the attached
|
|
<see cref="P:Bunifu.UI.WinForms.BunifuToolTip.DisplayControl"/> will be displayed
|
|
once a user clicks on the associated ToolTip control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.GenerateAutoCloseDuration">
|
|
<summary>
|
|
When set to true, the closing duration will be automagically generated
|
|
based on the size of content, that is, the ToolTipTitle and ToolTipText.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.ToolTipPosition">
|
|
<summary>
|
|
Gets or sets the ToolTip's position within the client region.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.Name">
|
|
<summary>
|
|
Gets or sets the name of the component.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.Show(System.Windows.Forms.Control,System.String)">
|
|
<summary>
|
|
Sets the ToolTip content to be associated with the specified control and displays the ToolTip.
|
|
</summary>
|
|
<param name="control">The control bound or associated with the ToolTip.</param>
|
|
<param name="text">A <see cref="T:System.String"/> containing the new ToolTip text.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.Show(System.Windows.Forms.Control,System.String,System.String)">
|
|
<summary>
|
|
Sets the ToolTip content to be associated with the specified control and displays the ToolTip.
|
|
</summary>
|
|
<param name="control">The control bound or associated with the ToolTip.</param>
|
|
<param name="text">A <see cref="T:System.String"/> containing the new ToolTip text.</param>
|
|
<param name="title">A <see cref="T:System.String"/> containing the new ToolTip title.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.Show(System.Windows.Forms.Control,System.String,System.String,System.Drawing.Image)">
|
|
<summary>
|
|
Sets the ToolTip content to be associated with the specified control and displays the ToolTip.
|
|
</summary>
|
|
<param name="control">The control bound or associated with the ToolTip.</param>
|
|
<param name="text">A <see cref="T:System.String"/> containing the new ToolTip text.</param>
|
|
<param name="title">A <see cref="T:System.String"/> containing the new ToolTip title.</param>
|
|
<param name="icon">An <see cref="T:System.Drawing.Image"/> to be applied as the ToolTip's icon.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.Show(System.Windows.Forms.Control,System.String,System.String,System.Drawing.Image,System.Drawing.Point)">
|
|
<summary>
|
|
Sets the ToolTip content to be associated with the specified control and displays the ToolTip.
|
|
</summary>
|
|
<param name="control">The control bound or associated with the ToolTip.</param>
|
|
<param name="text">A <see cref="T:System.String"/> containing the new ToolTip text.</param>
|
|
<param name="title">A <see cref="T:System.String"/> containing the new ToolTip title.</param>
|
|
<param name="icon">An <see cref="T:System.Drawing.Image"/> to be applied as the ToolTip's icon.</param>
|
|
<param name="location">The set ToolTip's location once displayed.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.Hide">
|
|
<summary>
|
|
Hides the ToolTip when displayed in any associated control(s).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.RemoveAll">
|
|
<summary>
|
|
Removes all the applied ToolTips currently associated with the ToolTip component.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.CanExtend(System.Object)">
|
|
<summary>
|
|
Returns true if the ToolTip can offer an extender property to the specified target
|
|
component.
|
|
</summary>
|
|
<param name="extendee">The target object to add an extender property to.</param>
|
|
<returns>
|
|
Returns true if the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> class can offer
|
|
one or more extender properties; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="E:Bunifu.UI.WinForms.BunifuToolTip.Popup">
|
|
<summary>
|
|
Raised whenever the ToolTip is being shown.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Bunifu.UI.WinForms.BunifuToolTip.Closed">
|
|
<summary>
|
|
Raised whenever the ToolTip is being closed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs">
|
|
<summary>
|
|
Provides data for the ToolTip's <see cref="E:Bunifu.UI.WinForms.BunifuToolTip.Popup"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.#ctor(System.Windows.Forms.Control,System.Windows.Forms.IWin32Window,System.Drawing.Size,System.Drawing.Point,System.String,System.String,System.Drawing.Image,System.Int32)">
|
|
<summary>
|
|
Provides data for the ToolTip's <see cref="E:Bunifu.UI.WinForms.BunifuToolTip.Popup"/> event.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.AssociatedControl">
|
|
<summary>
|
|
Gets the control for which the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> is being drawn.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.DisplayCount">
|
|
<summary>
|
|
Gets the number of times this <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/>
|
|
has been displayed to the user.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.AssociatedWindow">
|
|
<summary>
|
|
Gets the window to which this <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> is bound.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.ToolTipSize">
|
|
<summary>
|
|
Gets the size of the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> when shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.ToolTipLocation">
|
|
<summary>
|
|
Gets the location of the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip"/> when shown.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.ToolTipTitle">
|
|
<summary>
|
|
Gets the current ToolTip Title.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.ToolTipText">
|
|
<summary>
|
|
Gets the current ToolTip Text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Bunifu.UI.WinForms.BunifuToolTip.PopupEventArgs.ToolTipIcon">
|
|
<summary>
|
|
Gets the current ToolTip Icon.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Bunifu.UI.WinForms.BunifuToolTip.BunifuComponentActionList">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Bunifu.UI.WinForms.BunifuToolTip.BunifuComponentActionList"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.BunifuComponentActionList.GetSortedActionItems">
|
|
<summary>
|
|
Implementation of this abstract method creates Smart Tag items,
|
|
associates their targets, and collects them into a list.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Bunifu.UI.WinForms.BunifuToolTip.components">
|
|
<summary>
|
|
Required designer variable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.Dispose(System.Boolean)">
|
|
<summary>
|
|
Clean up any resources being used.
|
|
</summary>
|
|
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
|
</member>
|
|
<member name="M:Bunifu.UI.WinForms.BunifuToolTip.InitializeComponent">
|
|
<summary>
|
|
Required method for Designer support - do not modify
|
|
the contents of this method with the code editor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.IManagedType">
|
|
<summary>
|
|
Interface for all types we can perform transitions on.
|
|
Each type (e.g. int, double, Color) that we can perform a transition on
|
|
needs to have its own class that implements this interface. These classes
|
|
tell the transition system how to act on objects of that type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.IManagedType.getManagedType">
|
|
<summary>
|
|
Returns the Type that the instance is managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.IManagedType.copy(System.Object)">
|
|
<summary>
|
|
Returns a deep copy of the object passed in. (In particular this is
|
|
needed for types that are objects.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.IManagedType.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns an object holding the value between the start and end corresponding
|
|
to the percentage passed in. (Note: the percentage can be less than 0% or
|
|
greater than 100%.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ITransitionType.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Called by the Transition framework when its timer ticks to pass in the
|
|
time (in ms) since the transition started.
|
|
|
|
You should return (in an out parameter) the percentage movement towards
|
|
the destination value for the time passed in. Note: this does not need to
|
|
be a smooth transition from 0% to 100%. You can overshoot with values
|
|
greater than 100% or undershoot if you need to (for example, to have some
|
|
form of "elasticity").
|
|
|
|
The percentage should be returned as (for example) 0.1 for 10%.
|
|
|
|
You should return (in an out parameter) whether the transition has completed.
|
|
(This may not be at the same time as the percentage has moved to 100%.)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.ManagedType_Color">
|
|
<summary>
|
|
Class that manages transitions for Color properties. For these we
|
|
need to transition the R, G, B and A sub-properties independently.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Color.getManagedType">
|
|
<summary>
|
|
Returns the type we are managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Color.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the color object passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Color.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Creates an intermediate value for the colors depending on the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.ManagedType_Double">
|
|
<summary>
|
|
Manages transitions for double properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Double.getManagedType">
|
|
<summary>
|
|
Returns the type managed by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Double.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the double passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Double.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns the value between start and end for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Float.getManagedType">
|
|
<summary>
|
|
Returns the type we're managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Float.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the float passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Float.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns the interpolated value for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.ManagedType_Int">
|
|
<summary>
|
|
Manages transitions for int properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Int.getManagedType">
|
|
<summary>
|
|
Returns the type we are managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Int.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the int passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_Int.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns the value between the start and end for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.ManagedType_String">
|
|
<summary>
|
|
Manages transitions for strings. This doesn't make as much sense as transitions
|
|
on other types, but I like the way it looks!
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_String.getManagedType">
|
|
<summary>
|
|
Returns the type we're managing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_String.copy(System.Object)">
|
|
<summary>
|
|
Returns a copy of the string passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.ManagedType_String.getIntermediateValue(System.Object,System.Object,System.Double)">
|
|
<summary>
|
|
Returns an "interpolated" string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.Transition">
|
|
<summary>
|
|
Lets you perform animated transitions of properties on arbitrary objects. These
|
|
will often be transitions of UI properties, for example an animated fade-in of
|
|
a UI object, or an animated move of a UI object from one position to another.
|
|
|
|
Each transition can simulataneously change multiple properties, including properties
|
|
across multiple objects.
|
|
|
|
Example transition
|
|
------------------
|
|
a. Transition t = new Transition(new TransitionMethod_Linear(500));
|
|
b. t.add(form1, "Width", 500);
|
|
c. t.add(form1, "BackColor", Color.Red);
|
|
d. t.run();
|
|
|
|
Line a: Creates a new transition. You specify the transition method.
|
|
|
|
Lines b. and c: Set the destination values of the properties you are animating.
|
|
|
|
Line d: Starts the transition.
|
|
|
|
Transition methods
|
|
------------------
|
|
TransitionMethod objects specify how the transition is made. Examples include
|
|
linear transition, ease-in-ease-out and so on. Different transition methods may
|
|
need different parameters.
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.#cctor">
|
|
<summary>
|
|
You should register all managed-types here.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.Transition.Args">
|
|
<summary>
|
|
Args passed with the TransitionCompletedEvent.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.Transitions.Transition.TransitionCompletedEvent">
|
|
<summary>
|
|
Event raised when the transition hass completed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.run(System.Object,System.String,System.Object,Utilities.BunifuToolTip.Transitions.ITransitionType)">
|
|
<summary>
|
|
Creates and immediately runs a transition on the property passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.run(System.Object,System.String,System.Object,System.Object,Utilities.BunifuToolTip.Transitions.ITransitionType)">
|
|
<summary>
|
|
Sets the property passed in to the initial value passed in, then creates and
|
|
immediately runs a transition on it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.runChain(Utilities.BunifuToolTip.Transitions.Transition[])">
|
|
<summary>
|
|
Creates a TransitionChain and runs it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.#ctor(Utilities.BunifuToolTip.Transitions.ITransitionType)">
|
|
<summary>
|
|
Constructor. You pass in the object that holds the properties
|
|
that you are performing transitions on.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.add(System.Object,System.String,System.Object)">
|
|
<summary>
|
|
Adds a property that should be animated as part of this transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.run">
|
|
<summary>
|
|
Starts the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.Transitions.Transition.TransitionedProperties">
|
|
<summary>
|
|
Property that returns a list of information about each property managed
|
|
by this transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.removeProperty(Utilities.BunifuToolTip.Transitions.Transition.TransitionedPropertyInfo)">
|
|
<summary>
|
|
We remove the property with the info passed in from the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.onTimer">
|
|
<summary>
|
|
Called when the transition timer ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.setProperty(System.Object,Utilities.BunifuToolTip.Transitions.Transition.PropertyUpdateArgs)">
|
|
<summary>
|
|
Sets a property on the object passed in to the value passed in. This method
|
|
invokes itself on the GUI thread if the property is being invoked on a GUI
|
|
object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.isDisposed(System.Object)">
|
|
<summary>
|
|
Returns true if the object passed in is a Control and is disposed
|
|
or in the process of disposing. (If this is the case, we don't want
|
|
to make any changes to its properties.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Transition.registerType(Utilities.BunifuToolTip.Transitions.IManagedType)">
|
|
<summary>
|
|
Registers a transition-type. We hold them in a map.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionChain.runNextTransition">
|
|
<summary>
|
|
Runs the next transition in the list.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionChain.onTransitionCompleted(System.Object,Utilities.BunifuToolTip.Transitions.Transition.Args)">
|
|
<summary>
|
|
Called when the transition we have just run has completed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionElement.#ctor(System.Double,System.Double,Utilities.BunifuToolTip.Transitions.InterpolationMethod)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.Transitions.TransitionElement.EndTime">
|
|
<summary>
|
|
The percentage of elapsed time, expressed as (for example) 75 for 75%.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.Transitions.TransitionElement.EndValue">
|
|
<summary>
|
|
The value of the animated properties at the EndTime. This is the percentage
|
|
movement of the properties between their start and end values. This should
|
|
be expressed as (for example) 75 for 75%.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.Transitions.TransitionElement.InterpolationMethod">
|
|
<summary>
|
|
The interpolation method to use when moving between the previous value
|
|
and the current one.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionManager">
|
|
<summary>
|
|
This class is responsible for running transitions. It holds the timer that
|
|
triggers transaction animation.
|
|
</summary><remarks>
|
|
This class is a singleton.
|
|
|
|
We manage the transaction timer here so that we can have a single timer
|
|
across all transactions. If each transaction has its own timer, this creates
|
|
one thread for each transaction, and this can lead to too many threads in
|
|
an application.
|
|
|
|
This class essentially just manages the timer for the transitions. It calls
|
|
back into the running transitions, which do the actual work of the transition.
|
|
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionManager.getInstance">
|
|
<summary>
|
|
Singleton's getInstance method.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionManager.register(Utilities.BunifuToolTip.Transitions.Transition)">
|
|
<summary>
|
|
You register a transition with the manager here. This will start to run
|
|
the transition as the manager's timer ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionManager.removeDuplicates(Utilities.BunifuToolTip.Transitions.Transition)">
|
|
<summary>
|
|
Checks if any existing transitions are acting on the same properties as the
|
|
transition passed in. If so, we remove the duplicated properties from the
|
|
older transitions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionManager.removeDuplicates(Utilities.BunifuToolTip.Transitions.Transition,Utilities.BunifuToolTip.Transitions.Transition)">
|
|
<summary>
|
|
Finds any properties in the old-transition that are also in the new one,
|
|
and removes them from the old one.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionManager.#ctor">
|
|
<summary>
|
|
Private constructor (for singleton).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionManager.onTimerElapsed(System.Object,System.Timers.ElapsedEventArgs)">
|
|
<summary>
|
|
Called when the timer ticks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionManager.onTransitionCompleted(System.Object,Utilities.BunifuToolTip.Transitions.Transition.Args)">
|
|
<summary>
|
|
Called when a transition has completed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_Acceleration">
|
|
<summary>
|
|
Manages transitions under constant acceleration from a standing start.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Acceleration.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Acceleration.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Works out the percentage completed given the time passed in.
|
|
This uses the formula:
|
|
s = ut + 1/2at^2
|
|
The initial velocity is 0, and the acceleration to get to 1.0
|
|
at t=1.0 is 2, so the formula just becomes:
|
|
s = t^2
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_Bounce">
|
|
<summary>
|
|
This transition bounces the property to a destination value and back to the
|
|
original value. It is accelerated to the destination and then decelerated back
|
|
as if being dropped with gravity and bouncing back against gravity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Bounce.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the total time taken for the bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_CriticalDamping">
|
|
<summary>
|
|
This transition animates with an exponential decay. This has a damping effect
|
|
similar to the motion of a needle on an electomagnetically controlled dial.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_CriticalDamping.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_CriticalDamping.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_Deceleration">
|
|
<summary>
|
|
Manages a transition starting from a high speed and decelerating to zero by
|
|
the end of the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Deceleration.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Deceleration.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Works out the percentage completed given the time passed in.
|
|
This uses the formula:
|
|
s = ut + 1/2at^2
|
|
The initial velocity is 2, and the acceleration to get to 1.0
|
|
at t=1.0 is -2, so the formula becomes:
|
|
s = t(2-t)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_EaseInEaseOut">
|
|
<summary>
|
|
Manages an ease-in-ease-out transition. This accelerates during the first
|
|
half of the transition, and then decelerates during the second half.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_EaseInEaseOut.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time that the transition
|
|
will take (in milliseconds).
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_EaseInEaseOut.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Works out the percentage completed given the time passed in.
|
|
This uses the formula:
|
|
s = ut + 1/2at^2
|
|
We accelerate as at the rate needed (a=4) to get to 0.5 at t=0.5, and
|
|
then decelerate at the same rate to end up at 1.0 at t=1.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_Flash">
|
|
<summary>
|
|
This transition type 'flashes' the properties a specified number of times, ending
|
|
up by reverting them to their initial values. You specify the number of bounces and
|
|
the length of each bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Flash.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
You specify the number of bounces and the time taken for each bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_Linear">
|
|
<summary>
|
|
This class manages a linear transition. The percentage complete for the transition
|
|
increases linearly with time.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Linear.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the time (in milliseconds) that the
|
|
transition will take.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_Linear.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
We return the percentage completed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_ThrowAndCatch">
|
|
<summary>
|
|
This transition bounces the property to a destination value and back to the
|
|
original value. It is decelerated to the destination and then acclerated back
|
|
as if being thrown against gravity and then descending back with gravity.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_ThrowAndCatch.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the total time taken for the bounce.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.TransitionType_UserDefined">
|
|
<summary>
|
|
This class allows you to create user-defined transition types. You specify these
|
|
as a list of TransitionElements. Each of these defines:
|
|
End time , End value, Interpolation method
|
|
|
|
For example, say you want to make a bouncing effect with a decay:
|
|
|
|
EndTime% EndValue% Interpolation
|
|
-------- --------- -------------
|
|
50 100 Acceleration
|
|
75 50 Deceleration
|
|
85 100 Acceleration
|
|
91 75 Deceleration
|
|
95 100 Acceleration
|
|
98 90 Deceleration
|
|
100 100 Acceleration
|
|
|
|
The time values are expressed as a percentage of the overall transition time. This
|
|
means that you can create a user-defined transition-type and then use it for transitions
|
|
of different lengths.
|
|
|
|
The values are percentages of the values between the start and end values of the properties
|
|
being animated in the transitions. 0% is the start value and 100% is the end value.
|
|
|
|
The interpolation is one of the values from the InterpolationMethod enum.
|
|
|
|
So the example above accelerates to the destination (as if under gravity) by
|
|
t=50%, then bounces back up to half the initial height by t=75%, slowing down
|
|
(as if against gravity) before falling down again and bouncing to decreasing
|
|
heights each time.
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_UserDefined.#ctor">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_UserDefined.#ctor(System.Collections.Generic.IList{Utilities.BunifuToolTip.Transitions.TransitionElement},System.Int32)">
|
|
<summary>
|
|
Constructor. You pass in the list of TransitionElements and the total time
|
|
(in milliseconds) for the transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_UserDefined.setup(System.Collections.Generic.IList{Utilities.BunifuToolTip.Transitions.TransitionElement},System.Int32)">
|
|
<summary>
|
|
Sets up the transitions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_UserDefined.onTimer(System.Int32,System.Double@,System.Boolean@)">
|
|
<summary>
|
|
Called to find the value for the movement of properties for the time passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.TransitionType_UserDefined.getElementInfo(System.Double,System.Double@,System.Double@,System.Double@,System.Double@,Utilities.BunifuToolTip.Transitions.InterpolationMethod@)">
|
|
<summary>
|
|
Returns the element info for the time-fraction passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Transitions.Utility">
|
|
<summary>
|
|
A class holding static utility functions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.getValue(System.Object,System.String)">
|
|
<summary>
|
|
Returns the value of the property passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.setValue(System.Object,System.String,System.Object)">
|
|
<summary>
|
|
Sets the value of the property passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.interpolate(System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Returns a value between d1 and d2 for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.interpolate(System.Int32,System.Int32,System.Double)">
|
|
<summary>
|
|
Returns a value betweeen i1 and i2 for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.interpolate(System.Single,System.Single,System.Double)">
|
|
<summary>
|
|
Returns a value betweeen f1 and f2 for the percentage passed in.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.convertLinearToEaseInEaseOut(System.Double)">
|
|
<summary>
|
|
Converts a fraction representing linear time to a fraction representing
|
|
the distance traveled under an ease-in-ease-out transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.convertLinearToAcceleration(System.Double)">
|
|
<summary>
|
|
Converts a fraction representing linear time to a fraction representing
|
|
the distance traveled under a constant acceleration transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.convertLinearToDeceleration(System.Double)">
|
|
<summary>
|
|
Converts a fraction representing linear time to a fraction representing
|
|
the distance traveled under a constant deceleration transition.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Transitions.Utility.raiseEvent``1(System.EventHandler{``0},System.Object,``0)">
|
|
<summary>
|
|
Fires the event passed in in a thread-safe way.
|
|
</summary><remarks>
|
|
This method loops through the targets of the event and invokes each in turn. If the
|
|
target supports ISychronizeInvoke (such as forms or controls) and is set to run
|
|
on a different thread, then we call BeginInvoke to marshal the event to the target
|
|
thread. If the target does not support this interface (such as most non-form classes)
|
|
or we are on the same thread as the target, then the event is fired on the same
|
|
thread as this is called from.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.BunifuImageButtonExtended">
|
|
<summary>
|
|
Provides button-like capabilities and image manipulation features when working with images.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.BunifuImageButtonExtended.FlipOrientation">
|
|
<summary>
|
|
Provides flip-orientation options for images.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.FlipOrientation.Normal">
|
|
<summary>
|
|
Flip image to normal view.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.FlipOrientation.Horizontal">
|
|
<summary>
|
|
Flip image horizontally.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.FlipOrientation.Vertical">
|
|
<summary>
|
|
Flip image vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageStates">
|
|
<summary>
|
|
Provides the various supported image-states
|
|
generated from the applied Image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageStates.Normal">
|
|
<summary>
|
|
Returns the normal image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageStates.TotallyFaded">
|
|
<summary>
|
|
Returns a totally blurred image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageStates.MediallyFaded">
|
|
<summary>
|
|
Returns a medially blurred image.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageStates.PartiallyFaded">
|
|
<summary>
|
|
Returns a partially blurred image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageMargin">
|
|
<summary>
|
|
Gets or sets the distance between the container and the underlying image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.Zoom">
|
|
<summary>
|
|
Gets or sets the distance between the container and the underlying image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.Rotation">
|
|
<summary>
|
|
Gets or sets the angle of rotation for the image.
|
|
Please provide a value between 0 and 360.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ZoomSpeed">
|
|
<summary>
|
|
Gets or sets the time in milliseconds the zooming animation takes when active.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.Flip">
|
|
<summary>
|
|
Flips the image to any given orientation.
|
|
Supports both Vertical and Horizontal orientation-flipping options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.Image">
|
|
<summary>
|
|
Gets or sets the image displayed in the image button.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageActive">
|
|
<summary>
|
|
(This property has been deprecated as of version 1.6.0.0. Please use the property 'ActiveImage' instead.)
|
|
Gets or sets the image to be applied whenever the image button is active or hovered onto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ActiveImage">
|
|
<summary>
|
|
Gets or sets the image to be applied whenever the image button is active or hovered onto.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageSize">
|
|
<summary>
|
|
Gets or sets the default image size.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageZoomSize">
|
|
<summary>
|
|
Gets or sets the maximum size of the image when hovered onto or active.
|
|
This defaults to the standard set size of the control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ToolTipText">
|
|
<summary>
|
|
Allows you to easily get or set some ToolTip information to
|
|
be displayed to the user on mouse-hovering over the control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ShowCursorChanges">
|
|
<summary>
|
|
Gets or sets a value indicating whether the control
|
|
will show cursor changes during mouse-hover events.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ShowActiveImage">
|
|
<summary>
|
|
Sets a value indicating whether the 'ActiveImage'
|
|
will be applied on mouse-hover.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.AllowZooming">
|
|
<summary>
|
|
Gets or sets a value indicating whether zooming is enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.AllowAnimations">
|
|
<summary>
|
|
Gets or sets a value indicating whether animations are enabled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.FadeWhenInactive">
|
|
<summary>
|
|
Automatically fades the image when inactive.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.IsZoomedIn">
|
|
<summary>
|
|
Gets a value indicating whether the image button is currently zoomed-in.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ShowSizeMarkers">
|
|
<summary>
|
|
Gets or sets a value indicating whether the size markers
|
|
displayed at the control's top-area will be visible during design-time.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ShowImageBorders">
|
|
<summary>
|
|
Gets or sets a value indicating whether borders will
|
|
be viewed for the image applied during design-time.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.CreateParams">
|
|
<summary>
|
|
Overrides the CreateParams method to stop flickering issues
|
|
by setting the "WS_EX_COMPOSITED" (0x02000000) style.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageLocation">
|
|
<summary>
|
|
Gets or sets the path or URL for the image to display in the Image Button.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.WaitOnLoad">
|
|
<summary>
|
|
Gets or sets a value indicating whether an image is loaded synchronously.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.InitialImage">
|
|
<summary>
|
|
Gets or sets the image displayed in the Image
|
|
Button when the main image is loading.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuImageButtonExtended.ErrorImage">
|
|
<summary>
|
|
Gets or sets the image displayed in the Image
|
|
Button when an error occurs during the image-loading
|
|
process or if the image load is canceled.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.Calculate">
|
|
<summary>
|
|
Calculates the correct image-size as per the applied state.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.Render(Utilities.BunifuToolTip.BunifuImageButtonExtended.ImageStates)">
|
|
<summary>
|
|
Renders the required image as per the applied state.
|
|
</summary>
|
|
<param name="state">The image-state-type to be used.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.Render(System.Int32)">
|
|
<summary>
|
|
Renders the required image as per the applied state.
|
|
</summary>
|
|
<param name="state">The image-state to be used.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.ZoomIn">
|
|
<summary>
|
|
Zooms in the image to the preset size.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.ZoomOut">
|
|
<summary>
|
|
Zooms out the image to its default size.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.Rotate(System.Int32,System.Boolean,System.Int32)">
|
|
<summary>
|
|
Rotates the image to a set angle of rotation.
|
|
</summary>
|
|
<param name="allowAnimation">
|
|
Allow animation the rotation event? If yes, the rotation will be animated from one angle to another.
|
|
</param>
|
|
<param name="angle">
|
|
The angle of rotation to apply. Please provide a value between 0 and 360.
|
|
</param>
|
|
<param name="animationSpeed">
|
|
The rotating animation speed in milliseconds to apply. Default speed is 500(ms).
|
|
</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.Load(System.String)">
|
|
<summary>
|
|
Sets the ImageLocation to the specified URL and displays the image indicated.
|
|
</summary>
|
|
<param name="url">The path for the image to display in the Image Button.</param>
|
|
Exceptions:
|
|
<exception cref="T:System.InvalidOperationException">Thrown if url is null or an empty string.</exception>
|
|
<exception cref="T:System.Net.WebException">Thrown if url refers to an image on the Web that cannot be accessed.</exception>
|
|
<exception cref="T:System.ArgumentException">Thrown if url refers to a file that is not an image.</exception>
|
|
<exception cref="!:IO.FileNotFoundException">Thrown if url refers to a file that does not exist.</exception>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.Load">
|
|
<summary>
|
|
Displays the image specified by the ImageLocation property of the Image Button.
|
|
</summary>
|
|
Exceptions:
|
|
<exception cref="T:System.InvalidOperationException">Thrown if ImageLocation is null or an empty string.</exception>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.LoadAsync">
|
|
<summary>
|
|
Loads the image asynchronously.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.LoadAsync(System.String)">
|
|
<summary>
|
|
Loads the image at the specified location, asynchronously.
|
|
</summary>
|
|
<param name="url">The path for the image to display in the Image Button.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.CancelAsync">
|
|
<summary>
|
|
Cancels an asynchronous image load.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.IsInDesignMode">
|
|
<summary>
|
|
Determines whether the hosting process is in design-mode.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuImageButtonExtended.components">
|
|
<summary>
|
|
Required designer variable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.Dispose(System.Boolean)">
|
|
<summary>
|
|
Clean up any resources being used.
|
|
</summary>
|
|
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuImageButtonExtended.InitializeComponent">
|
|
<summary>
|
|
Required method for Designer support - do not modify
|
|
the contents of this method with the code editor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.ImageExtensions">
|
|
<summary>
|
|
Image-rendering extensions class for Bunifu Image Button.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.ImageExtensions.FlipOrientation">
|
|
<summary>
|
|
Provides flip-orientation options for image containers.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.ImageExtensions.FlipOrientation.Normal">
|
|
<summary>
|
|
Flip image to normal setting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.ImageExtensions.FlipOrientation.Horizontal">
|
|
<summary>
|
|
Flip image horizontally.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.ImageExtensions.FlipOrientation.Vertical">
|
|
<summary>
|
|
Flip image vertically.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.ImageExtensions.Rotate(System.Drawing.Graphics,System.Double,System.Int32,System.Int32)">
|
|
<summary>
|
|
Rotates an image container to a specified angle or degree.
|
|
</summary>
|
|
<param name="graphics">The graphics object to be used.</param>
|
|
<param name="rotation">The angle of rotation.</param>
|
|
<param name="width">The final width of the image.</param>
|
|
<param name="height">The final height of the image.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.ImageExtensions.Flip(System.Drawing.Graphics,Utilities.BunifuToolTip.ImageExtensions.FlipOrientation,System.Int32,System.Int32)">
|
|
<summary>
|
|
Flips an image container to a specified position.
|
|
</summary>
|
|
<param name="graphics">The graphics object to be used.</param>
|
|
<param name="flip">The flip orientation.</param>
|
|
<param name="width">The final width of the image.</param>
|
|
<param name="height">The final height of the image.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.ImageExtensions.Flip(System.Drawing.Image,Utilities.BunifuToolTip.ImageExtensions.FlipOrientation)">
|
|
<summary>
|
|
Flips an image container to a specified position.
|
|
</summary>
|
|
<param name="graphics">The graphics object to be used.</param>
|
|
<param name="flip">The flip orientation.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.ImageExtensions.ToRotateFlip(Utilities.BunifuToolTip.ImageExtensions.FlipOrientation)">
|
|
<summary>
|
|
Flips an image container to a specified position without an angle of rotation.
|
|
</summary>
|
|
<param name="flip">The flip orientation.</param>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.BunifuLabel">
|
|
<summary>
|
|
Provides rich HTML text-rendering capabilities with native CSS 2.0 styling enhancements and inline style-tags.
|
|
</summary>
|
|
<seealso cref="T:System.Windows.Forms.Control" />
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.#ctor">
|
|
<summary>
|
|
Creates a new Bunifu Label.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.BunifuLabel.TextAlignments">
|
|
<summary>
|
|
Bunifu Label Text Alignments options.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextAlignments.Left">
|
|
<summary>
|
|
Positions the text to the Left of the container.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextAlignments.Right">
|
|
<summary>
|
|
Positions the text to the Right of the container.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextAlignments.Center">
|
|
<summary>
|
|
Positions the text to the Center of the container.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.BunifuLabel.TextFormattingOptions">
|
|
<summary>
|
|
Provides a list of text-formatting options
|
|
for Bunifu Labels.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextFormattingOptions.Default">
|
|
<summary>
|
|
Retains the default text format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextFormattingOptions.UpperCase">
|
|
<summary>
|
|
Converts the text to upper-case.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextFormattingOptions.LowerCase">
|
|
<summary>
|
|
Converts the text to lower-case.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextFormattingOptions.TitleCase">
|
|
<summary>
|
|
Converts the text to title-case.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.BunifuLabel.TextFormattingOptions.SentenceCase">
|
|
<summary>
|
|
Converts the text to sentence-case.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.AllowParentOverrides">
|
|
<summary>
|
|
Gets or sets a value indicating whether the label will inherit
|
|
its parent font and fore color properties.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.Text">
|
|
<summary>
|
|
Gets or sets the label text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.BackColor">
|
|
<summary>
|
|
Gets or sets the background color of the label.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.TextRenderingHint">
|
|
<summary>
|
|
The text rendering hint to be used for rendering text.
|
|
</summary>
|
|
<value>The text rendering hint.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.BorderStyle">
|
|
<summary>
|
|
Gets or sets the border style.
|
|
</summary>
|
|
<value>The border style.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.Font">
|
|
<summary>
|
|
Gets or sets the font of the text displayed by the control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.ForeColor">
|
|
<summary>
|
|
Gets or sets the foreground color of the label.
|
|
</summary>
|
|
<value>The color of the label.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.RightToLeft">
|
|
<summary>
|
|
Gets or sets a value indicating whether control's elements are aligned to support
|
|
locales using right-to-left fonts. You can also use the following inline CSS style:
|
|
style="text-align: right; direction: Rtl;"
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.TextAlignment">
|
|
<summary>
|
|
Determines the position of the text within the label.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.TextFormat">
|
|
<summary>
|
|
Provides a number of text-formatting options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.TextAlign">
|
|
<summary>
|
|
Determines the position of the text within the label.
|
|
(This property is no longer supported. Please use 'TextAlignment' instead.)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.Cursor">
|
|
<summary>
|
|
Gets or sets the cursor that is displayed when the mouse pointer is over the control.
|
|
</summary>
|
|
<value>The cursor.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.EllipsisFormat">
|
|
<summary>
|
|
Gets or sets the ellipsis format to be applied whenever the range of text exceeds the control's width.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.AutoEllipsis">
|
|
<summary>
|
|
Gets or sets a value indicating whether the ellipsis character (...) appears at the right edge (default position)
|
|
of the <see cref="T:Utilities.BunifuToolTip.BunifuLabel"/> control, denoting that the label's text extends beyond the length of the label.
|
|
This is only possible if the properties <see cref="P:Utilities.BunifuToolTip.BunifuLabel.AutoSize"/> and <see cref="P:Utilities.BunifuToolTip.BunifuLabel.AutoSizeHeightOnly"/>
|
|
are set to <see cref="!:false"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.UseGdiPlusTextRendering">
|
|
<summary>
|
|
Use GDI+ text rendering to measure/draw text.<br />
|
|
</summary>
|
|
<value><c>true</c> If [use GDI text rendering]; otherwise, <c>false</c>.</value>
|
|
<remarks><para>
|
|
GDI+ text rendering is less smooth than GDI text rendering bnut it natively supports alpha chanel
|
|
thus allows creating transparent images.
|
|
</para>
|
|
<para>
|
|
While using GDI+ text rendering, you can control the text rendering using <see cref="P:System.Drawing.Graphics.TextRenderingHint" />, note that
|
|
using <see cref="F:System.Drawing.Text.TextRenderingHint.ClearTypeGridFit" /> doesn't work well with transparent background.
|
|
</para></remarks>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.ConvertNewlinesToBreakTags">
|
|
<summary>
|
|
Gets or sets a value indicating whether to allow conversion of newline characters to HTML break tags.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.UseSystemCursors">
|
|
<summary>
|
|
If to use cursors defined by the operating system or .NET cursors
|
|
</summary>
|
|
<value><c>true</c> if [use system cursors]; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.UseWaitCursor">
|
|
<summary>
|
|
Gets or sets a value indicating whether to use the wait cursor for the current
|
|
control and all child controls.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.AvoidGeometryAntialias">
|
|
<summary>
|
|
Gets or sets a value indicating if anti-aliasing should be avoided for geometry like backgrounds and borders (default - false).
|
|
</summary>
|
|
<value><c>true</c> if [avoid geometry antialias]; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.IsSelectionEnabled">
|
|
<summary>
|
|
Is content selection is enabled for the rendered html (default - true).<br />
|
|
If set to 'false' the rendered html will be static only with ability to click on links.
|
|
</summary>
|
|
<value><c>true</c> if this instance is selection enabled; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.IsContextMenuEnabled">
|
|
<summary>
|
|
Is the build-in context menu enabled and will be shown on mouse right click (default - true)
|
|
</summary>
|
|
<value><c>true</c> if this instance is context menu enabled; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.AutoSizeHeightOnly">
|
|
<summary>
|
|
Automatically sets the height of the label by content height (width is not effected).
|
|
</summary>
|
|
<value><c>true</c> if [automatic size height only]; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.AutoSize">
|
|
<summary>
|
|
Automatically sets the size of the label by content size
|
|
</summary>
|
|
<value><c>true</c> if [automatic size]; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.AllowDrop">
|
|
<summary>
|
|
Gets or sets a value indicating whether the control can accept data that the user drags onto it.
|
|
Returns [true] if drag-and-drop operations are allowed in the control; otherwise, [false]. The default is [false].
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.BaseStylesheet">
|
|
<summary>
|
|
Set base stylesheet to be used by html rendered in the panel.
|
|
</summary>
|
|
<value>The base stylesheet.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.MaximumSize">
|
|
<summary>
|
|
Gets or sets the max size the control get be set by <see cref="P:Utilities.BunifuToolTip.BunifuLabel.AutoSize" /> or <see cref="P:Utilities.BunifuToolTip.BunifuLabel.AutoSizeHeightOnly" />.
|
|
</summary>
|
|
<value>The maximum size.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.MinimumSize">
|
|
<summary>
|
|
Gets or sets the min size the control get be set by <see cref="P:Utilities.BunifuToolTip.BunifuLabel.AutoSize" /> or <see cref="P:Utilities.BunifuToolTip.BunifuLabel.AutoSizeHeightOnly" />.
|
|
</summary>
|
|
<value>The minimum size.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.CursorType">
|
|
<summary>
|
|
[Variant] Gets or sets the cursor that is displayed when the mouse pointer is over the control.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.SelectedText">
|
|
<summary>
|
|
Get the currently selected text segment in the html.
|
|
</summary>
|
|
<value>The selected text.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.SelectedHtml">
|
|
<summary>
|
|
Copy the currently selected html segment with style.
|
|
</summary>
|
|
<value>The selected HTML.</value>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.CreateParams">
|
|
<summary>
|
|
Override to support border for the control.
|
|
</summary>
|
|
<value>The create parameters.</value>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.GetHtml">
|
|
<summary>
|
|
Get html from the current DOM tree with inline style.
|
|
</summary>
|
|
<returns>generated html</returns>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.GetElementRectangle(System.String)">
|
|
<summary>
|
|
Get the rectangle of html element as calculated by html layout.<br />
|
|
Element if found by id (id attribute on the html element).<br />
|
|
Note: to get the screen rectangle you need to adjust by the hosting control.<br />
|
|
</summary>
|
|
<param name="elementId">the id of the element to get its rectangle</param>
|
|
<returns>the rectangle of the element or null if not found</returns>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.ClearSelection">
|
|
<summary>
|
|
Clear the current selection.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Utilities.BunifuToolTip.BunifuLabel.InDesignMode">
|
|
<summary>
|
|
Determines whether the hosting process is in design-mode as per the LicenseManager module.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.ToSentenceCase(System.String)">
|
|
<summary>
|
|
Converts a string to sentence-case format.
|
|
</summary>
|
|
<param name="text"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.Render(System.Boolean)">
|
|
<summary>
|
|
Renders the text content in HTML format.
|
|
</summary>
|
|
<param name="rightToLeft">
|
|
Render in RightToLeft (RTL) format?
|
|
</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.WndProc(System.Windows.Forms.Message@)">
|
|
<summary>
|
|
Override the proc processing method to set OS specific hand cursor.
|
|
</summary>
|
|
<param name="m">The Windows <see cref="T:System.Windows.Forms.Message" /> to process.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.Dispose(System.Boolean)">
|
|
<summary>
|
|
Release the html container resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.BunifuLabel.EllipsisFormatChanged">
|
|
<summary>
|
|
Raised when the EllipsisFormat property value changes.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.BunifuLabel.BorderStyleChanged">
|
|
<summary>
|
|
Raised when the BorderStyle property value changes.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.BunifuLabel.LoadComplete">
|
|
<summary>
|
|
Raised when the set html document has been fully loaded.<br/>
|
|
Allows manipulation of the html dom, scroll position, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.BunifuLabel.LinkClicked">
|
|
<summary>
|
|
Raised when the user clicks on a link in the html.<br/>
|
|
Allows canceling the execution of the link.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.BunifuLabel.RenderError">
|
|
<summary>
|
|
Raised when an error occurred during html rendering.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.BunifuLabel.ImageLoad">
|
|
<summary>
|
|
Raised when an image is about to be loaded by file path or URI.<br/>
|
|
This event allows to provide the image manually, if not handled the image will be loaded from file or download from URI.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnBorderStyleChanged(System.EventArgs)">
|
|
<summary>
|
|
Raises the <see cref="E:Utilities.BunifuToolTip.BunifuLabel.BorderStyleChanged" /> event.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnLoadComplete(System.EventArgs)">
|
|
<summary>
|
|
Propagate the LoadComplete event from root container.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnLinkClicked(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs)">
|
|
<summary>
|
|
Propagate the LinkClicked event from root container.
|
|
</summary>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnRenderError(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs)">
|
|
<summary>
|
|
Propagate the Render Error event from root container.
|
|
</summary>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnImageLoad(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs)">
|
|
<summary>
|
|
Propagate the image load event from root container.
|
|
</summary>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnRefresh(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs)">
|
|
<summary>
|
|
Handle html renderer invalidate and re-layout as requested.
|
|
</summary>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnLoadComplete(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Handles the <see cref="E:LoadComplete" /> event.
|
|
</summary>
|
|
<param name="sender">The sender.</param>
|
|
<param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnLinkClicked(System.Object,TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs)">
|
|
<summary>
|
|
Handles the <see cref="E:LinkClicked" /> event.
|
|
</summary>
|
|
<param name="sender">The sender.</param>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnRenderError(System.Object,TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs)">
|
|
<summary>
|
|
Handles the <see cref="E:RenderError" /> event.
|
|
</summary>
|
|
<param name="sender">The sender.</param>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnImageLoad(System.Object,TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs)">
|
|
<summary>
|
|
Handles the <see cref="E:ImageLoad" /> event.
|
|
</summary>
|
|
<param name="sender">The sender.</param>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnRefresh(System.Object,TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs)">
|
|
<summary>
|
|
Handles the <see cref="E:Refresh" /> event.
|
|
</summary>
|
|
<param name="sender">The sender.</param>
|
|
<param name="e">The <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnParentForeColorChanged(System.EventArgs)">
|
|
<summary>
|
|
Raises the <see cref="E:System.Windows.Forms.Control.ForeColorChanged"/>
|
|
event when the <see cref="P:System.Windows.Forms.Control.ForeColor" /> property
|
|
value of the control's container changes.
|
|
</summary>
|
|
<param name="e">
|
|
An <see cref="T:System.EventArgs"/>
|
|
that contains the event data.
|
|
</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnParentFontChanged(System.EventArgs)">
|
|
<summary>
|
|
Raises the <see cref="M:Utilities.BunifuToolTip.BunifuLabel.OnParentFontChanged(System.EventArgs)"/> event
|
|
when the parent font changes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnParentChanged(System.EventArgs)">
|
|
<summary>
|
|
Raises the <see cref="M:Utilities.BunifuToolTip.BunifuLabel.OnParentChanged(System.EventArgs)"/> event
|
|
when the parent control changes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnResize(System.EventArgs)">
|
|
<summary>
|
|
Perform text-rendering while control is being resized.
|
|
</summary>
|
|
<param name="e"></param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnLayout(System.Windows.Forms.LayoutEventArgs)">
|
|
<summary>
|
|
Perform the layout of the html in the control.
|
|
</summary>
|
|
<param name="levent">The <see cref="T:System.Windows.Forms.LayoutEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnPaint(System.Windows.Forms.PaintEventArgs)">
|
|
<summary>
|
|
Perform paint of the html in the control.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.Windows.Forms.PaintEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnMouseMove(System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse move to handle hover cursor and text selection.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.Windows.Forms.MouseEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnMouseDown(System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse down to handle selection.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.Windows.Forms.MouseEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnMouseLeave(System.EventArgs)">
|
|
<summary>
|
|
Handle mouse leave to handle cursor change.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnMouseUp(System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse up to handle selection and link click.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.Windows.Forms.MouseEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.BunifuLabel.OnMouseDoubleClick(System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse double click to select word under the mouse.
|
|
</summary>
|
|
<param name="e">The <see cref="T:System.Windows.Forms.MouseEventArgs"/> instance containing the event data.</param>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Ellipsis">
|
|
<summary>
|
|
Provides ellipsis-handling tasks and features for controls.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Ellipsis.EllipsisChars">
|
|
<summary>
|
|
String used as a placeholder for trimmed text.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Utilities.BunifuToolTip.Ellipsis.EllipsisFormat">
|
|
<summary>
|
|
Specifies ellipsis format and alignment.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Ellipsis.EllipsisFormat.None">
|
|
<summary>
|
|
Text is not modified.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Ellipsis.EllipsisFormat.End">
|
|
<summary>
|
|
Text is trimmed at the end of the string. An ellipsis (...) is drawn in place of remaining text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Ellipsis.EllipsisFormat.Start">
|
|
<summary>
|
|
Text is trimmed at the begining of the string. An ellipsis (...) is drawn in place of remaining text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Ellipsis.EllipsisFormat.Middle">
|
|
<summary>
|
|
Text is trimmed in the middle of the string. An ellipsis (...) is drawn in place of remaining text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Ellipsis.EllipsisFormat.Path">
|
|
<summary>
|
|
Preserve as much as possible of the drive and filename information. Must be combined with alignment information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Ellipsis.EllipsisFormat.Word">
|
|
<summary>
|
|
Text is trimmed at a word boundary. Must be combined with alignment information.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Ellipsis.Compact(System.String,System.Windows.Forms.Control,Utilities.BunifuToolTip.Ellipsis.EllipsisFormat)">
|
|
<summary>
|
|
Truncates a text string to fit within a given control width by replacing trimmed text with ellipses.
|
|
</summary>
|
|
<param name="text">The text or string to be trimmed.</param>
|
|
<param name="control">
|
|
The control whose Text property will be trimmed-down.
|
|
The Text must fit within control's width.
|
|
The control's Font is used to measure the Text string.
|
|
</param>
|
|
<param name="options">The format and alignment of the ellipsis.</param>
|
|
<returns>This function returns the text trimmed to the specified control's width.</returns>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Views.HTMLEditor.components">
|
|
<summary>
|
|
Required designer variable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Views.HTMLEditor.Dispose(System.Boolean)">
|
|
<summary>
|
|
Clean up any resources being used.
|
|
</summary>
|
|
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Views.HTMLEditor.InitializeComponent">
|
|
<summary>
|
|
Required method for Designer support - do not modify
|
|
the contents of this method with the code editor.
|
|
</summary>
|
|
</member>
|
|
<member name="E:Utilities.BunifuToolTip.Views.ToolTipView.Closed">
|
|
<summary>
|
|
Occurs whenever the ToolTip is being closed.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Utilities.BunifuToolTip.Views.ToolTipView.components">
|
|
<summary>
|
|
Required designer variable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Views.ToolTipView.Dispose(System.Boolean)">
|
|
<summary>
|
|
Clean up any resources being used.
|
|
</summary>
|
|
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
|
</member>
|
|
<member name="M:Utilities.BunifuToolTip.Views.ToolTipView.InitializeComponent">
|
|
<summary>
|
|
Required method for Designer support - do not modify
|
|
the contents of this method with the code editor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.BrushAdapter">
|
|
<summary>
|
|
Adapter for WinForms brushes objects for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.BrushAdapter._brush">
|
|
<summary>
|
|
The actual WinForms brush instance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.BrushAdapter._dispose">
|
|
<summary>
|
|
If to dispose the brush when <see cref="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.BrushAdapter.Dispose"/> is called.<br/>
|
|
Ignore dispose for cached brushes.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.BrushAdapter.#ctor(System.Drawing.Brush,System.Boolean)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.BrushAdapter.Brush">
|
|
<summary>
|
|
The actual WinForms brush instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ContextMenuAdapter">
|
|
<summary>
|
|
Adapter for WinForms context menu for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ContextMenuAdapter._contextMenu">
|
|
<summary>
|
|
the underline win forms context menu
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ContextMenuAdapter.#ctor">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ControlAdapter">
|
|
<summary>
|
|
Adapter for WinForms Control for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ControlAdapter._control">
|
|
<summary>
|
|
the underline win forms control.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ControlAdapter._useGdiPlusTextRendering">
|
|
<summary>
|
|
Use GDI+ text rendering to measure/draw text.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ControlAdapter.#ctor(System.Windows.Forms.Control,System.Boolean)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ControlAdapter.Control">
|
|
<summary>
|
|
Get the underline win forms control
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter">
|
|
<summary>
|
|
Adapter for WinForms Font object for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter._font">
|
|
<summary>
|
|
the underline win-forms font.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter._hFont">
|
|
<summary>
|
|
a handle to this Font.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter._underlineOffset">
|
|
<summary>
|
|
the vertical offset of the font underline location from the top of the font.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter._height">
|
|
<summary>
|
|
Cached font height.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter._whitespaceWidth">
|
|
<summary>
|
|
Cached font whitespace width.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter.#ctor(System.Drawing.Font)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter.Font">
|
|
<summary>
|
|
the underline win-forms font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter.HFont">
|
|
<summary>
|
|
Get the handle to this Font.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontAdapter.SetMetrics(System.Int32,System.Int32)">
|
|
<summary>
|
|
Set font metrics to be cached for the font for future use.
|
|
</summary>
|
|
<param name="height">the full height of the font</param>
|
|
<param name="underlineOffset">the vertical offset of the font underline location from the top of the font.</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontFamilyAdapter">
|
|
<summary>
|
|
Adapter for WinForms Font family object for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontFamilyAdapter._fontFamily">
|
|
<summary>
|
|
the underline win-forms font.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontFamilyAdapter.#ctor(System.Drawing.FontFamily)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.FontFamilyAdapter.FontFamily">
|
|
<summary>
|
|
the underline win-forms font family.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter">
|
|
<summary>
|
|
Adapter for WinForms Graphics for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._charFit">
|
|
<summary>
|
|
used for <see cref="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.MeasureString(System.String,TheArtOfDev.HtmlRenderer.Adapters.RFont,System.Double,System.Int32@,System.Double@)"/> calculation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._charFitWidth">
|
|
<summary>
|
|
used for <see cref="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.MeasureString(System.String,TheArtOfDev.HtmlRenderer.Adapters.RFont,System.Double,System.Int32@,System.Double@)"/> calculation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._characterRanges">
|
|
<summary>
|
|
Used for GDI+ measure string.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._stringFormat">
|
|
<summary>
|
|
The string format to use for measuring strings for GDI+ text rendering
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._stringFormat2">
|
|
<summary>
|
|
The string format to use for rendering strings for GDI+ text rendering
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._g">
|
|
<summary>
|
|
The wrapped WinForms graphics object
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._useGdiPlusTextRendering">
|
|
<summary>
|
|
Use GDI+ text rendering to measure/draw text.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._hdc">
|
|
<summary>
|
|
the initialized HDC used
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._releaseGraphics">
|
|
<summary>
|
|
if to release the graphics object on dispose
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter._setRtl">
|
|
<summary>
|
|
If text alignment was set to RTL
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.#cctor">
|
|
<summary>
|
|
Init static resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.#ctor(System.Drawing.Graphics,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="g">the win forms graphics object to use</param>
|
|
<param name="useGdiPlusTextRendering">Use GDI+ text rendering to measure/draw text</param>
|
|
<param name="releaseGraphics">optional: if to release the graphics object on dispose (default - false)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.ReleaseHdc">
|
|
<summary>
|
|
Release current HDC to be able to use <see cref="T:System.Drawing.Graphics"/> methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.InitHdc">
|
|
<summary>
|
|
Init HDC for the current graphics object to be used to call GDI directly.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.SetFont(TheArtOfDev.HtmlRenderer.Adapters.RFont)">
|
|
<summary>
|
|
Set a resource (e.g. a font) for the specified device context.
|
|
WARNING: Calling Font.ToHfont() many times without releasing the font handle crashes the app.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.SetTextColor(System.Drawing.Color)">
|
|
<summary>
|
|
Set the text color of the device context.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.SetRtlAlignGdi(System.Boolean)">
|
|
<summary>
|
|
Change text align to Left-to-Right or Right-to-Left if required.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.DrawTransparentText(System.IntPtr,System.String,TheArtOfDev.HtmlRenderer.Adapters.RFont,System.Drawing.Point,System.Drawing.Size,System.Drawing.Color)">
|
|
<summary>
|
|
Special draw logic to draw transparent text using GDI.<br/>
|
|
1. Create in-memory DC<br/>
|
|
2. Copy background to in-memory DC<br/>
|
|
3. Draw the text to in-memory DC<br/>
|
|
4. Copy the in-memory DC to the proper location with alpha blend<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsAdapter.SetRtlAlignGdiPlus(System.Boolean)">
|
|
<summary>
|
|
Change text align to Left-to-Right or Right-to-Left if required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsPathAdapter">
|
|
<summary>
|
|
Adapter for WinForms graphics path object for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsPathAdapter._graphicsPath">
|
|
<summary>
|
|
The actual WinForms graphics path instance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsPathAdapter._lastPoint">
|
|
<summary>
|
|
the last point added to the path to begin next segment from
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsPathAdapter.GraphicsPath">
|
|
<summary>
|
|
The actual WinForms graphics path instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.GraphicsPathAdapter.GetStartAngle(TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath.Corner)">
|
|
<summary>
|
|
Get arc start angle for the given corner.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ImageAdapter">
|
|
<summary>
|
|
Adapter for WinForms Image object for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ImageAdapter._image">
|
|
<summary>
|
|
the underline win-forms image.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ImageAdapter.#ctor(System.Drawing.Image)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Object"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.ImageAdapter.Image">
|
|
<summary>
|
|
the underline win-forms image.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.PenAdapter">
|
|
<summary>
|
|
Adapter for WinForms pens objects for core.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.PenAdapter._pen">
|
|
<summary>
|
|
The actual WinForms brush instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.PenAdapter.#ctor(System.Drawing.Pen)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.PenAdapter.Pen">
|
|
<summary>
|
|
The actual WinForms brush instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Adapters.WinFormsAdapter">
|
|
<summary>
|
|
Adapter for WinForms platforms.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Adapters.WinFormsAdapter._instance">
|
|
<summary>
|
|
Singleton instance of global adapter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Adapters.WinFormsAdapter.#ctor">
|
|
<summary>
|
|
Init installed font families and set default font families mapping.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.Adapters.WinFormsAdapter.Instance">
|
|
<summary>
|
|
Singleton instance of global adapter.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper">
|
|
<summary>
|
|
Helper to encode and set HTML fragment to clipboard.<br/>
|
|
See http://theartofdev.wordpress.com/2012/11/11/setting-html-and-plain-text-formatting-to-clipboard/.<br/>
|
|
<seealso cref="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.CreateDataObject(System.String,System.String)"/>.
|
|
</summary>
|
|
<remarks>
|
|
The MIT License (MIT) Copyright (c) 2014 Arthur Teplitzki.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.Header">
|
|
<summary>
|
|
The string contains index references to other spots in the string, so we need placeholders so we can compute the offsets. <br/>
|
|
The <![CDATA[<<<<<<<]]>_ strings are just placeholders. We'll back-patch them actual values afterwards. <br/>
|
|
The string layout (<![CDATA[<<<]]>) also ensures that it can't appear in the body of the html because the <![CDATA[<]]> <br/>
|
|
character must be escaped. <br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.StartFragment">
|
|
<summary>
|
|
html comment to point the beginning of html fragment
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.EndFragment">
|
|
<summary>
|
|
html comment to point the end of html fragment
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper._byteCount">
|
|
<summary>
|
|
Used to calculate characters byte count in UTF-8
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.CreateDataObject(System.String,System.String)">
|
|
<summary>
|
|
Create <see cref="T:System.Windows.Forms.DataObject"/> with given html and plain-text ready to be used for clipboard or drag and drop.<br/>
|
|
Handle missing <![CDATA[<html>]]> tags, specified start\end segments and Unicode characters.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Windows Clipboard works with UTF-8 Unicode encoding while .NET strings use with UTF-16 so for clipboard to correctly
|
|
decode Unicode string added to it from .NET we needs to be re-encoded it using UTF-8 encoding.
|
|
</para>
|
|
<para>
|
|
Builds the CF_HTML header correctly for all possible HTMLs<br/>
|
|
If given html contains start/end fragments then it will use them in the header:
|
|
<code><![CDATA[<html><body><!--StartFragment-->hello <b>world</b><!--EndFragment--></body></html>]]></code>
|
|
If given html contains html/body tags then it will inject start/end fragments to exclude html/body tags:
|
|
<code><![CDATA[<html><body>hello <b>world</b></body></html>]]></code>
|
|
If given html doesn't contain html/body tags then it will inject the tags and start/end fragments properly:
|
|
<code><![CDATA[hello <b>world</b>]]></code>
|
|
In all cases creating a proper CF_HTML header:<br/>
|
|
<code>
|
|
<![CDATA[
|
|
Version:1.0
|
|
StartHTML:000000177
|
|
EndHTML:000000329
|
|
StartFragment:000000277
|
|
EndFragment:000000295
|
|
StartSelection:000000277
|
|
EndSelection:000000277
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><body><!--StartFragment-->hello <b>world</b><!--EndFragment--></body></html>
|
|
]]>
|
|
</code>
|
|
See format specification here: http://msdn.microsoft.com/library/default.asp?url=/workshop/networking/clipboard/htmlclipboard.asp
|
|
</para>
|
|
</remarks>
|
|
<param name="html">a html fragment</param>
|
|
<param name="plainText">the plain text</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.CopyToClipboard(System.String,System.String)">
|
|
<summary>
|
|
Clears clipboard and sets the given HTML and plain text fragment to the clipboard, providing additional meta-information for HTML.<br/>
|
|
See <see cref="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.CreateDataObject(System.String,System.String)"/> for HTML fragment details.<br/>
|
|
</summary>
|
|
<example>
|
|
ClipboardHelper.CopyToClipboard("Hello <b>World</b>", "Hello World");
|
|
</example>
|
|
<param name="html">a html fragment</param>
|
|
<param name="plainText">the plain text</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.CopyToClipboard(System.String)">
|
|
<summary>
|
|
Clears clipboard and sets the given plain text fragment to the clipboard.<br/>
|
|
</summary>
|
|
<param name="plainText">the plain text</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.GetHtmlDataString(System.String)">
|
|
<summary>
|
|
Generate HTML fragment data string with header that is required for the clipboard.
|
|
</summary>
|
|
<param name="html">the html to generate for</param>
|
|
<returns>the resulted string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.ClipboardHelper.GetByteCount(System.Text.StringBuilder,System.Int32,System.Int32)">
|
|
<summary>
|
|
Calculates the number of bytes produced by encoding the string in the string builder in UTF-8 and not .NET default string encoding.
|
|
</summary>
|
|
<param name="sb">the string builder to count its string</param>
|
|
<param name="start">optional: the start index to calculate from (default - start of string)</param>
|
|
<param name="end">optional: the end index to calculate to (default - end of string)</param>
|
|
<returns>the number of bytes required to encode the string in UTF-8</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils">
|
|
<summary>
|
|
Utilities for converting WinForms entities to HtmlRenderer core entities.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(System.Drawing.PointF)">
|
|
<summary>
|
|
Convert from WinForms point to core point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint[])">
|
|
<summary>
|
|
Convert from WinForms point to core point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Convert from core point to WinForms point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.ConvertRound(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Convert from core point to WinForms point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(System.Drawing.SizeF)">
|
|
<summary>
|
|
Convert from WinForms size to core size.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Convert from core size to WinForms size.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.ConvertRound(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Convert from core size to WinForms size.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(System.Drawing.RectangleF)">
|
|
<summary>
|
|
Convert from WinForms rectangle to core rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Convert from core rectangle to WinForms rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.ConvertRound(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Convert from core rectangle to WinForms rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(System.Drawing.Color)">
|
|
<summary>
|
|
Convert from WinForms color to core color.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.Convert(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Convert from core color to WinForms color.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Utils.CreateGraphics(System.Windows.Forms.Control)">
|
|
<summary>
|
|
mono has issue throwing exception for no reason.
|
|
</summary>
|
|
<param name="control">the control to create graphics object from</param>
|
|
<returns>new graphics object or null in mono if failed</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils">
|
|
<summary>
|
|
Utility for Win32 API.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.BitBltCopy">
|
|
<summary>
|
|
Const for BitBlt copy raster-operation code.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.BitBltPaint">
|
|
<summary>
|
|
Const for BitBlt paint raster-operation code.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.CreateMemoryHdc(System.IntPtr,System.Int32,System.Int32,System.IntPtr@)">
|
|
<summary>
|
|
Create a compatible memory HDC from the given HDC.<br/>
|
|
The memory HDC can be rendered into without effecting the original HDC.<br/>
|
|
The returned memory HDC and <paramref name="dib"/> must be released using <see cref="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.ReleaseMemoryHdc(System.IntPtr,System.IntPtr)"/>.
|
|
</summary>
|
|
<param name="hdc">the HDC to create memory HDC from</param>
|
|
<param name="width">the width of the memory HDC to create</param>
|
|
<param name="height">the height of the memory HDC to create</param>
|
|
<param name="dib">returns used bitmap memory section that must be released when done with memory HDC</param>
|
|
<returns>memory HDC</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.ReleaseMemoryHdc(System.IntPtr,System.IntPtr)">
|
|
<summary>
|
|
Release the given memory HDC and dib section created from <see cref="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.CreateMemoryHdc(System.IntPtr,System.Int32,System.Int32,System.IntPtr@)"/>.
|
|
</summary>
|
|
<param name="memoryHdc">Memory HDC to release</param>
|
|
<param name="dib">bitmap section to release</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.GetWindowRect(System.IntPtr,System.Drawing.Rectangle@)">
|
|
<summary>
|
|
Retrieves the dimensions of the bounding rectangle of the specified window. The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
|
|
</summary>
|
|
<remarks>
|
|
In conformance with conventions for the RECT structure, the bottom-right coordinates of the returned rectangle are exclusive. In other words,
|
|
the pixel at (right, bottom) lies immediately outside the rectangle.
|
|
</remarks>
|
|
<param name="hWnd">A handle to the window.</param>
|
|
<param name="lpRect">A pointer to a RECT structure that receives the screen coordinates of the upper-left and lower-right corners of the window.</param>
|
|
<returns>If the function succeeds, the return value is nonzero.</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.Utilities.Win32Utils.GetWindowRectangle(System.IntPtr)">
|
|
<summary>
|
|
Retrieves the dimensions of the bounding rectangle of the specified window. The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
|
|
</summary>
|
|
<remarks>
|
|
In conformance with conventions for the RECT structure, the bottom-right coordinates of the returned rectangle are exclusive. In other words,
|
|
the pixel at (right, bottom) lies immediately outside the rectangle.
|
|
</remarks>
|
|
<param name="handle">A handle to the window.</param>
|
|
<returns>RECT structure that receives the screen coordinates of the upper-left and lower-right corners of the window.</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer">
|
|
<summary>
|
|
Low level handling of Html Renderer logic, this class is used by <see cref="T:TheArtOfDev.HtmlRenderer.Core.Parse.HtmlParser"/>,
|
|
<see cref="!:HtmlLabel"/>, <see cref="!:HtmlToolTip"/> and <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</summary>
|
|
<seealso cref="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HtmlContainerInt"/>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer._htmlContainerInt">
|
|
<summary>
|
|
The internal core html container
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer._useGdiPlusTextRendering">
|
|
<summary>
|
|
Use GDI+ text rendering to measure/draw text.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.#ctor">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.LoadComplete">
|
|
<summary>
|
|
Raised when the set html document has been fully loaded.<br/>
|
|
Allows manipulation of the html dom, scroll position, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.LinkClicked">
|
|
<summary>
|
|
Raised when the user clicks on a link in the html.<br/>
|
|
Allows canceling the execution of the link.
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.Refresh">
|
|
<summary>
|
|
Raised when html renderer requires refresh of the control hosting (invalidation and re-layout).
|
|
</summary>
|
|
<remarks>
|
|
There is no guarantee that the event will be raised on the main thread, it can be raised on thread-pool thread.
|
|
</remarks>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.ScrollChange">
|
|
<summary>
|
|
Raised when Html Renderer request scroll to specific location.<br/>
|
|
This can occur on document anchor click.
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.RenderError">
|
|
<summary>
|
|
Raised when an error occurred during html rendering.<br/>
|
|
</summary>
|
|
<remarks>
|
|
There is no guarantee that the event will be raised on the main thread, it can be raised on thread-pool thread.
|
|
</remarks>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.StylesheetLoad">
|
|
<summary>
|
|
Raised when a stylesheet is about to be loaded by file path or URI by link element.<br/>
|
|
This event allows to provide the stylesheet manually or provide new source (file or Uri) to load from.<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.ImageLoad">
|
|
<summary>
|
|
Raised when an image is about to be loaded by file path or URI.<br/>
|
|
This event allows to provide the image manually, if not handled the image will be loaded from file or download from URI.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HtmlContainerInt">
|
|
<summary>
|
|
The internal core html container
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.UseGdiPlusTextRendering">
|
|
<summary>
|
|
Use GDI+ text rendering to measure/draw text.<br/>
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
GDI+ text rendering is less smooth than GDI text rendering but it natively supports alpha channel
|
|
thus allows creating transparent images.
|
|
</para>
|
|
<para>
|
|
While using GDI+ text rendering you can control the text rendering using <see cref="P:System.Drawing.Graphics.TextRenderingHint"/>, note that
|
|
using <see cref="F:System.Drawing.Text.TextRenderingHint.ClearTypeGridFit"/> doesn't work well with transparent background.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.CssData">
|
|
<summary>
|
|
the parsed stylesheet data used for handling the html
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.AvoidGeometryAntialias">
|
|
<summary>
|
|
Gets or sets a value indicating if anti-aliasing should be avoided for geometry like backgrounds and borders (default - false).
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.AvoidAsyncImagesLoading">
|
|
<summary>
|
|
Gets or sets a value indicating if image asynchronous loading should be avoided (default - false).<br/>
|
|
True - images are loaded synchronously during html parsing.<br/>
|
|
False - images are loaded asynchronously to html parsing when downloaded from URL or loaded from disk.<br/>
|
|
</summary>
|
|
<remarks>
|
|
Asynchronously image loading allows to unblock html rendering while image is downloaded or loaded from disk using IO
|
|
ports to achieve better performance.<br/>
|
|
Asynchronously image loading should be avoided when the full html content must be available during render, like render to image.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.AvoidImagesLateLoading">
|
|
<summary>
|
|
Gets or sets a value indicating if image loading only when visible should be avoided (default - false).<br/>
|
|
True - images are loaded as soon as the html is parsed.<br/>
|
|
False - images that are not visible because of scroll location are not loaded until they are scrolled to.
|
|
</summary>
|
|
<remarks>
|
|
Images late loading improve performance if the page contains image outside the visible scroll area, especially if there is large
|
|
amount of images, as all image loading is delayed (downloading and loading into memory).<br/>
|
|
Late image loading may effect the layout and actual size as image without set size will not have actual size until they are loaded
|
|
resulting in layout change during user scroll.<br/>
|
|
Early image loading may also effect the layout if image without known size above the current scroll location are loaded as they
|
|
will push the html elements down.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.IsSelectionEnabled">
|
|
<summary>
|
|
Is content selection is enabled for the rendered html (default - true).<br/>
|
|
If set to 'false' the rendered html will be static only with ability to click on links.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.IsContextMenuEnabled">
|
|
<summary>
|
|
Is the build-in context menu enabled and will be shown on mouse right click (default - true)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.ScrollOffset">
|
|
<summary>
|
|
The scroll offset of the html.<br/>
|
|
This will adjust the rendered html by the given offset so the content will be "scrolled".<br/>
|
|
</summary>
|
|
<example>
|
|
Element that is rendered at location (50,100) with offset of (0,200) will not be rendered as it
|
|
will be at -100 therefore outside the client rectangle.
|
|
</example>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.Location">
|
|
<summary>
|
|
The top-left most location of the rendered html.<br/>
|
|
This will offset the top-left corner of the rendered html.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.MaxSize">
|
|
<summary>
|
|
The max width and height of the rendered html.<br/>
|
|
The max width will effect the html layout wrapping lines, resize images and tables where possible.<br/>
|
|
The max height does NOT effect layout, but will not render outside it (clip).<br/>
|
|
<see cref="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.ActualSize"/> can be exceed the max size by layout restrictions (unwrappable line, set image size, etc.).<br/>
|
|
Set zero for unlimited (width\height separately).<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.ActualSize">
|
|
<summary>
|
|
The actual size of the rendered html (after layout)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.SelectedText">
|
|
<summary>
|
|
Get the currently selected text segment in the html.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.SelectedHtml">
|
|
<summary>
|
|
Copy the currently selected html segment with style.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.ClearSelection">
|
|
<summary>
|
|
Clear the current selection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.SetHtml(System.String,TheArtOfDev.HtmlRenderer.Core.CssData)">
|
|
<summary>
|
|
Init with optional document and stylesheet.
|
|
</summary>
|
|
<param name="htmlSource">the html to init with, init empty if not given</param>
|
|
<param name="baseCssData">optional: the stylesheet to init with, init default if not given</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.GetHtml(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle)">
|
|
<summary>
|
|
Get html from the current DOM tree with style if requested.
|
|
</summary>
|
|
<param name="styleGen">Optional: controls the way styles are generated when html is generated (default: <see cref="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle.Inline"/>)</param>
|
|
<returns>generated html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.GetAttributeAt(System.Drawing.Point,System.String)">
|
|
<summary>
|
|
Get attribute value of element at the given x,y location by given key.<br/>
|
|
If more than one element exist with the attribute at the location the inner most is returned.
|
|
</summary>
|
|
<param name="location">the location to find the attribute at</param>
|
|
<param name="attribute">the attribute key to get value by</param>
|
|
<returns>found attribute value or null if not found</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.GetLinks">
|
|
<summary>
|
|
Get all the links in the HTML with the element rectangle and href data.
|
|
</summary>
|
|
<returns>collection of all the links in the HTML</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.GetLinkAt(System.Drawing.Point)">
|
|
<summary>
|
|
Get css link href at the given x,y location.
|
|
</summary>
|
|
<param name="location">the location to find the link at</param>
|
|
<returns>css link href if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.GetElementRectangle(System.String)">
|
|
<summary>
|
|
Get the rectangle of html element as calculated by html layout.<br/>
|
|
Element if found by id (id attribute on the html element).<br/>
|
|
Note: to get the screen rectangle you need to adjust by the hosting control.<br/>
|
|
</summary>
|
|
<param name="elementId">the id of the element to get its rectangle</param>
|
|
<returns>the rectangle of the element or null if not found</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.PerformLayout(System.Drawing.Graphics)">
|
|
<summary>
|
|
Measures the bounds of box and children, recursively.
|
|
</summary>
|
|
<param name="g">Device context to draw</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.PerformPaint(System.Drawing.Graphics)">
|
|
<summary>
|
|
Render the html using the given device.
|
|
</summary>
|
|
<param name="g">the device to use to render</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HandleMouseDown(System.Windows.Forms.Control,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse down to handle selection.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="e">the mouse event args</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HandleMouseUp(System.Windows.Forms.Control,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse up to handle selection and link click.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="e">the mouse event args</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HandleMouseDoubleClick(System.Windows.Forms.Control,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse double click to select word under the mouse.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
<param name="e">mouse event args</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HandleMouseMove(System.Windows.Forms.Control,System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Handle mouse move to handle hover cursor and text selection.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
<param name="e">the mouse event args</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HandleMouseLeave(System.Windows.Forms.Control)">
|
|
<summary>
|
|
Handle mouse leave to handle hover cursor.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.HandleKeyDown(System.Windows.Forms.Control,System.Windows.Forms.KeyEventArgs)">
|
|
<summary>
|
|
Handle key down event for selection and copy.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="e">the pressed key</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.CreateMouseEvent(System.Windows.Forms.MouseEventArgs)">
|
|
<summary>
|
|
Create HtmlRenderer mouse event from win forms mouse event.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer.CreateKeyEevent(System.Windows.Forms.KeyEventArgs)">
|
|
<summary>
|
|
Create HtmlRenderer key event from win forms key event.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender">
|
|
<summary>
|
|
Standalone static class for simple and direct HTML rendering.<br/>
|
|
For WinForms UI prefer using HTML controls: <see cref="!:HtmlPanel"/> or <see cref="!:HtmlLabel"/>.<br/>
|
|
For low-level control and performance consider using <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer"/>.<br/>
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
<b>GDI vs. GDI+ text rendering</b><br/>
|
|
Windows supports two text rendering technologies: GDI and GDI+.<br/>
|
|
GDI is older, has better performance and looks better on standard monitors but doesn't support alpha channel for transparency.<br/>
|
|
GDI+ is newer, device independent so work better for printers but is slower and looks worse on monitors.<br/>
|
|
HtmlRender supports both GDI and GDI+ text rendering to accommodate different needs, GDI+ text rendering methods have "GdiPlus" suffix
|
|
in their name where GDI do not.<br/>
|
|
</para>
|
|
<para>
|
|
<b>Rendering to image</b><br/>
|
|
See https://htmlrenderer.codeplex.com/wikipage?title=Image%20generation <br/>
|
|
Because of GDI text rendering issue with alpha channel clear type text rendering rendering to image requires special handling.<br/>
|
|
<u>Solid color background -</u> generate an image where the background is filled with solid color and all the html is rendered on top
|
|
of the background color, GDI text rendering will be used. (RenderToImage method where the first argument is html string)<br/>
|
|
<u>Image background -</u> render html on top of existing image with whatever currently exist but it cannot have transparent pixels,
|
|
GDI text rendering will be used. (RenderToImage method where the first argument is Image object)<br/>
|
|
<u>Transparent background -</u> render html to empty image using GDI+ text rendering, the generated image can be transparent.
|
|
Text rendering can be controlled using <see cref="T:System.Drawing.Text.TextRenderingHint"/>, note that <see cref="F:System.Drawing.Text.TextRenderingHint.ClearTypeGridFit"/>
|
|
doesn't render well on transparent background. (RenderToImageGdiPlus method)<br/>
|
|
</para>
|
|
<para>
|
|
<b>Overwrite stylesheet resolution</b><br/>
|
|
Exposed by optional "stylesheetLoad" delegate argument.<br/>
|
|
Invoked when a stylesheet is about to be loaded by file path or URL in 'link' element.<br/>
|
|
Allows to overwrite the loaded stylesheet by providing the stylesheet data manually, or different source (file or URL) to load from.<br/>
|
|
Example: The stylesheet 'href' can be non-valid URI string that is interpreted in the overwrite delegate by custom logic to pre-loaded stylesheet object<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
</para>
|
|
<para>
|
|
<b>Overwrite image resolution</b><br/>
|
|
Exposed by optional "imageLoad" delegate argument.<br/>
|
|
Invoked when an image is about to be loaded by file path, URL or inline data in 'img' element or background-image CSS style.<br/>
|
|
Allows to overwrite the loaded image by providing the image object manually, or different source (file or URL) to load from.<br/>
|
|
Example: image 'src' can be non-valid string that is interpreted in the overwrite delegate by custom logic to resource image object<br/>
|
|
Example: image 'src' in the html is relative - the overwrite intercepts the load and provide full source URL to load the image from<br/>
|
|
Example: image download requires authentication - the overwrite intercepts the load, downloads the image to disk using custom code and provide
|
|
file path to load the image from.<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
Note: Cannot use asynchronous scheme overwrite scheme.<br/>
|
|
</para>
|
|
</remarks>
|
|
<example>
|
|
<para>
|
|
<b>Simple rendering</b><br/>
|
|
HtmlRender.Render(g, "<![CDATA[<div>Hello <b>World</b></div>]]>");<br/>
|
|
HtmlRender.Render(g, "<![CDATA[<div>Hello <b>World</b></div>]]>", 10, 10, 500, CssData.Parse("body {font-size: 20px}")");<br/>
|
|
</para>
|
|
<para>
|
|
<b>Image rendering</b><br/>
|
|
HtmlRender.RenderToImage("<![CDATA[<div>Hello <b>World</b></div>]]>", new Size(600,400));<br/>
|
|
HtmlRender.RenderToImage("<![CDATA[<div>Hello <b>World</b></div>]]>", 600);<br/>
|
|
HtmlRender.RenderToImage(existingImage, "<![CDATA[<div>Hello <b>World</b></div>]]>");<br/>
|
|
</para>
|
|
</example>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.AddFontFamily(System.Drawing.FontFamily)">
|
|
<summary>
|
|
Adds a font family to be used in html rendering.<br/>
|
|
The added font will be used by all rendering function including <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer"/> and all WinForms controls.
|
|
</summary>
|
|
<remarks>
|
|
The given font family instance must be remain alive while the renderer is in use.<br/>
|
|
If loaded to <see cref="T:System.Drawing.Text.PrivateFontCollection"/> then the collection must be alive.<br/>
|
|
If loaded from file then the file must not be deleted.
|
|
</remarks>
|
|
<param name="fontFamily">The font family to add.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.AddFontFamilyMapping(System.String,System.String)">
|
|
<summary>
|
|
Adds a font mapping from <paramref name="fromFamily"/> to <paramref name="toFamily"/> iff the <paramref name="fromFamily"/> is not found.<br/>
|
|
When the <paramref name="fromFamily"/> font is used in rendered html and is not found in existing
|
|
fonts (installed or added) it will be replaced by <paramref name="toFamily"/>.<br/>
|
|
</summary>
|
|
<remarks>
|
|
This fonts mapping can be used as a fallback in case the requested font is not installed in the client system.
|
|
</remarks>
|
|
<param name="fromFamily">the font family to replace</param>
|
|
<param name="toFamily">the font family to replace with</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.ParseStyleSheet(System.String,System.Boolean)">
|
|
<summary>
|
|
Parse the given stylesheet to <see cref="T:TheArtOfDev.HtmlRenderer.Core.CssData"/> object.<br/>
|
|
If <paramref name="combineWithDefault"/> is true the parsed css blocks are added to the
|
|
default css data (as defined by W3), merged if class name already exists. If false only the data in the given stylesheet is returned.
|
|
</summary>
|
|
<seealso cref="!:http://www.w3.org/TR/CSS21/sample.html"/>
|
|
<param name="stylesheet">the stylesheet source to parse</param>
|
|
<param name="combineWithDefault">true - combine the parsed css data with default css data, false - return only the parsed css data</param>
|
|
<returns>the parsed css data</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.Measure(System.Drawing.Graphics,System.String,System.Single,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Measure the size (width and height) required to draw the given html under given max width restriction.<br/>
|
|
If no max width restriction is given the layout will use the maximum possible width required by the content,
|
|
it can be the longest text line or full image width.<br/>
|
|
Use GDI text rendering, note <see cref="P:System.Drawing.Graphics.TextRenderingHint"/> has no effect.
|
|
</summary>
|
|
<param name="g">Device to use for measure</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="maxWidth">optional: bound the width of the html to render in (default - 0, unlimited)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the size required for the html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.MeasureGdiPlus(System.Drawing.Graphics,System.String,System.Single,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Measure the size (width and height) required to draw the given html under given max width restriction.<br/>
|
|
If no max width restriction is given the layout will use the maximum possible width required by the content,
|
|
it can be the longest text line or full image width.<br/>
|
|
Use GDI+ text rending, use <see cref="P:System.Drawing.Graphics.TextRenderingHint"/> to control text rendering.
|
|
</summary>
|
|
<param name="g">Device to use for measure</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="maxWidth">optional: bound the width of the html to render in (default - 0, unlimited)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the size required for the html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.Render(System.Drawing.Graphics,System.String,System.Single,System.Single,System.Single,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML source on the specified location and max width restriction.<br/>
|
|
Use GDI text rendering, note <see cref="P:System.Drawing.Graphics.TextRenderingHint"/> has no effect.<br/>
|
|
If <paramref name="maxWidth"/> is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
Returned is the actual width and height of the rendered html.<br/>
|
|
</summary>
|
|
<param name="g">Device to render with</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="left">optional: the left most location to start render the html at (default - 0)</param>
|
|
<param name="top">optional: the top most location to start render the html at (default - 0)</param>
|
|
<param name="maxWidth">optional: bound the width of the html to render in (default - 0, unlimited)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the actual size of the rendered html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.Render(System.Drawing.Graphics,System.String,System.Drawing.PointF,System.Drawing.SizeF,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML source on the specified location and max size restriction.<br/>
|
|
Use GDI text rendering, note <see cref="P:System.Drawing.Graphics.TextRenderingHint"/> has no effect.<br/>
|
|
If <paramref name="maxSize"/>.Width is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxSize"/>.Height is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
Returned is the actual width and height of the rendered html.<br/>
|
|
</summary>
|
|
<param name="g">Device to render with</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="location">the top-left most location to start render the html at</param>
|
|
<param name="maxSize">the max size of the rendered html (if height above zero it will be clipped)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the actual size of the rendered html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderGdiPlus(System.Drawing.Graphics,System.String,System.Single,System.Single,System.Single,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML source on the specified location and max size restriction.<br/>
|
|
Use GDI+ text rending, use <see cref="P:System.Drawing.Graphics.TextRenderingHint"/> to control text rendering.<br/>
|
|
If <paramref name="maxWidth"/> is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
Returned is the actual width and height of the rendered html.<br/>
|
|
</summary>
|
|
<param name="g">Device to render with</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="left">optional: the left most location to start render the html at (default - 0)</param>
|
|
<param name="top">optional: the top most location to start render the html at (default - 0)</param>
|
|
<param name="maxWidth">optional: bound the width of the html to render in (default - 0, unlimited)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the actual size of the rendered html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderGdiPlus(System.Drawing.Graphics,System.String,System.Drawing.PointF,System.Drawing.SizeF,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML source on the specified location and max size restriction.<br/>
|
|
Use GDI+ text rending, use <see cref="P:System.Drawing.Graphics.TextRenderingHint"/> to control text rendering.<br/>
|
|
If <paramref name="maxSize"/>.Width is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxSize"/>.Height is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
Returned is the actual width and height of the rendered html.<br/>
|
|
</summary>
|
|
<param name="g">Device to render with</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="location">the top-left most location to start render the html at</param>
|
|
<param name="maxSize">the max size of the rendered html (if height above zero it will be clipped)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the actual size of the rendered html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImage(System.Drawing.Image,System.String,System.Drawing.PointF,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML on top of the given image.<br/>
|
|
<paramref name="image"/> will contain the rendered html in it on top of original content.<br/>
|
|
<paramref name="image"/> must not contain transparent pixels as it will corrupt the rendered html text.<br/>
|
|
The HTML will be layout by the given image size but may be clipped if cannot fit.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</summary>
|
|
<param name="image">the image to render the html on</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="location">optional: the top-left most location to start render the html at (default - 0,0)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImage(System.Drawing.Image,System.String,System.Drawing.PointF,System.Drawing.SizeF,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML on top of the given image.<br/>
|
|
<paramref name="image"/> will contain the rendered html in it on top of original content.<br/>
|
|
<paramref name="image"/> must not contain transparent pixels as it will corrupt the rendered html text.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</summary>
|
|
<param name="image">the image to render the html on</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="location">the top-left most location to start render the html at</param>
|
|
<param name="maxSize">the max size of the rendered html (if height above zero it will be clipped)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImage(System.String,System.Drawing.Size,System.Drawing.Color,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML into a new image of the requested size.<br/>
|
|
The HTML will be layout by the given size but will be clipped if cannot fit.<br/>
|
|
<p>
|
|
Limitation: The image cannot have transparent background, by default it will be white.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</p>
|
|
</summary>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="size">The size of the image to render into, layout html by width and clipped by height</param>
|
|
<param name="backgroundColor">optional: the color to fill the image with (default - white)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the generated image of the html</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">if <paramref name="backgroundColor"/> is <see cref="P:System.Drawing.Color.Transparent"/></exception>.
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImage(System.String,System.Int32,System.Int32,System.Drawing.Color,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML into a new image of unknown size that will be determined by max width/height and HTML layout.<br/>
|
|
If <paramref name="maxWidth"/> is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxHeight"/> is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
<p>
|
|
Limitation: The image cannot have transparent background, by default it will be white.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</p>
|
|
</summary>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="maxWidth">optional: the max width of the rendered html, if not zero and html cannot be layout within the limit it will be clipped</param>
|
|
<param name="maxHeight">optional: the max height of the rendered html, if not zero and html cannot be layout within the limit it will be clipped</param>
|
|
<param name="backgroundColor">optional: the color to fill the image with (default - white)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the generated image of the html</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">if <paramref name="backgroundColor"/> is <see cref="P:System.Drawing.Color.Transparent"/></exception>.
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImage(System.String,System.Drawing.Size,System.Drawing.Size,System.Drawing.Color,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML into a new image of unknown size that will be determined by min/max width/height and HTML layout.<br/>
|
|
If <paramref name="maxSize.Width.Width"/> is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxSize.Height.Height"/> is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
If <paramref name="minSize"/> (Width/Height) is above zero the rendered image will not be smaller than the given min size.<br/>
|
|
<p>
|
|
Limitation: The image cannot have transparent background, by default it will be white.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</p>
|
|
</summary>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="minSize">optional: the min size of the rendered html (zero - not limit the width/height)</param>
|
|
<param name="maxSize">optional: the max size of the rendered html, if not zero and html cannot be layout within the limit it will be clipped (zero - not limit the width/height)</param>
|
|
<param name="backgroundColor">optional: the color to fill the image with (default - white)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the generated image of the html</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">if <paramref name="backgroundColor"/> is <see cref="P:System.Drawing.Color.Transparent"/></exception>.
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImageGdiPlus(System.String,System.Drawing.Size,System.Drawing.Text.TextRenderingHint,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML into a new image of the requested size.<br/>
|
|
The HTML will be layout by the given size but will be clipped if cannot fit.<br/>
|
|
The generated image have transparent background that the html is rendered on.<br/>
|
|
GDI+ text rending can be controlled by providing <see cref="T:System.Drawing.Text.TextRenderingHint"/>.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</summary>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="size">The size of the image to render into, layout html by width and clipped by height</param>
|
|
<param name="textRenderingHint">optional: (default - SingleBitPerPixelGridFit)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the generated image of the html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImageGdiPlus(System.String,System.Int32,System.Int32,System.Drawing.Text.TextRenderingHint,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML into a new image of unknown size that will be determined by max width/height and HTML layout.<br/>
|
|
If <paramref name="maxWidth"/> is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxHeight"/> is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
The generated image have transparent background that the html is rendered on.<br/>
|
|
GDI+ text rending can be controlled by providing <see cref="T:System.Drawing.Text.TextRenderingHint"/>.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</summary>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="maxWidth">optional: the max width of the rendered html, if not zero and html cannot be layout within the limit it will be clipped</param>
|
|
<param name="maxHeight">optional: the max height of the rendered html, if not zero and html cannot be layout within the limit it will be clipped</param>
|
|
<param name="textRenderingHint">optional: (default - SingleBitPerPixelGridFit)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the generated image of the html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderToImageGdiPlus(System.String,System.Drawing.Size,System.Drawing.Size,System.Drawing.Text.TextRenderingHint,TheArtOfDev.HtmlRenderer.Core.CssData,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML into a new image of unknown size that will be determined by min/max width/height and HTML layout.<br/>
|
|
If <paramref name="maxSize.Width.Width"/> is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxSize.Height.Height"/> is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
If <paramref name="minSize"/> (Width/Height) is above zero the rendered image will not be smaller than the given min size.<br/>
|
|
The generated image have transparent background that the html is rendered on.<br/>
|
|
GDI+ text rending can be controlled by providing <see cref="T:System.Drawing.Text.TextRenderingHint"/>.<br/>
|
|
See "Rendering to image" remarks section on <see cref="T:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender"/>.<br/>
|
|
</summary>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="minSize">optional: the min size of the rendered html (zero - not limit the width/height)</param>
|
|
<param name="maxSize">optional: the max size of the rendered html, if not zero and html cannot be layout within the limit it will be clipped (zero - not limit the width/height)</param>
|
|
<param name="textRenderingHint">optional: (default - SingleBitPerPixelGridFit)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the generated image of the html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.Measure(System.Drawing.Graphics,System.String,System.Single,TheArtOfDev.HtmlRenderer.Core.CssData,System.Boolean,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Measure the size (width and height) required to draw the given html under given width and height restrictions.<br/>
|
|
</summary>
|
|
<param name="g">Device to use for measure</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="maxWidth">optional: bound the width of the html to render in (default - 0, unlimited)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="useGdiPlusTextRendering">true - use GDI+ text rendering, false - use GDI text rendering</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the size required for the html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.MeasureHtmlByRestrictions(TheArtOfDev.HtmlRenderer.WinForms.HtmlContainer,System.Drawing.Size,System.Drawing.Size)">
|
|
<summary>
|
|
Measure the size of the html by performing layout under the given restrictions.
|
|
</summary>
|
|
<param name="htmlContainer">the html to calculate the layout for</param>
|
|
<param name="minSize">the minimal size of the rendered html (zero - not limit the width/height)</param>
|
|
<param name="maxSize">the maximum size of the rendered html, if not zero and html cannot be layout within the limit it will be clipped (zero - not limit the width/height)</param>
|
|
<returns>return: the size of the html to be rendered within the min/max limits</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderClip(System.Drawing.Graphics,System.String,System.Drawing.PointF,System.Drawing.SizeF,TheArtOfDev.HtmlRenderer.Core.CssData,System.Boolean,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML source on the specified location and max size restriction.<br/>
|
|
If <paramref name="maxSize"/>.Width is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxSize"/>.Height is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
Clip the graphics so the html will not be rendered outside the max height bound given.<br/>
|
|
Returned is the actual width and height of the rendered html.<br/>
|
|
</summary>
|
|
<param name="g">Device to render with</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="location">the top-left most location to start render the html at</param>
|
|
<param name="maxSize">the max size of the rendered html (if height above zero it will be clipped)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="useGdiPlusTextRendering">true - use GDI+ text rendering, false - use GDI text rendering</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the actual size of the rendered html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.RenderHtml(System.Drawing.Graphics,System.String,System.Drawing.PointF,System.Drawing.SizeF,TheArtOfDev.HtmlRenderer.Core.CssData,System.Boolean,System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs},System.EventHandler{TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs})">
|
|
<summary>
|
|
Renders the specified HTML source on the specified location and max size restriction.<br/>
|
|
If <paramref name="maxSize"/>.Width is zero the html will use all the required width, otherwise it will perform line
|
|
wrap as specified in the html<br/>
|
|
If <paramref name="maxSize"/>.Height is zero the html will use all the required height, otherwise it will clip at the
|
|
given max height not rendering the html below it.<br/>
|
|
Returned is the actual width and height of the rendered html.<br/>
|
|
</summary>
|
|
<param name="g">Device to render with</param>
|
|
<param name="html">HTML source to render</param>
|
|
<param name="location">the top-left most location to start render the html at</param>
|
|
<param name="maxSize">the max size of the rendered html (if height above zero it will be clipped)</param>
|
|
<param name="cssData">optional: the style to use for html rendering (default - use W3 default style)</param>
|
|
<param name="useGdiPlusTextRendering">true - use GDI+ text rendering, false - use GDI text rendering</param>
|
|
<param name="stylesheetLoad">optional: can be used to overwrite stylesheet resolution logic</param>
|
|
<param name="imageLoad">optional: can be used to overwrite image resolution logic</param>
|
|
<returns>the actual size of the rendered html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.WinForms.HtmlRender.CopyBufferToImage(System.IntPtr,System.Drawing.Image)">
|
|
<summary>
|
|
Copy all the bitmap bits from memory bitmap buffer to the given image.
|
|
</summary>
|
|
<param name="memoryHdc">the source memory bitmap buffer to copy from</param>
|
|
<param name="image">the destination bitmap image to copy to</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor">
|
|
<summary>
|
|
Represents an ARGB (alpha, red, green, blue) color.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.Empty">
|
|
<summary>
|
|
Represents a color that is null.
|
|
</summary>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.Transparent">
|
|
<summary>
|
|
Gets a system-defined color.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.Black">
|
|
<summary>
|
|
Gets a system-defined color that has an ARGB value of #FF000000.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.White">
|
|
<summary>
|
|
Gets a system-defined color that has an ARGB value of #FFFFFFFF.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.WhiteSmoke">
|
|
<summary>
|
|
Gets a system-defined color that has an ARGB value of #FFF5F5F5.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.LightGray">
|
|
<summary>
|
|
Gets a system-defined color that has an ARGB value of #FFD3D3D3.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.R">
|
|
<summary>
|
|
Gets the red component value of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.G">
|
|
<summary>
|
|
Gets the green component value of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.B">
|
|
<summary>
|
|
Gets the blue component value of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.A">
|
|
<summary>
|
|
Gets the alpha component value of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.IsEmpty">
|
|
<summary>
|
|
Specifies whether this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure is uninitialized.
|
|
</summary>
|
|
<returns>
|
|
This property returns true if this color is uninitialized; otherwise, false.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.op_Equality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Tests whether two specified <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structures are equivalent.
|
|
</summary>
|
|
<returns>
|
|
true if the two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structures are equal; otherwise, false.
|
|
</returns>
|
|
<param name="left">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> that is to the left of the equality operator.
|
|
</param>
|
|
<param name="right">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> that is to the right of the equality operator.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.op_Inequality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Tests whether two specified <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structures are different.
|
|
</summary>
|
|
<returns>
|
|
true if the two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structures are different; otherwise, false.
|
|
</returns>
|
|
<param name="left">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> that is to the left of the inequality operator.
|
|
</param>
|
|
<param name="right">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> that is to the right of the inequality operator.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.FromArgb(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Creates a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure from the four ARGB component (alpha, red, green, and blue) values. Although this method allows a 32-bit value to be passed for each component, the value of each component is limited to 8 bits.
|
|
</summary>
|
|
<returns>
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> that this method creates.
|
|
</returns>
|
|
<param name="alpha">The alpha component. Valid values are 0 through 255. </param>
|
|
<param name="red">The red component. Valid values are 0 through 255. </param>
|
|
<param name="green">The green component. Valid values are 0 through 255. </param>
|
|
<param name="blue">The blue component. Valid values are 0 through 255. </param>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="alpha" />, <paramref name="red" />, <paramref name="green" />, or <paramref name="blue" /> is less than 0 or greater than 255.
|
|
</exception>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.FromArgb(System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Creates a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure from the specified 8-bit color values (red, green, and blue). The alpha value is implicitly 255 (fully opaque). Although this method allows a 32-bit value to be passed for each color component, the value of each component is limited to 8 bits.
|
|
</summary>
|
|
<returns>
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> that this method creates.
|
|
</returns>
|
|
<param name="red">
|
|
The red component value for the new <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" />. Valid values are 0 through 255.
|
|
</param>
|
|
<param name="green">
|
|
The green component value for the new <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" />. Valid values are 0 through 255.
|
|
</param>
|
|
<param name="blue">
|
|
The blue component value for the new <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" />. Valid values are 0 through 255.
|
|
</param>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="red" />, <paramref name="green" />, or <paramref name="blue" /> is less than 0 or greater than 255.
|
|
</exception>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.Equals(System.Object)">
|
|
<summary>
|
|
Tests whether the specified object is a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure and is equivalent to this
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" />
|
|
structure.
|
|
</summary>
|
|
<returns>
|
|
true if <paramref name="obj" /> is a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure equivalent to this
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" />
|
|
structure; otherwise, false.
|
|
</returns>
|
|
<param name="obj">The object to test. </param>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure.
|
|
</summary>
|
|
<returns>
|
|
An integer value that specifies the hash code for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" />.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor.ToString">
|
|
<summary>
|
|
Converts this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor" /> structure to a human-readable string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RDashStyle">
|
|
<summary>
|
|
Specifies the style of dashed lines drawn with a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.RPen"/> object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle">
|
|
<summary>
|
|
Specifies style information applied to text.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent">
|
|
<summary>
|
|
Even class for handling keyboard events in <see cref="T:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent._control">
|
|
<summary>
|
|
is control is pressed
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent._aKeyCode">
|
|
<summary>
|
|
is 'A' key is pressed
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent._cKeyCode">
|
|
<summary>
|
|
is 'C' key is pressed
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent.#ctor(System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent.Control">
|
|
<summary>
|
|
is control is pressed
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent.AKeyCode">
|
|
<summary>
|
|
is 'A' key is pressed
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent.CKeyCode">
|
|
<summary>
|
|
is 'C' key is pressed
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RMouseEvent">
|
|
<summary>
|
|
Even class for handling keyboard events in <see cref="T:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RMouseEvent._leftButton">
|
|
<summary>
|
|
Is the left mouse button participated in the event
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RMouseEvent.#ctor(System.Boolean)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RMouseEvent.LeftButton">
|
|
<summary>
|
|
Is the left mouse button participated in the event
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint">
|
|
<summary>
|
|
Represents an ordered pair of floating-point x- and y-coordinates that defines a point in a two-dimensional plane.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Empty">
|
|
<summary>
|
|
Represents a new instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> class with member data left uninitialized.
|
|
</summary>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.#ctor(System.Double,System.Double)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> class with the specified coordinates.
|
|
</summary>
|
|
<param name="x">The horizontal position of the point. </param>
|
|
<param name="y">The vertical position of the point. </param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.IsEmpty">
|
|
<summary>
|
|
Gets a value indicating whether this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> is empty.
|
|
</summary>
|
|
<returns>
|
|
true if both <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.X" /> and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Y" />
|
|
are 0; otherwise, false.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.X">
|
|
<summary>
|
|
Gets or sets the x-coordinate of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</summary>
|
|
<returns>
|
|
The x-coordinate of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Y">
|
|
<summary>
|
|
Gets or sets the y-coordinate of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</summary>
|
|
<returns>
|
|
The y-coordinate of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.op_Addition(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Translates the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> by the specified
|
|
<see
|
|
cref="T:System.Drawing.SizeF" />
|
|
.
|
|
</summary>
|
|
<returns>
|
|
The translated <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</returns>
|
|
<param name="pt">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to translate.
|
|
</param>
|
|
<param name="sz">
|
|
The <see cref="T:System.Drawing.SizeF" /> that specifies the numbers to add to the x- and y-coordinates of the
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />
|
|
.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.op_Subtraction(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Translates a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> by the negative of a specified
|
|
<see
|
|
cref="T:System.Drawing.SizeF" />
|
|
.
|
|
</summary>
|
|
<returns>
|
|
The translated <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</returns>
|
|
<param name="pt">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to translate.
|
|
</param>
|
|
<param name="sz">
|
|
The <see cref="T:System.Drawing.SizeF" /> that specifies the numbers to subtract from the coordinates of
|
|
<paramref
|
|
name="pt" />
|
|
.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.op_Equality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Compares two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structures. The result specifies whether the values of the
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.X" />
|
|
and <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Y" /> properties of the two
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />
|
|
structures are equal.
|
|
</summary>
|
|
<returns>
|
|
true if the <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.X" /> and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Y" />
|
|
values of the left and right
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />
|
|
structures are equal; otherwise, false.
|
|
</returns>
|
|
<param name="left">
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to compare.
|
|
</param>
|
|
<param name="right">
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to compare.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.op_Inequality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Determines whether the coordinates of the specified points are not equal.
|
|
</summary>
|
|
<returns>
|
|
true to indicate the <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.X" /> and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Y" />
|
|
values of <paramref name="left" /> and
|
|
<paramref
|
|
name="right" />
|
|
are not equal; otherwise, false.
|
|
</returns>
|
|
<param name="left">
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to compare.
|
|
</param>
|
|
<param name="right">
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to compare.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Add(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Translates a given <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> by a specified
|
|
<see
|
|
cref="T:System.Drawing.SizeF" />
|
|
.
|
|
</summary>
|
|
<returns>
|
|
The translated <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</returns>
|
|
<param name="pt">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to translate.
|
|
</param>
|
|
<param name="sz">
|
|
The <see cref="T:System.Drawing.SizeF" /> that specifies the numbers to add to the coordinates of
|
|
<paramref
|
|
name="pt" />
|
|
.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Subtract(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Translates a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> by the negative of a specified size.
|
|
</summary>
|
|
<returns>
|
|
The translated <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</returns>
|
|
<param name="pt">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to translate.
|
|
</param>
|
|
<param name="sz">
|
|
The <see cref="T:System.Drawing.SizeF" /> that specifies the numbers to subtract from the coordinates of
|
|
<paramref
|
|
name="pt" />
|
|
.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.Equals(System.Object)">
|
|
<summary>
|
|
Specifies whether this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> contains the same coordinates as the specified
|
|
<see
|
|
cref="T:System.Object" />
|
|
.
|
|
</summary>
|
|
<returns>
|
|
This method returns true if <paramref name="obj" /> is a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> and has the same coordinates as this
|
|
<see
|
|
cref="T:System.Drawing.Point" />
|
|
.
|
|
</returns>
|
|
<param name="obj">
|
|
The <see cref="T:System.Object" /> to test.
|
|
</param>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure.
|
|
</summary>
|
|
<returns>
|
|
An integer value that specifies a hash value for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint.ToString">
|
|
<summary>
|
|
Converts this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to a human readable string.
|
|
</summary>
|
|
<returns>
|
|
A string that represents this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" />.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect">
|
|
<summary>
|
|
Stores a set of four floating-point numbers that represent the location and size of a rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Empty">
|
|
<summary>
|
|
Represents an instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> class with its members uninitialized.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.#ctor(System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> class with the specified location and size.
|
|
</summary>
|
|
<param name="x">The x-coordinate of the upper-left corner of the rectangle. </param>
|
|
<param name="y">The y-coordinate of the upper-left corner of the rectangle. </param>
|
|
<param name="width">The width of the rectangle. </param>
|
|
<param name="height">The height of the rectangle. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.#ctor(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> class with the specified location and size.
|
|
</summary>
|
|
<param name="location">A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> that represents the upper-left corner of the rectangular region.</param>
|
|
<param name="size">A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> that represents the width and height of the rectangular region.</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Location">
|
|
<summary>
|
|
Gets or sets the coordinates of the upper-left corner of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> that represents the upper-left corner of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Size">
|
|
<summary>
|
|
Gets or sets the size of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />.
|
|
</summary>
|
|
<returns>A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> that represents the width and height of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.X">
|
|
<summary>
|
|
Gets or sets the x-coordinate of the upper-left corner of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The x-coordinate of the upper-left corner of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Y">
|
|
<summary>
|
|
Gets or sets the y-coordinate of the upper-left corner of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The y-coordinate of the upper-left corner of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Width">
|
|
<summary>
|
|
Gets or sets the width of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The width of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Height">
|
|
<summary>
|
|
Gets or sets the height of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The height of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Left">
|
|
<summary>
|
|
Gets the x-coordinate of the left edge of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The x-coordinate of the left edge of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Top">
|
|
<summary>
|
|
Gets the y-coordinate of the top edge of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The y-coordinate of the top edge of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Right">
|
|
<summary>
|
|
Gets the x-coordinate that is the sum of <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.X" /> and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Width" />
|
|
of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The x-coordinate that is the sum of <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.X" /> and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Width" />
|
|
of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Bottom">
|
|
<summary>
|
|
Gets the y-coordinate that is the sum of <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Y" /> and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Height" />
|
|
of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The y-coordinate that is the sum of <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Y" /> and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Height" />
|
|
of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.IsEmpty">
|
|
<summary>
|
|
Tests whether the <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Width" /> or
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Height" />
|
|
property of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> has a value of zero.
|
|
</summary>
|
|
<returns>
|
|
This property returns true if the <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Width" /> or
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Height" />
|
|
property of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> has a value of zero; otherwise, false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.op_Equality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Tests whether two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structures have equal location and size.
|
|
</summary>
|
|
<returns>
|
|
This operator returns true if the two specified <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structures have equal
|
|
<see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.X" />, <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Y" />, <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Width" />, and <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Height" /> properties.
|
|
</returns>
|
|
<param name="left">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure that is to the left of the equality operator.
|
|
</param>
|
|
<param name="right">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure that is to the right of the equality operator.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.op_Inequality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Tests whether two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structures differ in location or size.
|
|
</summary>
|
|
<returns>
|
|
This operator returns true if any of the <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.X" /> ,
|
|
<see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Y" />, <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Width" />, or <see cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Height" />
|
|
properties of the two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structures are unequal; otherwise false.
|
|
</returns>
|
|
<param name="left">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure that is to the left of the inequality operator.
|
|
</param>
|
|
<param name="right">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure that is to the right of the inequality operator.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.FromLTRB(System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Creates a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure with upper-left corner and lower-right corner at the specified locations.
|
|
</summary>
|
|
<returns>
|
|
The new <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> that this method creates.
|
|
</returns>
|
|
<param name="left">The x-coordinate of the upper-left corner of the rectangular region. </param>
|
|
<param name="top">The y-coordinate of the upper-left corner of the rectangular region. </param>
|
|
<param name="right">The x-coordinate of the lower-right corner of the rectangular region. </param>
|
|
<param name="bottom">The y-coordinate of the lower-right corner of the rectangular region. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Equals(System.Object)">
|
|
<summary>
|
|
Tests whether <paramref name="obj" /> is a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> with the same location and size of this
|
|
<see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />.
|
|
</summary>
|
|
<returns>
|
|
This method returns true if <paramref name="obj" /> is a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> and its X, Y, Width, and Height properties are equal to the corresponding properties of this
|
|
<see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />; otherwise, false.
|
|
</returns>
|
|
<param name="obj">
|
|
The <see cref="T:System.Object" /> to test.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Contains(System.Double,System.Double)">
|
|
<summary>
|
|
Determines if the specified point is contained within this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
This method returns true if the point defined by <paramref name="x" /> and <paramref name="y" /> is contained within this
|
|
<see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />
|
|
structure; otherwise false.
|
|
</returns>
|
|
<param name="x">The x-coordinate of the point to test. </param>
|
|
<param name="y">The y-coordinate of the point to test. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Contains(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Determines if the specified point is contained within this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure.
|
|
</summary>
|
|
<returns>
|
|
This method returns true if the point represented by the <paramref name="pt" /> parameter is contained within this
|
|
<see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />
|
|
structure; otherwise false.
|
|
</returns>
|
|
<param name="pt">The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> to test.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Contains(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Determines if the rectangular region represented by <paramref name="rect" /> is entirely contained within this
|
|
<see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />
|
|
structure.
|
|
</summary>
|
|
<returns>
|
|
This method returns true if the rectangular region represented by <paramref name="rect" /> is entirely contained within the rectangular region represented by this
|
|
<see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />
|
|
; otherwise false.
|
|
</returns>
|
|
<param name="rect">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> to test.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Inflate(System.Double,System.Double)">
|
|
<summary>
|
|
Inflates this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure by the specified amount.
|
|
</summary>
|
|
<param name="x">
|
|
The amount to inflate this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure horizontally.
|
|
</param>
|
|
<param name="y">
|
|
The amount to inflate this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure vertically.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Inflate(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Inflates this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> by the specified amount.
|
|
</summary>
|
|
<param name="size">The amount to inflate this rectangle. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Inflate(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Double,System.Double)">
|
|
<summary>
|
|
Creates and returns an inflated copy of the specified <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure. The copy is inflated by the specified amount. The original rectangle remains unmodified.
|
|
</summary>
|
|
<returns>
|
|
The inflated <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />.
|
|
</returns>
|
|
<param name="rect">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> to be copied. This rectangle is not modified.
|
|
</param>
|
|
<param name="x">The amount to inflate the copy of the rectangle horizontally. </param>
|
|
<param name="y">The amount to inflate the copy of the rectangle vertically. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Intersect(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Replaces this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure with the intersection of itself and the specified
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />
|
|
structure.
|
|
</summary>
|
|
<param name="rect">The rectangle to intersect. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Intersect(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Returns a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure that represents the intersection of two rectangles. If there is no intersection, and empty
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" />
|
|
is returned.
|
|
</summary>
|
|
<returns>
|
|
A third <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure the size of which represents the overlapped area of the two specified rectangles.
|
|
</returns>
|
|
<param name="a">A rectangle to intersect. </param>
|
|
<param name="b">A rectangle to intersect. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.IntersectsWith(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Determines if this rectangle intersects with <paramref name="rect" />.
|
|
</summary>
|
|
<returns>
|
|
This method returns true if there is any intersection.
|
|
</returns>
|
|
<param name="rect">The rectangle to test. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Union(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Creates the smallest possible third rectangle that can contain both of two rectangles that form a union.
|
|
</summary>
|
|
<returns>
|
|
A third <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure that contains both of the two rectangles that form the union.
|
|
</returns>
|
|
<param name="a">A rectangle to union. </param>
|
|
<param name="b">A rectangle to union. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Offset(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Adjusts the location of this rectangle by the specified amount.
|
|
</summary>
|
|
<param name="pos">The amount to offset the location. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Offset(System.Double,System.Double)">
|
|
<summary>
|
|
Adjusts the location of this rectangle by the specified amount.
|
|
</summary>
|
|
<param name="x">The amount to offset the location horizontally. </param>
|
|
<param name="y">The amount to offset the location vertically. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.GetHashCode">
|
|
<summary>
|
|
Gets the hash code for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure. For information about the use of hash codes, see Object.GetHashCode.
|
|
</summary>
|
|
<returns>The hash code for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.ToString">
|
|
<summary>
|
|
Converts the Location and Size of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> to a human-readable string.
|
|
</summary>
|
|
<returns>
|
|
A string that contains the position, width, and height of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect" /> structure for example, "{X=20, Y=20, Width=100, Height=50}".
|
|
</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize">
|
|
<summary>
|
|
Stores an ordered pair of floating-point numbers, typically the width and height of a rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Empty">
|
|
<summary>
|
|
Gets a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure that has a
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Height" />
|
|
and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Width" />
|
|
value of 0.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure that has a
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Height" />
|
|
and
|
|
<see
|
|
cref="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Width" />
|
|
value of 0.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.#ctor(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure from the specified existing
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
structure.
|
|
</summary>
|
|
<param name="size">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure from which to create the new
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
structure.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.#ctor(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure from the specified <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure.
|
|
</summary>
|
|
<param name="pt">The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure from which to initialize this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.#ctor(System.Double,System.Double)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure from the specified dimensions.
|
|
</summary>
|
|
<param name="width">
|
|
The width component of the new <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</param>
|
|
<param name="height">
|
|
The height component of the new <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.IsEmpty">
|
|
<summary>
|
|
Gets a value that indicates whether this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure has zero width and height.
|
|
</summary>
|
|
<returns>
|
|
This property returns true when this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure has both a width and height of zero; otherwise, false.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Width">
|
|
<summary>
|
|
Gets or sets the horizontal component of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The horizontal component of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure, typically measured in pixels.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Height">
|
|
<summary>
|
|
Gets or sets the vertical component of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</summary>
|
|
<returns>
|
|
The vertical component of this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure, typically measured in pixels.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.op_Explicit(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)~TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint">
|
|
<summary>
|
|
Converts the specified <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to a
|
|
<see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure.
|
|
</summary>
|
|
<returns>The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure to which this operator converts.</returns>
|
|
<param name="size">The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to be converted
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.op_Addition(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Adds the width and height of one <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to the width and height of another
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
structure.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure that is the result of the addition operation.
|
|
</returns>
|
|
<param name="sz1">
|
|
The first <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to add.
|
|
</param>
|
|
<param name="sz2">
|
|
The second <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to add.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.op_Subtraction(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Subtracts the width and height of one <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure from the width and height of another
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
structure.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> that is the result of the subtraction operation.
|
|
</returns>
|
|
<param name="sz1">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the left side of the subtraction operator.
|
|
</param>
|
|
<param name="sz2">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the right side of the subtraction operator.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.op_Equality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Tests whether two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structures are equal.
|
|
</summary>
|
|
<returns>
|
|
This operator returns true if <paramref name="sz1" /> and <paramref name="sz2" /> have equal width and height; otherwise, false.
|
|
</returns>
|
|
<param name="sz1">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the left side of the equality operator.
|
|
</param>
|
|
<param name="sz2">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the right of the equality operator.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.op_Inequality(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Tests whether two <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structures are different.
|
|
</summary>
|
|
<returns>
|
|
This operator returns true if <paramref name="sz1" /> and <paramref name="sz2" /> differ either in width or height; false if
|
|
<paramref
|
|
name="sz1" />
|
|
and <paramref name="sz2" /> are equal.
|
|
</returns>
|
|
<param name="sz1">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the left of the inequality operator.
|
|
</param>
|
|
<param name="sz2">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the right of the inequality operator.
|
|
</param>
|
|
<filterpriority>3</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Add(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Adds the width and height of one <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to the width and height of another
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
structure.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure that is the result of the addition operation.
|
|
</returns>
|
|
<param name="sz1">
|
|
The first <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to add.
|
|
</param>
|
|
<param name="sz2">
|
|
The second <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to add.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Subtract(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Subtracts the width and height of one <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure from the width and height of another
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
structure.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure that is a result of the subtraction operation.
|
|
</returns>
|
|
<param name="sz1">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the left side of the subtraction operator.
|
|
</param>
|
|
<param name="sz2">
|
|
The <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure on the right side of the subtraction operator.
|
|
</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.Equals(System.Object)">
|
|
<summary>
|
|
Tests to see whether the specified object is a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure with the same dimensions as this
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
structure.
|
|
</summary>
|
|
<returns>
|
|
This method returns true if <paramref name="obj" /> is a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> and has the same width and height as this
|
|
<see
|
|
cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" />
|
|
; otherwise, false.
|
|
</returns>
|
|
<param name="obj">
|
|
The <see cref="T:System.Object" /> to test.
|
|
</param>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</summary>
|
|
<returns>
|
|
An integer value that specifies a hash value for this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.ToPointF">
|
|
<summary>
|
|
Converts a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure to a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure.
|
|
</summary>
|
|
<returns>
|
|
Returns a <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint" /> structure.
|
|
</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize.ToString">
|
|
<summary>
|
|
Creates a human-readable string that represents this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</summary>
|
|
<returns>
|
|
A string that represents this <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize" /> structure.
|
|
</returns>
|
|
<filterpriority>1</filterpriority>
|
|
<PermissionSet>
|
|
<IPermission
|
|
class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"
|
|
version="1" Flags="UnmanagedCode" />
|
|
</PermissionSet>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RAdapter">
|
|
<summary>
|
|
Platform adapter to bridge platform specific objects to HTML Renderer core library.<br/>
|
|
Core uses abstract renderer objects (RAdapter/RControl/REtc...) to access platform specific functionality, the concrete platforms
|
|
implements those objects to provide concrete platform implementation. Those allowing the core library to be platform agnostic.
|
|
<para>
|
|
Platforms: WinForms, WPF, Metro, PDF renders, etc.<br/>
|
|
Objects: UI elements(Controls), Graphics(Render context), Colors, Brushes, Pens, Fonts, Images, Clipboard, etc.<br/>
|
|
</para>
|
|
</summary>
|
|
<remarks>
|
|
It is best to have a singleton instance of this class for concrete implementation!<br/>
|
|
This is because it holds caches of default CssData, Images, Fonts and Brushes.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RAdapter._brushesCache">
|
|
<summary>
|
|
cache of brush color to brush instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RAdapter._penCache">
|
|
<summary>
|
|
cache of pen color to pen instance
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RAdapter._fontsHandler">
|
|
<summary>
|
|
cache of all the font used not to create same font again and again
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RAdapter._defaultCssData">
|
|
<summary>
|
|
default CSS parsed data singleton
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RAdapter._loadImage">
|
|
<summary>
|
|
image used to draw loading image icon
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RAdapter._errorImage">
|
|
<summary>
|
|
image used to draw error image icon
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.#ctor">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.DefaultCssData">
|
|
<summary>
|
|
Get the default CSS stylesheet data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetColor(System.String)">
|
|
<summary>
|
|
Resolve color value from given color name.
|
|
</summary>
|
|
<param name="colorName">the color name</param>
|
|
<returns>color value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetPen(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Get cached pen instance for the given color.
|
|
</summary>
|
|
<param name="color">the color to get pen for</param>
|
|
<returns>pen instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetSolidBrush(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Get cached solid brush instance for the given color.
|
|
</summary>
|
|
<param name="color">the color to get brush for</param>
|
|
<returns>brush instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetLinearGradientBrush(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,System.Double)">
|
|
<summary>
|
|
Get linear gradient color brush from <paramref name="color1"/> to <paramref name="color2"/>.
|
|
</summary>
|
|
<param name="rect">the rectangle to get the brush for</param>
|
|
<param name="color1">the start color of the gradient</param>
|
|
<param name="color2">the end color of the gradient</param>
|
|
<param name="angle">the angle to move the gradient from start color to end color in the rectangle</param>
|
|
<returns>linear gradient color brush instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.ConvertImage(System.Object)">
|
|
<summary>
|
|
Convert image object returned from <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs"/> to <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.RImage"/>.
|
|
</summary>
|
|
<param name="image">the image returned from load event</param>
|
|
<returns>converted image or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.ImageFromStream(System.IO.Stream)">
|
|
<summary>
|
|
Create an <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.RImage"/> object from the given stream.
|
|
</summary>
|
|
<param name="memoryStream">the stream to create image from</param>
|
|
<returns>new image instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.IsFontExists(System.String)">
|
|
<summary>
|
|
Check if the given font exists in the system by font family name.
|
|
</summary>
|
|
<param name="font">the font name to check</param>
|
|
<returns>true - font exists by given family name, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.AddFontFamily(TheArtOfDev.HtmlRenderer.Adapters.RFontFamily)">
|
|
<summary>
|
|
Adds a font family to be used.
|
|
</summary>
|
|
<param name="fontFamily">The font family to add.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.AddFontFamilyMapping(System.String,System.String)">
|
|
<summary>
|
|
Adds a font mapping from <paramref name="fromFamily"/> to <paramref name="toFamily"/> iff the <paramref name="fromFamily"/> is not found.<br/>
|
|
When the <paramref name="fromFamily"/> font is used in rendered html and is not found in existing
|
|
fonts (installed or added) it will be replaced by <paramref name="toFamily"/>.<br/>
|
|
</summary>
|
|
<param name="fromFamily">the font family to replace</param>
|
|
<param name="toFamily">the font family to replace with</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetFont(System.String,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)">
|
|
<summary>
|
|
Get font instance by given font family name, size and style.
|
|
</summary>
|
|
<param name="family">the font family name</param>
|
|
<param name="size">font size</param>
|
|
<param name="style">font style</param>
|
|
<returns>font instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetLoadingImage">
|
|
<summary>
|
|
Get image to be used while HTML image is loading.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetLoadingFailedImage">
|
|
<summary>
|
|
Get image to be used if HTML image load failed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetClipboardDataObject(System.String,System.String)">
|
|
<summary>
|
|
Get data object for the given html and plain text data.<br />
|
|
The data object can be used for clipboard or drag-drop operation.<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
<param name="html">the html data</param>
|
|
<param name="plainText">the plain text data</param>
|
|
<returns>drag-drop data object</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SetToClipboard(System.String)">
|
|
<summary>
|
|
Set the given text to the clipboard<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
<param name="text">the text to set</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SetToClipboard(System.String,System.String)">
|
|
<summary>
|
|
Set the given html and plain text data to clipboard.<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
<param name="html">the html data</param>
|
|
<param name="plainText">the plain text data</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SetToClipboard(TheArtOfDev.HtmlRenderer.Adapters.RImage)">
|
|
<summary>
|
|
Set the given image to clipboard.<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
<param name="image">the image object to set to clipboard</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetContextMenu">
|
|
<summary>
|
|
Create a context menu that can be used on the control<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
<returns>new context menu</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SaveToFile(TheArtOfDev.HtmlRenderer.Adapters.RImage,System.String,System.String,TheArtOfDev.HtmlRenderer.Adapters.RControl)">
|
|
<summary>
|
|
Save the given image to file by showing save dialog to the client.<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
<param name="image">the image to save</param>
|
|
<param name="name">the name of the image for save dialog</param>
|
|
<param name="extension">the extension of the image for save dialog</param>
|
|
<param name="control">optional: the control to show the dialog on</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreateFont(System.String,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)">
|
|
<summary>
|
|
Get font instance by given font family name, size and style.
|
|
</summary>
|
|
<param name="family">the font family name</param>
|
|
<param name="size">font size</param>
|
|
<param name="style">font style</param>
|
|
<returns>font instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreateFont(TheArtOfDev.HtmlRenderer.Adapters.RFontFamily,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)">
|
|
<summary>
|
|
Get font instance by given font family instance, size and style.<br/>
|
|
Used to support custom fonts that require explicit font family instance to be created.
|
|
</summary>
|
|
<param name="family">the font family instance</param>
|
|
<param name="size">font size</param>
|
|
<param name="style">font style</param>
|
|
<returns>font instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetColorInt(System.String)">
|
|
<summary>
|
|
Resolve color value from given color name.
|
|
</summary>
|
|
<param name="colorName">the color name</param>
|
|
<returns>color value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreatePen(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Get cached pen instance for the given color.
|
|
</summary>
|
|
<param name="color">the color to get pen for</param>
|
|
<returns>pen instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreateSolidBrush(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Get cached solid brush instance for the given color.
|
|
</summary>
|
|
<param name="color">the color to get brush for</param>
|
|
<returns>brush instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreateLinearGradientBrush(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,System.Double)">
|
|
<summary>
|
|
Get linear gradient color brush from <paramref name="color1"/> to <paramref name="color2"/>.
|
|
</summary>
|
|
<param name="rect">the rectangle to get the brush for</param>
|
|
<param name="color1">the start color of the gradient</param>
|
|
<param name="color2">the end color of the gradient</param>
|
|
<param name="angle">the angle to move the gradient from start color to end color in the rectangle</param>
|
|
<returns>linear gradient color brush instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.ConvertImageInt(System.Object)">
|
|
<summary>
|
|
Convert image object returned from <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs"/> to <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.RImage"/>.
|
|
</summary>
|
|
<param name="image">the image returned from load event</param>
|
|
<returns>converted image or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.ImageFromStreamInt(System.IO.Stream)">
|
|
<summary>
|
|
Create an <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.RImage"/> object from the given stream.
|
|
</summary>
|
|
<param name="memoryStream">the stream to create image from</param>
|
|
<returns>new image instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreateFontInt(System.String,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)">
|
|
<summary>
|
|
Get font instance by given font family name, size and style.
|
|
</summary>
|
|
<param name="family">the font family name</param>
|
|
<param name="size">font size</param>
|
|
<param name="style">font style</param>
|
|
<returns>font instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreateFontInt(TheArtOfDev.HtmlRenderer.Adapters.RFontFamily,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)">
|
|
<summary>
|
|
Get font instance by given font family instance, size and style.<br/>
|
|
Used to support custom fonts that require explicit font family instance to be created.
|
|
</summary>
|
|
<param name="family">the font family instance</param>
|
|
<param name="size">font size</param>
|
|
<param name="style">font style</param>
|
|
<returns>font instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.GetClipboardDataObjectInt(System.String,System.String)">
|
|
<summary>
|
|
Get data object for the given html and plain text data.<br />
|
|
The data object can be used for clipboard or drag-drop operation.
|
|
</summary>
|
|
<param name="html">the html data</param>
|
|
<param name="plainText">the plain text data</param>
|
|
<returns>drag-drop data object</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SetToClipboardInt(System.String)">
|
|
<summary>
|
|
Set the given text to the clipboard
|
|
</summary>
|
|
<param name="text">the text to set</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SetToClipboardInt(System.String,System.String)">
|
|
<summary>
|
|
Set the given html and plain text data to clipboard.
|
|
</summary>
|
|
<param name="html">the html data</param>
|
|
<param name="plainText">the plain text data</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SetToClipboardInt(TheArtOfDev.HtmlRenderer.Adapters.RImage)">
|
|
<summary>
|
|
Set the given image to clipboard.
|
|
</summary>
|
|
<param name="image"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.CreateContextMenuInt">
|
|
<summary>
|
|
Create a context menu that can be used on the control
|
|
</summary>
|
|
<returns>new context menu</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RAdapter.SaveToFileInt(TheArtOfDev.HtmlRenderer.Adapters.RImage,System.String,System.String,TheArtOfDev.HtmlRenderer.Adapters.RControl)">
|
|
<summary>
|
|
Save the given image to file by showing save dialog to the client.
|
|
</summary>
|
|
<param name="image">the image to save</param>
|
|
<param name="name">the name of the image for save dialog</param>
|
|
<param name="extension">the extension of the image for save dialog</param>
|
|
<param name="control">optional: the control to show the dialog on</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RBrush">
|
|
<summary>
|
|
Adapter for platform specific brush objects - used to fill graphics (rectangles, polygons and paths).<br/>
|
|
The brush can be solid color, gradient or image.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RContextMenu">
|
|
<summary>
|
|
Adapter for platform specific context menu - used to create and show context menu at specific location.<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RContextMenu.ItemsCount">
|
|
<summary>
|
|
The total number of items in the context menu
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RContextMenu.AddDivider">
|
|
<summary>
|
|
Add divider item to the context menu.<br />
|
|
The divider is a non clickable place holder used to separate items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RContextMenu.AddItem(System.String,System.Boolean,System.EventHandler)">
|
|
<summary>
|
|
Add item to the context menu with the given text that will raise the given event when clicked.
|
|
</summary><param name="text">the text to set on the new context menu item</param><param name="enabled">if to set the item as enabled or disabled</param><param name="onClick">the event to raise when the item is clicked</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RContextMenu.RemoveLastDivider">
|
|
<summary>
|
|
Remove the last item from the context menu iff it is a divider
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RContextMenu.Show(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Show the context menu in the given parent control at the given location.
|
|
</summary><param name="parent">the parent control to show in</param><param name="location">the location to show at relative to the parent control</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RControl">
|
|
<summary>
|
|
Adapter for platform specific control object - used to handle updating the control that the html is rendered on.<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RControl._adapter">
|
|
<summary>
|
|
The platform adapter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RControl.#ctor(TheArtOfDev.HtmlRenderer.Adapters.RAdapter)">
|
|
<summary>
|
|
Init control with platform adapter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RControl.Adapter">
|
|
<summary>
|
|
The platform adapter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RControl.LeftMouseButton">
|
|
<summary>
|
|
Is the left mouse button is currently in pressed state
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RControl.RightMouseButton">
|
|
<summary>
|
|
Is the right mouse button is currently in pressed state
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RControl.MouseLocation">
|
|
<summary>
|
|
Get the current location of the mouse relative to the control
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RControl.SetCursorDefault">
|
|
<summary>
|
|
Set the cursor over the control to default cursor
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RControl.SetCursorHand">
|
|
<summary>
|
|
Set the cursor over the control to hand cursor
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RControl.SetCursorIBeam">
|
|
<summary>
|
|
Set the cursor over the control to I beam cursor
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RControl.DoDragDropCopy(System.Object)">
|
|
<summary>
|
|
Do drag-drop copy operation for the given data object.
|
|
</summary>
|
|
<param name="dragDropData">the drag-drop data object</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RControl.MeasureString(System.String,TheArtOfDev.HtmlRenderer.Adapters.RFont,System.Double,System.Int32@,System.Double@)">
|
|
<summary>
|
|
Measure the width of string under max width restriction calculating the number of characters that can fit and the width those characters take.<br/>
|
|
</summary>
|
|
<param name="str">the string to measure</param>
|
|
<param name="font">the font to measure string with</param>
|
|
<param name="maxWidth">the max width to calculate fit characters</param>
|
|
<param name="charFit">the number of characters that will fit under <see cref="!:maxWidth"/> restriction</param>
|
|
<param name="charFitWidth">the width that only the characters that fit into max width take</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RControl.Invalidate">
|
|
<summary>
|
|
Invalidates the entire surface of the control and causes the control to be redrawn.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RFont">
|
|
<summary>
|
|
Adapter for platform specific font object - used to render text using specific font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RFont.Size">
|
|
<summary>
|
|
Gets the em-size of this Font measured in the units specified by the Unit property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RFont.Height">
|
|
<summary>
|
|
The line spacing, in pixels, of this font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RFont.UnderlineOffset">
|
|
<summary>
|
|
Get the vertical offset of the font underline location from the top of the font.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RFont.LeftPadding">
|
|
<summary>
|
|
Get the left padding, in pixels, of the font.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RFontFamily">
|
|
<summary>
|
|
Adapter for platform specific font family object - define the available font families to use.<br/>
|
|
Required for custom fonts handling: fonts that are not installed on the system.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RFontFamily.Name">
|
|
<summary>
|
|
Gets the name of this Font Family.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RGraphics">
|
|
<summary>
|
|
Adapter for platform specific graphics rendering object - used to render graphics and text in platform specific context.<br/>
|
|
The core HTML Renderer components use this class for rendering logic, extending this
|
|
class in different platform: WinForms, WPF, Metro, PDF, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RGraphics._adapter">
|
|
<summary>
|
|
the global adapter
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RGraphics._clipStack">
|
|
<summary>
|
|
The clipping bound stack as clips are pushed/poped to/from the graphics
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Adapters.RGraphics._suspendedClips">
|
|
<summary>
|
|
The suspended clips
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.#ctor(TheArtOfDev.HtmlRenderer.Adapters.RAdapter,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.GetPen(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Get color pen.
|
|
</summary>
|
|
<param name="color">the color to get the pen for</param>
|
|
<returns>pen instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.GetSolidBrush(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Get solid color brush.
|
|
</summary>
|
|
<param name="color">the color to get the brush for</param>
|
|
<returns>solid color brush instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.GetLinearGradientBrush(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,System.Double)">
|
|
<summary>
|
|
Get linear gradient color brush from <paramref name="color1"/> to <paramref name="color2"/>.
|
|
</summary>
|
|
<param name="rect">the rectangle to get the brush for</param>
|
|
<param name="color1">the start color of the gradient</param>
|
|
<param name="color2">the end color of the gradient</param>
|
|
<param name="angle">the angle to move the gradient from start color to end color in the rectangle</param>
|
|
<returns>linear gradient color brush instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.GetClip">
|
|
<summary>
|
|
Gets a Rectangle structure that bounds the clipping region of this Graphics.
|
|
</summary>
|
|
<returns>A rectangle structure that represents a bounding rectangle for the clipping region of this Graphics.</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.PopClip">
|
|
<summary>
|
|
Pop the latest clip push.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.PushClip(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Push the clipping region of this Graphics to interception of current clipping rectangle and the given rectangle.
|
|
</summary>
|
|
<param name="rect">Rectangle to clip to.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.PushClipExclude(TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Push the clipping region of this Graphics to exclude the given rectangle from the current clipping rectangle.
|
|
</summary>
|
|
<param name="rect">Rectangle to exclude clipping in.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.SuspendClipping">
|
|
<summary>
|
|
Restore the clipping region to the initial clip.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.ResumeClipping">
|
|
<summary>
|
|
Resumes the suspended clips.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.SetAntiAliasSmoothingMode">
|
|
<summary>
|
|
Set the graphics smooth mode to use anti-alias.<br/>
|
|
Use <see cref="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.ReturnPreviousSmoothingMode(System.Object)"/> to return back the mode used.
|
|
</summary>
|
|
<returns>the previous smooth mode before the change</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.ReturnPreviousSmoothingMode(System.Object)">
|
|
<summary>
|
|
Return to previous smooth mode before anti-alias was set as returned from <see cref="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.SetAntiAliasSmoothingMode"/>.
|
|
</summary>
|
|
<param name="prevMode">the previous mode to set</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.GetTextureBrush(TheArtOfDev.HtmlRenderer.Adapters.RImage,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Get TextureBrush object that uses the specified image and bounding rectangle.
|
|
</summary>
|
|
<param name="image">The Image object with which this TextureBrush object fills interiors.</param>
|
|
<param name="dstRect">A Rectangle structure that represents the bounding rectangle for this TextureBrush object.</param>
|
|
<param name="translateTransformLocation">The dimension by which to translate the transformation</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.GetGraphicsPath">
|
|
<summary>
|
|
Get GraphicsPath object.
|
|
</summary>
|
|
<returns>graphics path instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.MeasureString(System.String,TheArtOfDev.HtmlRenderer.Adapters.RFont)">
|
|
<summary>
|
|
Measure the width and height of string <paramref name="str"/> when drawn on device context HDC
|
|
using the given font <paramref name="font"/>.
|
|
</summary>
|
|
<param name="str">the string to measure</param>
|
|
<param name="font">the font to measure string with</param>
|
|
<returns>the size of the string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.MeasureString(System.String,TheArtOfDev.HtmlRenderer.Adapters.RFont,System.Double,System.Int32@,System.Double@)">
|
|
<summary>
|
|
Measure the width of string under max width restriction calculating the number of characters that can fit and the width those characters take.<br/>
|
|
Not relevant for platforms that don't render HTML on UI element.
|
|
</summary>
|
|
<param name="str">the string to measure</param>
|
|
<param name="font">the font to measure string with</param>
|
|
<param name="maxWidth">the max width to calculate fit characters</param>
|
|
<param name="charFit">the number of characters that will fit under <see cref="!:maxWidth"/> restriction</param>
|
|
<param name="charFitWidth">the width that only the characters that fit into max width take</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawString(System.String,TheArtOfDev.HtmlRenderer.Adapters.RFont,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,System.Boolean)">
|
|
<summary>
|
|
Draw the given string using the given font and foreground color at given location.
|
|
</summary>
|
|
<param name="str">the string to draw</param>
|
|
<param name="font">the font to use to draw the string</param>
|
|
<param name="color">the text color to set</param>
|
|
<param name="point">the location to start string draw (top-left)</param>
|
|
<param name="size">used to know the size of the rendered text for transparent text support</param>
|
|
<param name="rtl">is to render the string right-to-left (true - RTL, false - LTR)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawLine(TheArtOfDev.HtmlRenderer.Adapters.RPen,System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Draws a line connecting the two points specified by the coordinate pairs.
|
|
</summary>
|
|
<param name="pen">Pen that determines the color, width, and style of the line. </param>
|
|
<param name="x1">The x-coordinate of the first point. </param>
|
|
<param name="y1">The y-coordinate of the first point. </param>
|
|
<param name="x2">The x-coordinate of the second point. </param>
|
|
<param name="y2">The y-coordinate of the second point. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawRectangle(TheArtOfDev.HtmlRenderer.Adapters.RPen,System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Draws a rectangle specified by a coordinate pair, a width, and a height.
|
|
</summary>
|
|
<param name="pen">A Pen that determines the color, width, and style of the rectangle. </param>
|
|
<param name="x">The x-coordinate of the upper-left corner of the rectangle to draw. </param>
|
|
<param name="y">The y-coordinate of the upper-left corner of the rectangle to draw. </param>
|
|
<param name="width">The width of the rectangle to draw. </param>
|
|
<param name="height">The height of the rectangle to draw. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawRectangle(TheArtOfDev.HtmlRenderer.Adapters.RBrush,System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Fills the interior of a rectangle specified by a pair of coordinates, a width, and a height.
|
|
</summary>
|
|
<param name="brush">Brush that determines the characteristics of the fill. </param>
|
|
<param name="x">The x-coordinate of the upper-left corner of the rectangle to fill. </param>
|
|
<param name="y">The y-coordinate of the upper-left corner of the rectangle to fill. </param>
|
|
<param name="width">Width of the rectangle to fill. </param>
|
|
<param name="height">Height of the rectangle to fill. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawImage(TheArtOfDev.HtmlRenderer.Adapters.RImage,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draws the specified portion of the specified <see cref="T:TheArtOfDev.HtmlRenderer.Adapters.RImage"/> at the specified location and with the specified size.
|
|
</summary>
|
|
<param name="image">Image to draw. </param>
|
|
<param name="destRect">Rectangle structure that specifies the location and size of the drawn image. The image is scaled to fit the rectangle. </param>
|
|
<param name="srcRect">Rectangle structure that specifies the portion of the <paramref name="image"/> object to draw. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawImage(TheArtOfDev.HtmlRenderer.Adapters.RImage,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draws the specified Image at the specified location and with the specified size.
|
|
</summary>
|
|
<param name="image">Image to draw. </param>
|
|
<param name="destRect">Rectangle structure that specifies the location and size of the drawn image. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawPath(TheArtOfDev.HtmlRenderer.Adapters.RPen,TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath)">
|
|
<summary>
|
|
Draws a GraphicsPath.
|
|
</summary>
|
|
<param name="pen">Pen that determines the color, width, and style of the path. </param>
|
|
<param name="path">GraphicsPath to draw. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawPath(TheArtOfDev.HtmlRenderer.Adapters.RBrush,TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath)">
|
|
<summary>
|
|
Fills the interior of a GraphicsPath.
|
|
</summary>
|
|
<param name="brush">Brush that determines the characteristics of the fill. </param>
|
|
<param name="path">GraphicsPath that represents the path to fill. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.DrawPolygon(TheArtOfDev.HtmlRenderer.Adapters.RBrush,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint[])">
|
|
<summary>
|
|
Fills the interior of a polygon defined by an array of points specified by Point structures.
|
|
</summary>
|
|
<param name="brush">Brush that determines the characteristics of the fill. </param>
|
|
<param name="points">Array of Point structures that represent the vertices of the polygon to fill. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphics.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath">
|
|
<summary>
|
|
Adapter for platform specific graphics path object - used to render (draw/fill) path shape.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath.Start(System.Double,System.Double)">
|
|
<summary>
|
|
Start path at the given point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath.LineTo(System.Double,System.Double)">
|
|
<summary>
|
|
Add stright line to the given point from te last point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath.ArcTo(System.Double,System.Double,System.Double,TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath.Corner)">
|
|
<summary>
|
|
Add circular arc of the given size to the given point from the last point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath.Dispose">
|
|
<summary>
|
|
Release path resources.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RGraphicsPath.Corner">
|
|
<summary>
|
|
The 4 corners that are handled in arc rendering.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RImage">
|
|
<summary>
|
|
Adapter for platform specific image object - used to render images.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RImage.Width">
|
|
<summary>
|
|
Get the width, in pixels, of the image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RImage.Height">
|
|
<summary>
|
|
Get the height, in pixels, of the image.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Adapters.RPen">
|
|
<summary>
|
|
Adapter for platform specific pen objects - used to draw graphics (lines, rectangles and paths)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RPen.Width">
|
|
<summary>
|
|
Gets or sets the width of this Pen, in units of the Graphics object used for drawing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Adapters.RPen.DashStyle">
|
|
<summary>
|
|
Gets or sets the style used for dashed lines drawn with this Pen.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.CssData">
|
|
<summary>
|
|
Holds parsed stylesheet css blocks arranged by media and classes.<br/>
|
|
<seealso cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock"/>
|
|
</summary>
|
|
<remarks>
|
|
To learn more about CSS blocks visit CSS spec: http://www.w3.org/TR/CSS21/syndata.html#block
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.CssData._emptyArray">
|
|
<summary>
|
|
used to return empty array
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.CssData._mediaBlocks">
|
|
<summary>
|
|
dictionary of media type to dictionary of css class name to the cssBlocks collection with all the data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.CssData.#ctor">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.CssData.Parse(TheArtOfDev.HtmlRenderer.Adapters.RAdapter,System.String,System.Boolean)">
|
|
<summary>
|
|
Parse the given stylesheet to <see cref="T:TheArtOfDev.HtmlRenderer.Core.CssData"/> object.<br/>
|
|
If <paramref name="combineWithDefault"/> is true the parsed css blocks are added to the
|
|
default css data (as defined by W3), merged if class name already exists. If false only the data in the given stylesheet is returned.
|
|
</summary>
|
|
<seealso cref="!:http://www.w3.org/TR/CSS21/sample.html"/>
|
|
<param name="adapter">Platform adapter</param>
|
|
<param name="stylesheet">the stylesheet source to parse</param>
|
|
<param name="combineWithDefault">true - combine the parsed css data with default css data, false - return only the parsed css data</param>
|
|
<returns>the parsed css data</returns>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.CssData.MediaBlocks">
|
|
<summary>
|
|
dictionary of media type to dictionary of css class name to the cssBlocks collection with all the data
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.CssData.ContainsCssBlock(System.String,System.String)">
|
|
<summary>
|
|
Check if there are css blocks for the given class selector.
|
|
</summary>
|
|
<param name="className">the class selector to check for css blocks by</param>
|
|
<param name="media">optional: the css media type (default - all)</param>
|
|
<returns>true - has css blocks for the class, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.CssData.GetCssBlock(System.String,System.String)">
|
|
<summary>
|
|
Get collection of css blocks for the requested class selector.<br/>
|
|
the <paramref name="className"/> can be: class name, html element name, html element and
|
|
class name (elm.class), hash tag with element id (#id).<br/>
|
|
returned all the blocks that word on the requested class selector, it can contain simple
|
|
selector or hierarchy selector.
|
|
</summary>
|
|
<param name="className">the class selector to get css blocks by</param>
|
|
<param name="media">optional: the css media type (default - all)</param>
|
|
<returns>collection of css blocks, empty collection if no blocks exists (never null)</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.CssData.AddCssBlock(System.String,TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Add the given css block to the css data, merging to existing block if required.
|
|
</summary>
|
|
<remarks>
|
|
If there is no css blocks for the same class it will be added to data collection.<br/>
|
|
If there is already css blocks for the same class it will check for each existing block
|
|
if the hierarchical selectors match (or not exists). if do the two css blocks will be merged into
|
|
one where the new block properties overwrite existing if needed. if the new block doesn't mach any
|
|
existing it will be added either to the beginning of the list if it has no hierarchical selectors or at the end.<br/>
|
|
Css block without hierarchical selectors must be added to the beginning of the list so more specific block
|
|
can overwrite it when the style is applied.
|
|
</remarks>
|
|
<param name="media">the media type to add the CSS to</param>
|
|
<param name="cssBlock">the css block to add</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.CssData.Combine(TheArtOfDev.HtmlRenderer.Core.CssData)">
|
|
<summary>
|
|
Combine this CSS data blocks with <paramref name="other"/> CSS blocks for each media.<br/>
|
|
Merge blocks if exists in both.
|
|
</summary>
|
|
<param name="other">the CSS data to combine with</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.CssData.Clone">
|
|
<summary>
|
|
Create deep copy of the css data with cloned css blocks.
|
|
</summary>
|
|
<returns>cloned object</returns>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.CssDefaults.DefaultStyleSheet">
|
|
<summary>
|
|
CSS Specification's Default Style Sheet for HTML 4
|
|
</summary>
|
|
<remarks>
|
|
http://www.w3.org/TR/CSS21/sample.html
|
|
</remarks>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.Border">
|
|
<summary>
|
|
Border types
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox">
|
|
<summary>
|
|
Represents a CSS Box of text or replaced elements.
|
|
</summary>
|
|
<remarks>
|
|
The Box can contains other boxes, that's the way that the CSS Tree
|
|
is composed.
|
|
|
|
To know more about boxes visit CSS spec:
|
|
http://www.w3.org/TR/CSS21/box.html
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox._parentBox">
|
|
<summary>
|
|
the parent css box of this css box in the hierarchy
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox._htmlContainer">
|
|
<summary>
|
|
the root container for the hierarchy
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox._htmltag">
|
|
<summary>
|
|
the html tag that is associated with this css box, null if anonymous box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox._text">
|
|
<summary>
|
|
the inner text of the box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox._tableFixed">
|
|
<summary>
|
|
Do not use or alter this flag
|
|
</summary>
|
|
<remarks>
|
|
Flag that indicates that CssTable algorithm already made fixes on it.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox._imageLoadHandler">
|
|
<summary>
|
|
handler for loading background image
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="parentBox">optional: the parent of this css box in html</param>
|
|
<param name="tag">optional: the html tag associated with this css box</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.HtmlContainer">
|
|
<summary>
|
|
Gets the HtmlContainer of the Box.
|
|
WARNING: May be null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.ParentBox">
|
|
<summary>
|
|
Gets or sets the parent box of this box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.Boxes">
|
|
<summary>
|
|
Gets the children boxes of this box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.IsBrElement">
|
|
<summary>
|
|
Is the box is of "br" element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.IsInline">
|
|
<summary>
|
|
is the box "Display" is "Inline", is this is an inline box and not block.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.IsBlock">
|
|
<summary>
|
|
is the box "Display" is "Block", is this is an block box and not inline.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.IsClickable">
|
|
<summary>
|
|
Is the css box clickable (by default only "a" element is clickable)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.IsFixed">
|
|
<summary>
|
|
Gets a value indicating whether this instance or one of its parents has Position = fixed.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instance is fixed; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.HrefLink">
|
|
<summary>
|
|
Get the href link of the box (by default get "href" attribute)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.ContainingBlock">
|
|
<summary>
|
|
Gets the containing block-box of this box. (The nearest parent box with display=block)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.HtmlTag">
|
|
<summary>
|
|
Gets the HTMLTag that hosts this box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.IsImage">
|
|
<summary>
|
|
Gets if this box represents an image
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.IsSpaceOrEmpty">
|
|
<summary>
|
|
Tells if the box is empty or contains just blank spaces
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.Text">
|
|
<summary>
|
|
Gets or sets the inner text of the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.LineBoxes">
|
|
<summary>
|
|
Gets the line-boxes of this box (if block box)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.ParentLineBoxes">
|
|
<summary>
|
|
Gets the linebox(es) that contains words of this box (if inline)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.Rectangles">
|
|
<summary>
|
|
Gets the rectangles where this box should be painted
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.Words">
|
|
<summary>
|
|
Gets the BoxWords of text in the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.FirstWord">
|
|
<summary>
|
|
Gets the first word of the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.FirstHostingLineBox">
|
|
<summary>
|
|
Gets or sets the first linebox where content of this box appear
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.LastHostingLineBox">
|
|
<summary>
|
|
Gets or sets the last linebox where content of this box appear
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.CreateBox(TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Create new css box for the given parent with the given html tag.<br/>
|
|
</summary>
|
|
<param name="tag">the html tag to define the box</param>
|
|
<param name="parent">the box to add the new box to it as child</param>
|
|
<returns>the new box</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.CreateBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Create new css box for the given parent with the given optional html tag and insert it either
|
|
at the end or before the given optional box.<br/>
|
|
If no html tag is given the box will be anonymous.<br/>
|
|
If no before box is given the new box will be added at the end of parent boxes collection.<br/>
|
|
If before box doesn't exists in parent box exception is thrown.<br/>
|
|
</summary>
|
|
<remarks>
|
|
To learn more about anonymous inline boxes visit: http://www.w3.org/TR/CSS21/visuren.html#anonymous
|
|
</remarks>
|
|
<param name="parent">the box to add the new box to it as child</param>
|
|
<param name="tag">optional: the html tag to define the box</param>
|
|
<param name="before">optional: to insert as specific location in parent box</param>
|
|
<returns>the new box</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.CreateBlock">
|
|
<summary>
|
|
Create new css block box.
|
|
</summary>
|
|
<returns>the new block box</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.CreateBlock(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Create new css block box for the given parent with the given optional html tag and insert it either
|
|
at the end or before the given optional box.<br/>
|
|
If no html tag is given the box will be anonymous.<br/>
|
|
If no before box is given the new box will be added at the end of parent boxes collection.<br/>
|
|
If before box doesn't exists in parent box exception is thrown.<br/>
|
|
</summary>
|
|
<remarks>
|
|
To learn more about anonymous block boxes visit CSS spec:
|
|
http://www.w3.org/TR/CSS21/visuren.html#anonymous-block-level
|
|
</remarks>
|
|
<param name="parent">the box to add the new block box to it as child</param>
|
|
<param name="tag">optional: the html tag to define the box</param>
|
|
<param name="before">optional: to insert as specific location in parent box</param>
|
|
<returns>the new block box</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.PerformLayout(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Measures the bounds of box and children, recursively.<br/>
|
|
Performs layout of the DOM structure creating lines by set bounds restrictions.
|
|
</summary>
|
|
<param name="g">Device context to use</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.Paint(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Paints the fragment
|
|
</summary>
|
|
<param name="g">Device context to use</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.SetBeforeBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Set this box in
|
|
</summary>
|
|
<param name="before"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.SetAllBoxes(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Move all child boxes from <paramref name="fromBox"/> to this box.
|
|
</summary>
|
|
<param name="fromBox">the box to move all its child boxes from</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.ParseToWords">
|
|
<summary>
|
|
Splits the text into words and saves the result
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.PerformLayoutImp(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Measures the bounds of box and children, recursively.<br/>
|
|
Performs layout of the DOM structure creating lines by set bounds restrictions.<br/>
|
|
</summary>
|
|
<param name="g">Device context to use</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.MeasureWordsSize(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Assigns words its width and height
|
|
</summary>
|
|
<param name="g"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetParent">
|
|
<summary>
|
|
Get the parent of this css properties instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetIndexForList">
|
|
<summary>
|
|
Gets the index of the box to be used on a (ordered) list
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.CreateListItemBox(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Creates the <see cref="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox._listItemBox"/>
|
|
</summary>
|
|
<param name="g"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.FirstWordOccourence(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Searches for the first word occurrence inside the box, on the specified linebox
|
|
</summary>
|
|
<param name="b"></param>
|
|
<param name="line"> </param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetAttribute(System.String)">
|
|
<summary>
|
|
Gets the specified Attribute, returns string.Empty if no attribute specified
|
|
</summary>
|
|
<param name="attribute">Attribute to retrieve</param>
|
|
<returns>Attribute value or string.Empty if no attribute specified</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetAttribute(System.String,System.String)">
|
|
<summary>
|
|
Gets the value of the specified attribute of the source HTML tag.
|
|
</summary>
|
|
<param name="attribute">Attribute to retrieve</param>
|
|
<param name="defaultValue">Value to return if attribute is not specified</param>
|
|
<returns>Attribute value or defaultValue if no attribute specified</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetMinimumWidth">
|
|
<summary>
|
|
Gets the minimum width that the box can be.<br/>
|
|
The box can be as thin as the longest word plus padding.<br/>
|
|
The check is deep thru box tree.<br/>
|
|
</summary>
|
|
<returns>the min width of the box</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetMinimumWidth_LongestWord(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Double@,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect@)">
|
|
<summary>
|
|
Gets the longest word (in width) inside the box, deeply.
|
|
</summary>
|
|
<param name="box"></param>
|
|
<param name="maxWidth"> </param>
|
|
<param name="maxWidthWord"> </param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetWidthMarginDeep(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Get the total margin value (left and right) from the given box to the given end box.<br/>
|
|
</summary>
|
|
<param name="box">the box to start calculation from.</param>
|
|
<returns>the total margin</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetMaximumBottom(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Double)">
|
|
<summary>
|
|
Gets the maximum bottom of the boxes inside the startBox
|
|
</summary>
|
|
<param name="startBox"></param>
|
|
<param name="currentMaxBottom"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetMinMaxWidth(System.Double@,System.Double@)">
|
|
<summary>
|
|
Get the <paramref name="minWidth"/> and <paramref name="maxWidth"/> width of the box content.<br/>
|
|
</summary>
|
|
<param name="minWidth">The minimum width the content must be so it won't overflow (largest word + padding).</param>
|
|
<param name="maxWidth">The total width the content can take without line wrapping (with padding).</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetMinMaxSumWords(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Double@,System.Double@,System.Double@,System.Double@)">
|
|
<summary>
|
|
Get the <paramref name="min"/> and <paramref name="maxSum"/> of the box words content and <paramref name="paddingSum"/>.<br/>
|
|
</summary>
|
|
<param name="box">the box to calculate for</param>
|
|
<param name="min">the width that allows for each word to fit (width of the longest word)</param>
|
|
<param name="maxSum">the max width a single line of words can take without wrapping</param>
|
|
<param name="paddingSum">the total amount of padding the content has </param>
|
|
<param name="marginSum"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.HasJustInlineSiblings">
|
|
<summary>
|
|
Gets if this box has only inline siblings (including itself)
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.InheritStyle(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Boolean)">
|
|
<summary>
|
|
Gets the rectangles where inline box will be drawn. See Remarks for more info.
|
|
</summary>
|
|
<returns>Rectangles where content should be placed</returns>
|
|
<remarks>
|
|
Inline boxes can be split across different LineBoxes, that's why this method
|
|
Delivers a rectangle for each LineBox related to this box, if inline.
|
|
</remarks>
|
|
<summary>
|
|
Inherits inheritable values from parent.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.MarginTopCollapse(TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties)">
|
|
<summary>
|
|
Gets the result of collapsing the vertical margins of the two boxes
|
|
</summary>
|
|
<param name="prevSibling">the previous box under the same parent</param>
|
|
<returns>Resulting top margin</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.CalculateActualRight">
|
|
<summary>
|
|
Calculate the actual right of the box by the actual right of the child boxes if this box actual right is not set.
|
|
</summary>
|
|
<returns>the calculated actual right value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.MarginBottomCollapse">
|
|
<summary>
|
|
Gets the result of collapsing the vertical margins of the two boxes
|
|
</summary>
|
|
<returns>Resulting bottom margin</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.OffsetTop(System.Double)">
|
|
<summary>
|
|
Deeply offsets the top of the box and its contents
|
|
</summary>
|
|
<param name="amount"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.PaintImp(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Paints the fragment
|
|
</summary>
|
|
<param name="g">the device to draw to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.PaintBackground(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Paints the background of the box
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="rect">the bounding rectangle to draw in</param>
|
|
<param name="isFirst">is it the first rectangle of the element</param>
|
|
<param name="isLast">is it the last rectangle of the element</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.PaintWords(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Paint all the words in the box.
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="offset">the current scroll offset to offset the words</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.PaintDecoration(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Paints the text decoration (underline/strike-through/over-line)
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="rectangle"> </param>
|
|
<param name="isFirst"> </param>
|
|
<param name="isLast"> </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.OffsetRectangle(TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox,System.Double)">
|
|
<summary>
|
|
Offsets the rectangle of the specified linebox by the specified gap,
|
|
and goes deep for rectangles of children in that linebox.
|
|
</summary>
|
|
<param name="lineBox"></param>
|
|
<param name="gap"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.RectanglesReset">
|
|
<summary>
|
|
Resets the <see cref="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.Rectangles"/> array
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.OnImageLoadComplete(TheArtOfDev.HtmlRenderer.Adapters.RImage,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean)">
|
|
<summary>
|
|
On image load process complete with image request refresh for it to be painted.
|
|
</summary>
|
|
<param name="image">the image loaded or null if failed</param>
|
|
<param name="rectangle">the source rectangle to draw in the image (empty - draw everything)</param>
|
|
<param name="async">is the callback was called async to load image call</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetSelectionForeBrush">
|
|
<summary>
|
|
Get brush for the text depending if there is selected text color set.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.GetSelectionBackBrush(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,System.Boolean)">
|
|
<summary>
|
|
Get brush for selection background depending if it has external and if alpha is required for images.
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="forceAlpha">used for images so they will have alpha effect</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBox.ToString">
|
|
<summary>
|
|
ToString override.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame">
|
|
<summary>
|
|
CSS box for iframe element.<br/>
|
|
If the iframe is of embedded YouTube or Vimeo video it will show image with play.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame._imageWord">
|
|
<summary>
|
|
the image word of this image box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame._isVideo">
|
|
<summary>
|
|
is the iframe is of embeded video
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame._videoTitle">
|
|
<summary>
|
|
the title of the video
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame._videoImageUrl">
|
|
<summary>
|
|
the url of the video thumbnail image
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame._videoLinkUrl">
|
|
<summary>
|
|
link to the video on the site
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame._imageLoadHandler">
|
|
<summary>
|
|
handler used for image loading by source
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame._imageLoadingComplete">
|
|
<summary>
|
|
is image load is finished, used to know if no image is found
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="parent">the parent box of this box</param>
|
|
<param name="tag">the html tag data of this box</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.IsClickable">
|
|
<summary>
|
|
Is the css box clickable ("a" element is clickable)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.HrefLink">
|
|
<summary>
|
|
Get the href link of the box (by default get "href" attribute)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.IsVideo">
|
|
<summary>
|
|
is the iframe is of embeded video
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.LoadYoutubeDataAsync(System.Uri)">
|
|
<summary>
|
|
Load YouTube video data (title, image, link) by calling YouTube API.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.OnDownloadYoutubeApiCompleted(System.Object,System.Net.DownloadStringCompletedEventArgs)">
|
|
<summary>
|
|
Parse YouTube API response to get video data (title, image, link).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.LoadVimeoDataAsync(System.Uri)">
|
|
<summary>
|
|
Load Vimeo video data (title, image, link) by calling Vimeo API.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.OnDownloadVimeoApiCompleted(System.Object,System.Net.DownloadStringCompletedEventArgs)">
|
|
<summary>
|
|
Parse Vimeo API response to get video data (title, image, link).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.HandleDataLoadFailure(System.Exception,System.String)">
|
|
<summary>
|
|
Handle error occurred during video data load to handle if the video was not found.
|
|
</summary>
|
|
<param name="ex">the exception that occurred during data load web request</param>
|
|
<param name="source">the name of the video source (YouTube/Vimeo/Etc.)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.HandlePostApiCall(System.Object)">
|
|
<summary>
|
|
Create image handler for downloading video image if found and release the WebClient instance used for API call.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.PaintImp(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Paints the fragment
|
|
</summary>
|
|
<param name="g">the device to draw to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.DrawImage(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draw video image over the iframe if found.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.DrawTitle(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draw video title on top of the iframe if found.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.DrawPlay(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draw play over the iframe if we found link url.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.MeasureWordsSize(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Assigns words its width and height
|
|
</summary>
|
|
<param name="g">the device to use</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.SetErrorBorder">
|
|
<summary>
|
|
Set error image border on the image box.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxFrame.OnLoadImageComplete(TheArtOfDev.HtmlRenderer.Adapters.RImage,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean)">
|
|
<summary>
|
|
On image load process is complete with image or without update the image box.
|
|
</summary>
|
|
<param name="image">the image loaded or null if failed</param>
|
|
<param name="rectangle">the source rectangle to draw in the image (empty - draw everything)</param>
|
|
<param name="async">is the callback was called async to load image call</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxHr">
|
|
<summary>
|
|
CSS box for hr element.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxHr.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="parent">the parent box of this box</param>
|
|
<param name="tag">the html tag data of this box</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxHr.PerformLayoutImp(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Measures the bounds of box and children, recursively.<br/>
|
|
Performs layout of the DOM structure creating lines by set bounds restrictions.
|
|
</summary>
|
|
<param name="g">Device context to use</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxHr.PaintImp(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Paints the fragment
|
|
</summary>
|
|
<param name="g">the device to draw to</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage">
|
|
<summary>
|
|
CSS box for image element.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage._imageWord">
|
|
<summary>
|
|
the image word of this image box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage._imageLoadHandler">
|
|
<summary>
|
|
handler used for image loading by source
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage._imageLoadingComplete">
|
|
<summary>
|
|
is image load is finished, used to know if no image is found
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="parent">the parent box of this box</param>
|
|
<param name="tag">the html tag data of this box</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage.Image">
|
|
<summary>
|
|
Get the image of this image box.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage.PaintImp(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Paints the fragment
|
|
</summary>
|
|
<param name="g">the device to draw to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage.MeasureWordsSize(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Assigns words its width and height
|
|
</summary>
|
|
<param name="g">the device to use</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage.SetErrorBorder">
|
|
<summary>
|
|
Set error image border on the image box.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxImage.OnLoadImageComplete(TheArtOfDev.HtmlRenderer.Adapters.RImage,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean)">
|
|
<summary>
|
|
On image load process is complete with image or without update the image box.
|
|
</summary>
|
|
<param name="image">the image loaded or null if failed</param>
|
|
<param name="rectangle">the source rectangle to draw in the image (empty - draw everything)</param>
|
|
<param name="async">is the callback was called async to load image call</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties">
|
|
<summary>
|
|
Base class for css box to handle the css properties.<br/>
|
|
Has field and property for every css property that can be set, the properties add additional parsing like
|
|
setting the correct border depending what border value was set (single, two , all four).<br/>
|
|
Has additional fields to control the location and size of the box and 'actual' css values for some properties
|
|
that require additional calculations and parsing.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties._location">
|
|
<summary>
|
|
Gets or sets the location of the box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties._size">
|
|
<summary>
|
|
Gets or sets the size of the box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties._actualLineHeight">
|
|
<summary>
|
|
the width of whitespace between words
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.Location">
|
|
<summary>
|
|
Gets or sets the location of the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.Size">
|
|
<summary>
|
|
Gets or sets the size of the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.Bounds">
|
|
<summary>
|
|
Gets the bounds of the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.AvailableWidth">
|
|
<summary>
|
|
Gets the width available on the box, counting padding and margin.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualRight">
|
|
<summary>
|
|
Gets the right of the box. When setting, it will affect only the width of the box.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBottom">
|
|
<summary>
|
|
Gets or sets the bottom of the box.
|
|
(When setting, alters only the Size.Height of the box)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ClientLeft">
|
|
<summary>
|
|
Gets the left of the client rectangle (Where content starts rendering)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ClientTop">
|
|
<summary>
|
|
Gets the top of the client rectangle (Where content starts rendering)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ClientRight">
|
|
<summary>
|
|
Gets the right of the client rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ClientBottom">
|
|
<summary>
|
|
Gets the bottom of the client rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ClientRectangle">
|
|
<summary>
|
|
Gets the client rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualHeight">
|
|
<summary>
|
|
Gets the actual height
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualWidth">
|
|
<summary>
|
|
Gets the actual height
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualPaddingTop">
|
|
<summary>
|
|
Gets the actual top's padding
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualPaddingLeft">
|
|
<summary>
|
|
Gets the actual padding on the left
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualPaddingBottom">
|
|
<summary>
|
|
Gets the actual Padding of the bottom
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualPaddingRight">
|
|
<summary>
|
|
Gets the actual padding on the right
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualMarginTop">
|
|
<summary>
|
|
Gets the actual top's Margin
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.CollapsedMarginTop">
|
|
<summary>
|
|
The margin top value if was effected by margin collapse.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualMarginLeft">
|
|
<summary>
|
|
Gets the actual Margin on the left
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualMarginBottom">
|
|
<summary>
|
|
Gets the actual Margin of the bottom
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualMarginRight">
|
|
<summary>
|
|
Gets the actual Margin on the right
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderTopWidth">
|
|
<summary>
|
|
Gets the actual top border width
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderLeftWidth">
|
|
<summary>
|
|
Gets the actual Left border width
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderBottomWidth">
|
|
<summary>
|
|
Gets the actual Bottom border width
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderRightWidth">
|
|
<summary>
|
|
Gets the actual Right border width
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderTopColor">
|
|
<summary>
|
|
Gets the actual top border Color
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderLeftColor">
|
|
<summary>
|
|
Gets the actual Left border Color
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderBottomColor">
|
|
<summary>
|
|
Gets the actual Bottom border Color
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderRightColor">
|
|
<summary>
|
|
Gets the actual Right border Color
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualCornerNw">
|
|
<summary>
|
|
Gets the actual length of the north west corner
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualCornerNe">
|
|
<summary>
|
|
Gets the actual length of the north east corner
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualCornerSe">
|
|
<summary>
|
|
Gets the actual length of the south east corner
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualCornerSw">
|
|
<summary>
|
|
Gets the actual length of the south west corner
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.IsRounded">
|
|
<summary>
|
|
Gets a value indicating if at least one of the corners of the box is rounded
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualWordSpacing">
|
|
<summary>
|
|
Gets the actual width of whitespace between words.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualColor">
|
|
<summary>
|
|
|
|
Gets the actual color for the text.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBackgroundColor">
|
|
<summary>
|
|
Gets the actual background color of the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBackgroundGradient">
|
|
<summary>
|
|
Gets the second color that creates a gradient for the background
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBackgroundGradientAngle">
|
|
<summary>
|
|
Gets the actual angle specified for the background gradient
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualParentFont">
|
|
<summary>
|
|
Gets the actual font of the parent
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualFont">
|
|
<summary>
|
|
Gets the font that should be actually used to paint the text of the box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualLineHeight">
|
|
<summary>
|
|
Gets the line height
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualTextIndent">
|
|
<summary>
|
|
Gets the text indentation (on first line only)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderSpacingHorizontal">
|
|
<summary>
|
|
Gets the actual horizontal border spacing for tables
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualBorderSpacingVertical">
|
|
<summary>
|
|
Gets the actual vertical border spacing for tables
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.GetParent">
|
|
<summary>
|
|
Get the parent of this css properties instance.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.GetEmHeight">
|
|
<summary>
|
|
Gets the height of the font in the specified units
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.NoEms(System.String)">
|
|
<summary>
|
|
Ensures that the specified length is converted to pixels if necessary
|
|
</summary>
|
|
<param name="length"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.SetAllBorders(System.String,System.String,System.String)">
|
|
<summary>
|
|
Set the style/width/color for all 4 borders on the box.<br/>
|
|
if null is given for a value it will not be set.
|
|
</summary>
|
|
<param name="style">optional: the style to set</param>
|
|
<param name="width">optional: the width to set</param>
|
|
<param name="color">optional: the color to set</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.MeasureWordSpacing(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Measures the width of whitespace between words (set <see cref="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.ActualWordSpacing"/>).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties.InheritStyle(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Boolean)">
|
|
<summary>
|
|
Inherits inheritable values from specified box.
|
|
</summary>
|
|
<param name="everything">Set to true to inherit all CSS properties instead of only the ineritables</param>
|
|
<param name="p">Box to inherit the properties</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine">
|
|
<summary>
|
|
Helps on CSS Layout.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.MeasureImageSize(TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage)">
|
|
<summary>
|
|
Measure image box size by the width\height set on the box and the actual rendered image size.<br/>
|
|
If no image exists for the box error icon will be set.
|
|
</summary>
|
|
<param name="imageWord">the image word to measure</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.CreateLineBoxes(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Creates line boxes for the specified blockbox
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="blockBox"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyCellVerticalAlignment(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Applies special vertical alignment for table-cells
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="cell"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.FlowBox(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Double,System.Double,System.Double,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox@,System.Double@,System.Double@,System.Double@,System.Double@)">
|
|
<summary>
|
|
Recursively flows the content of the box using the inline model
|
|
</summary>
|
|
<param name="g">Device Info</param>
|
|
<param name="blockbox">Blockbox that contains the text flow</param>
|
|
<param name="box">Current box to flow its content</param>
|
|
<param name="limitRight">Maximum reached right</param>
|
|
<param name="linespacing">Space to use between rows of text</param>
|
|
<param name="startx">x starting coordinate for when breaking lines of text</param>
|
|
<param name="line">Current linebox being used</param>
|
|
<param name="curx">Current x coordinate that will be the left of the next word</param>
|
|
<param name="cury">Current y coordinate that will be the top of the next word</param>
|
|
<param name="maxRight">Maximum right reached so far</param>
|
|
<param name="maxbottom">Maximum bottom reached so far</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.AdjustAbsolutePosition(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Double,System.Double)">
|
|
<summary>
|
|
Adjust the position of absolute elements by letf and top margins.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.BubbleRectangles(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Recursively creates the rectangles of the blockBox, by bubbling from deep to outside of the boxes
|
|
in the rectangle structure
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyHorizontalAlignment(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Applies vertical and horizontal alignment to words in lineboxes
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="lineBox"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyRightToLeft(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Applies right to left direction to words
|
|
</summary>
|
|
<param name="blockBox"></param>
|
|
<param name="lineBox"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyRightToLeftOnLine(TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Applies RTL direction to all the words on the line.
|
|
</summary>
|
|
<param name="line">the line to apply RTL to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyRightToLeftOnSingleBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Applies RTL direction to specific box words on the line.
|
|
</summary>
|
|
<param name="lineBox"></param>
|
|
<param name="box"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyVerticalAlignment(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Applies vertical alignment to the linebox
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="lineBox"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyJustifyAlignment(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Applies centered alignment to the text on the linebox
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="lineBox"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyCenterAlignment(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Applies centered alignment to the text on the linebox
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="line"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyRightAlignment(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Applies right alignment to the text on the linebox
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="line"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ApplyLeftAlignment(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox)">
|
|
<summary>
|
|
Simplest alignment, just arrange words.
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="line"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngine.ToList``1(System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
todo: optimizate, not creating a list each time
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable">
|
|
<summary>
|
|
Layout engine for tables executing the complex layout of tables with rows/columns/headers/etc.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable._tableBox">
|
|
<summary>
|
|
the main box of the table
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable._caption">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable._bodyrows">
|
|
<summary>
|
|
collection of all rows boxes
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable._columns">
|
|
<summary>
|
|
collection of all columns boxes
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable._allRows">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="tableBox"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetTableSpacing(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Get the table cells spacing for all the cells in the table.<br/>
|
|
Used to calculate the spacing the table has in addition to regular padding and borders.
|
|
</summary>
|
|
<param name="tableBox">the table box to calculate the spacing for</param>
|
|
<returns>the calculated spacing</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.PerformLayout(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="tableBox"> </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.Layout(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Analyzes the Table and assigns values to this CssTable object.
|
|
To be called from the constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.AssignBoxKinds">
|
|
<summary>
|
|
Get the table boxes into the proper fields.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.InsertEmptyBoxes">
|
|
<summary>
|
|
Insert EmptyBoxes for vertical cell spanning.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.CalculateCountAndWidth">
|
|
<summary>
|
|
Determine Row and Column Count, and ColumnWidths
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.DetermineMissingColumnWidths(System.Double)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="availCellSpace"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.EnforceMaximumSize">
|
|
<summary>
|
|
While table width is larger than it should, and width is reductable.<br/>
|
|
If table max width is limited by we need to lower the columns width even if it will result in clipping<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.EnforceMinimumSize">
|
|
<summary>
|
|
Check for minimum sizes (increment widths if necessary)
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.LayoutCells(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Layout the cells by the calculated table layout
|
|
</summary>
|
|
<param name="g"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetSpannedMinWidth(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Int32,System.Int32)">
|
|
<summary>
|
|
Gets the spanned width of a cell (With of all columns it spans minus one).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetCellRealColumnIndex(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the cell column index checking its position and other cells colspans
|
|
</summary>
|
|
<param name="row"></param>
|
|
<param name="cell"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetCellWidth(System.Int32,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the cells width, taking colspan and being in the specified column
|
|
</summary>
|
|
<param name="column"></param>
|
|
<param name="b"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetColSpan(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the colspan of the specified box
|
|
</summary>
|
|
<param name="b"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetRowSpan(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the rowspan of the specified box
|
|
</summary>
|
|
<param name="b"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.MeasureWords(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Recursively measures words inside the box
|
|
</summary>
|
|
<param name="box">the box to measure</param>
|
|
<param name="g">Device to use</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.CanReduceWidth">
|
|
<summary>
|
|
Tells if the columns widths can be reduced,
|
|
by checking the minimum widths of all cells
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.CanReduceWidth(System.Int32)">
|
|
<summary>
|
|
Tells if the specified column can be reduced,
|
|
by checking its minimum width
|
|
</summary>
|
|
<param name="columnIndex"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetAvailableTableWidth">
|
|
<summary>
|
|
Gets the available width for the whole table.
|
|
It also sets the value of WidthSpecified
|
|
</summary>
|
|
<returns></returns>
|
|
<remarks>
|
|
The table's width can be larger than the result of this method, because of the minimum
|
|
size that individual boxes.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetMaxTableWidth">
|
|
<summary>
|
|
Gets the available width for the whole table.
|
|
It also sets the value of WidthSpecified
|
|
</summary>
|
|
<returns></returns>
|
|
<remarks>
|
|
The table's width can be larger than the result of this method, because of the minimum
|
|
size that individual boxes.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetColumnsMinMaxWidthByContent(System.Boolean,System.Double[]@,System.Double[]@)">
|
|
<summary>
|
|
Calculate the min and max width for each column of the table by the content in all rows.<br/>
|
|
the min width possible without clipping content<br/>
|
|
the max width the cell content can take without wrapping<br/>
|
|
</summary>
|
|
<param name="onlyNans">if to measure only columns that have no calculated width</param>
|
|
<param name="minFullWidths">return the min width for each column - the min width possible without clipping content</param>
|
|
<param name="maxFullWidths">return the max width for each column - the max width the cell content can take without wrapping</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetAvailableCellWidth">
|
|
<summary>
|
|
Gets the width available for cells
|
|
</summary>
|
|
<returns></returns>
|
|
<remarks>
|
|
It takes away the cell-spacing from <see cref="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetAvailableTableWidth"/>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetWidthSum">
|
|
<summary>
|
|
Gets the current sum of column widths
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetSpan(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the span attribute of the tag of the specified box
|
|
</summary>
|
|
<param name="b"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetColumnMinWidths">
|
|
<summary>
|
|
Gets the minimum width of each column
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetHorizontalSpacing">
|
|
<summary>
|
|
Gets the actual horizontal spacing of the table
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetHorizontalSpacing(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the actual horizontal spacing of the table
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLayoutEngineTable.GetVerticalSpacing">
|
|
<summary>
|
|
Gets the actual vertical spacing of the table
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength">
|
|
<summary>
|
|
Represents and gets info about a CSS Length
|
|
</summary>
|
|
<remarks>
|
|
http://www.w3.org/TR/CSS21/syndata.html#length-units
|
|
</remarks>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new CssLength from a length specified on a CSS style sheet or fragment
|
|
</summary>
|
|
<param name="length">Length as specified in the Style Sheet or style fragment</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.Number">
|
|
<summary>
|
|
Gets the number in the length
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.HasError">
|
|
<summary>
|
|
Gets if the length has some parsing error
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.IsPercentage">
|
|
<summary>
|
|
Gets if the length represents a precentage (not actually a length)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.IsRelative">
|
|
<summary>
|
|
Gets if the length is specified in relative units
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.Unit">
|
|
<summary>
|
|
Gets the unit of the length
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.Length">
|
|
<summary>
|
|
Gets the length as specified in the string
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.ConvertEmToPoints(System.Double)">
|
|
<summary>
|
|
If length is in Ems, returns its value in points
|
|
</summary>
|
|
<param name="emSize">Em size factor to multiply</param>
|
|
<returns>Points size of this em</returns>
|
|
<exception cref="T:System.InvalidOperationException">If length has an error or isn't in ems</exception>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.ConvertEmToPixels(System.Double)">
|
|
<summary>
|
|
If length is in Ems, returns its value in pixels
|
|
</summary>
|
|
<param name="pixelFactor">Pixel size factor to multiply</param>
|
|
<returns>Pixels size of this em</returns>
|
|
<exception cref="T:System.InvalidOperationException">If length has an error or isn't in ems</exception>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLength.ToString">
|
|
<summary>
|
|
Returns the length formatted ready for CSS interpreting.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox">
|
|
<summary>
|
|
Represents a line of text.
|
|
</summary>
|
|
<remarks>
|
|
To learn more about line-boxes see CSS spec:
|
|
http://www.w3.org/TR/CSS21/visuren.html
|
|
</remarks>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Creates a new LineBox
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.RelatedBoxes">
|
|
<summary>
|
|
Gets a list of boxes related with the linebox.
|
|
To know the words of the box inside this linebox, use the <see cref="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.WordsOf(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)"/> method.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.Words">
|
|
<summary>
|
|
Gets the words inside the linebox
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.OwnerBox">
|
|
<summary>
|
|
Gets the owner box
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.Rectangles">
|
|
<summary>
|
|
Gets a List of rectangles that are to be painted on this linebox
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.LineHeight">
|
|
<summary>
|
|
Get the height of this box line (the max height of all the words)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.LineBottom">
|
|
<summary>
|
|
Get the bottom of this box line (the max bottom of all the words)
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.ReportExistanceOf(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
Lets the linebox add the word an its box to their lists if necessary.
|
|
</summary>
|
|
<param name="word"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.WordsOf(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Return the words of the specified box that live in this linebox
|
|
</summary>
|
|
<param name="box"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.UpdateRectangle(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Updates the specified rectangle of the specified box.
|
|
</summary>
|
|
<param name="box"></param>
|
|
<param name="x"></param>
|
|
<param name="y"></param>
|
|
<param name="r"></param>
|
|
<param name="b"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.AssignRectanglesToBoxes">
|
|
<summary>
|
|
Copies the rectangles to their specified box
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.SetBaseLine(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Double)">
|
|
<summary>
|
|
Sets the baseline of the words of the specified box to certain height
|
|
</summary>
|
|
<param name="g">Device info</param>
|
|
<param name="b">box to check words</param>
|
|
<param name="baseline">baseline</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.IsLastSelectedWord(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
Check if the given word is the last selected word in the line.<br/>
|
|
It can either be the last word in the line or the next word has no selection.
|
|
</summary>
|
|
<param name="word">the word to check</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox.ToString">
|
|
<summary>
|
|
Returns the words of the linebox
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect">
|
|
<summary>
|
|
Represents a word inside an inline box
|
|
</summary>
|
|
<remarks>
|
|
Because of performance, words of text are the most atomic
|
|
element in the project. It should be characters, but come on,
|
|
imagine the performance when drawing char by char on the device.<br/>
|
|
It may change for future versions of the library.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect._ownerBox">
|
|
<summary>
|
|
the CSS box owner of the word
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect._rect">
|
|
<summary>
|
|
Rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect._selection">
|
|
<summary>
|
|
If the word is selected this points to the selection handler for more data
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="owner">the CSS box owner of the word</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.OwnerBox">
|
|
<summary>
|
|
Gets the Box where this word belongs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Rectangle">
|
|
<summary>
|
|
Gets or sets the bounds of the rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Left">
|
|
<summary>
|
|
Left of the rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Top">
|
|
<summary>
|
|
Top of the rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Width">
|
|
<summary>
|
|
Width of the rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.FullWidth">
|
|
<summary>
|
|
Get the full width of the word including the spacing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.ActualWordSpacing">
|
|
<summary>
|
|
Gets the actual width of whitespace between words.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Height">
|
|
<summary>
|
|
Height of the rectangle
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Right">
|
|
<summary>
|
|
Gets or sets the right of the rectangle. When setting, it only affects the Width of the rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Bottom">
|
|
<summary>
|
|
Gets or sets the bottom of the rectangle. When setting, it only affects the Height of the rectangle.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Selection">
|
|
<summary>
|
|
If the word is selected this points to the selection handler for more data
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.HasSpaceBefore">
|
|
<summary>
|
|
was there a whitespace before the word chars (before trim)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.HasSpaceAfter">
|
|
<summary>
|
|
was there a whitespace after the word chars (before trim)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Image">
|
|
<summary>
|
|
Gets the image this words represents (if one exists)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.IsImage">
|
|
<summary>
|
|
Gets if the word represents an image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.IsSpaces">
|
|
<summary>
|
|
Gets a bool indicating if this word is composed only by spaces.
|
|
Spaces include tabs and line breaks
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.IsLineBreak">
|
|
<summary>
|
|
Gets if the word is composed by only a line break
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Text">
|
|
<summary>
|
|
Gets the text of the word
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.Selected">
|
|
<summary>
|
|
is the word is currently selected
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.SelectedStartIndex">
|
|
<summary>
|
|
the selection start index if the word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.SelectedEndIndexOffset">
|
|
<summary>
|
|
the selection end index if the word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.SelectedStartOffset">
|
|
<summary>
|
|
the selection start offset if the word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.SelectedEndOffset">
|
|
<summary>
|
|
the selection end offset if the word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.LeftGlyphPadding">
|
|
<summary>
|
|
Gets or sets an offset to be considered in measurements
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssRect.ToString">
|
|
<summary>
|
|
Represents this word for debugging purposes
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage">
|
|
<summary>
|
|
Represents a word inside an inline box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage._image">
|
|
<summary>
|
|
the image object if it is image word (can be null if not loaded)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage._imageRectangle">
|
|
<summary>
|
|
the image rectangle restriction as returned from image load event
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Creates a new BoxWord which represents an image
|
|
</summary>
|
|
<param name="owner">the CSS box owner of the word</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage.Image">
|
|
<summary>
|
|
Gets the image this words represents (if one exists)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage.IsImage">
|
|
<summary>
|
|
Gets if the word represents an image.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage.ImageRectangle">
|
|
<summary>
|
|
the image rectange restriction as returned from image load event
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectImage.ToString">
|
|
<summary>
|
|
Represents this word for debugging purposes
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord">
|
|
<summary>
|
|
Represents a word inside an inline box
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord._text">
|
|
<summary>
|
|
The word text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord._hasSpaceBefore">
|
|
<summary>
|
|
was there a whitespace before the word chars (before trim)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord._hasSpaceAfter">
|
|
<summary>
|
|
was there a whitespace after the word chars (before trim)
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="owner">the CSS box owner of the word</param>
|
|
<param name="text">the word chars </param>
|
|
<param name="hasSpaceBefore">was there a whitespace before the word chars (before trim)</param>
|
|
<param name="hasSpaceAfter">was there a whitespace after the word chars (before trim)</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord.HasSpaceBefore">
|
|
<summary>
|
|
was there a whitespace before the word chars (before trim)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord.HasSpaceAfter">
|
|
<summary>
|
|
was there a whitespace after the word chars (before trim)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord.IsSpaces">
|
|
<summary>
|
|
Gets a bool indicating if this word is composed only by spaces.
|
|
Spaces include tabs and line breaks
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord.IsLineBreak">
|
|
<summary>
|
|
Gets if the word is composed by only a line break
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord.Text">
|
|
<summary>
|
|
Gets the text of the word
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.CssRectWord.ToString">
|
|
<summary>
|
|
Represents this word for debugging purposes
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssSpacingBox">
|
|
<summary>
|
|
Used to make space on vertical cell combination
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssSpacingBox._startRow">
|
|
<summary>
|
|
the index of the row where box starts
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.CssSpacingBox._endRow">
|
|
<summary>
|
|
the index of the row where box ends
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssSpacingBox.StartRow">
|
|
<summary>
|
|
Gets the index of the row where box starts
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.CssSpacingBox.EndRow">
|
|
<summary>
|
|
Gets the index of the row where box ends
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.CssUnit">
|
|
<summary>
|
|
Represents the possible units of the CSS lengths
|
|
</summary>
|
|
<remarks>
|
|
http://www.w3.org/TR/CSS21/syndata.html#length-units
|
|
</remarks>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Dom.HoverBoxBlock">
|
|
<summary>
|
|
CSS boxes that have ":hover" selector on them.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.HoverBoxBlock._cssBox">
|
|
<summary>
|
|
the box that has :hover css on
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.HoverBoxBlock._cssBlock">
|
|
<summary>
|
|
the :hover style block data
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.HoverBoxBlock.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.HoverBoxBlock.CssBox">
|
|
<summary>
|
|
the box that has :hover css on
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.HoverBoxBlock.CssBlock">
|
|
<summary>
|
|
the :hover style block data
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag._name">
|
|
<summary>
|
|
the name of the html tag
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag._isSingle">
|
|
<summary>
|
|
if the tag is single placed; in other words it doesn't have a separate closing tag;
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag._attributes">
|
|
<summary>
|
|
collection of attributes and their value the html tag has
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag.#ctor(System.String,System.Boolean,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="name">the name of the html tag</param>
|
|
<param name="isSingle">if the tag is single placed; in other words it doesn't have a separate closing tag;</param>
|
|
<param name="attributes">collection of attributes and their value the html tag has</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag.Name">
|
|
<summary>
|
|
Gets the name of this tag
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag.Attributes">
|
|
<summary>
|
|
Gets collection of attributes and their value the html tag has
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag.IsSingle">
|
|
<summary>
|
|
Gets if the tag is single placed; in other words it doesn't have a separate closing tag; <br/>
|
|
e.g. <br>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag.HasAttributes">
|
|
<summary>
|
|
is the html tag has attributes.
|
|
</summary>
|
|
<returns>true - has attributes, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag.HasAttribute(System.String)">
|
|
<summary>
|
|
Gets a boolean indicating if the attribute list has the specified attribute
|
|
</summary>
|
|
<param name="attribute">attribute name to check if exists</param>
|
|
<returns>true - attribute exists, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag.TryGetAttribute(System.String,System.String)">
|
|
<summary>
|
|
Get attribute value for given attribute name or null if not exists.
|
|
</summary>
|
|
<param name="attribute">attribute name to get by</param>
|
|
<param name="defaultValue">optional: value to return if attribute is not specified</param>
|
|
<returns>attribute value or null if not found</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock">
|
|
<summary>
|
|
Represents a block of CSS property values.<br/>
|
|
Contains collection of key-value pairs that are CSS properties for specific css class.<br/>
|
|
Css class can be either custom or html tag name.
|
|
</summary>
|
|
<remarks>
|
|
To learn more about CSS blocks visit CSS spec: http://www.w3.org/TR/CSS21/syndata.html#block
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock._class">
|
|
<summary>
|
|
the name of the css class of the block
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock._properties">
|
|
<summary>
|
|
the CSS block properties and values
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock._selectors">
|
|
<summary>
|
|
additional selectors to used in hierarchy (p className1 > className2)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock._hover">
|
|
<summary>
|
|
is the css block has :hover pseudo-class
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.Collections.Generic.List{TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem},System.Boolean)">
|
|
<summary>
|
|
Creates a new block from the block's source
|
|
</summary>
|
|
<param name="class">the name of the css class of the block</param>
|
|
<param name="properties">the CSS block properties and values</param>
|
|
<param name="selectors">optional: additional selectors to used in hierarchy</param>
|
|
<param name="hover">optional: is the css block has :hover pseudo-class</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Class">
|
|
<summary>
|
|
the name of the css class of the block
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Selectors">
|
|
<summary>
|
|
additional selectors to used in hierarchy (p className1 > className2)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Properties">
|
|
<summary>
|
|
Gets the CSS block properties and its values
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Hover">
|
|
<summary>
|
|
is the css block has :hover pseudo-class
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Merge(TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Merge the other block properties into this css block.<br/>
|
|
Other block properties can overwrite this block properties.
|
|
</summary>
|
|
<param name="other">the css block to merge with</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Clone">
|
|
<summary>
|
|
Create deep copy of the CssBlock.
|
|
</summary>
|
|
<returns>new CssBlock with same data</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Equals(TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Check if the two css blocks are the same (same class, selectors and properties).
|
|
</summary>
|
|
<param name="other">the other block to compare to</param>
|
|
<returns>true - the two blocks are the same, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.EqualsSelector(TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Check if the selectors of the css blocks is the same.
|
|
</summary>
|
|
<param name="other">the other block to compare to</param>
|
|
<returns>true - the selectors on blocks are the same, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.Equals(System.Object)">
|
|
<summary>
|
|
Check if the two css blocks are the same (same class, selectors and properties).
|
|
</summary>
|
|
<param name="obj">the other block to compare to</param>
|
|
<returns>true - the two blocks are the same, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.GetHashCode">
|
|
<summary>
|
|
Serves as a hash function for a particular type.
|
|
</summary>
|
|
<returns>A hash code for the current <see cref="T:System.Object"/>.</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem">
|
|
<summary>
|
|
Holds single class selector in css block hierarchical selection (p class1 > div.class2)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem._class">
|
|
<summary>
|
|
the name of the css class of the block
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem._directParent">
|
|
<summary>
|
|
is the selector item has to be direct parent
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem.#ctor(System.String,System.Boolean)">
|
|
<summary>
|
|
Creates a new block from the block's source
|
|
</summary>
|
|
<param name="class">the name of the css class of the block</param>
|
|
<param name="directParent"> </param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem.Class">
|
|
<summary>
|
|
the name of the css class of the block
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem.DirectParent">
|
|
<summary>
|
|
is the selector item has to be direct parent
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.CssBlockSelectorItem.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle">
|
|
<summary>
|
|
Controls the way styles are generated when html is generated.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle.None">
|
|
<summary>
|
|
styles are not generated at all
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle.Inline">
|
|
<summary>
|
|
style are inserted in style attribute for each html tag
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle.InHeader">
|
|
<summary>
|
|
style section is generated in the head of the html
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadCallback">
|
|
<summary>
|
|
Callback used in <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs"/> to allow setting image externally and async.<br/>
|
|
The callback can provide path to image file path, URL or the actual image to use.<br/>
|
|
If <paramref name="imageRectangle"/> is given (not <see cref="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Empty"/>) then only the specified rectangle will
|
|
be used from the loaded image and not all of it, also the rectangle will be used for size and not the actual image size.<br/>
|
|
</summary>
|
|
<param name="path">the path to the image to load (file path or URL)</param>
|
|
<param name="image">the image to use</param>
|
|
<param name="imageRectangle">optional: limit to specific rectangle in the loaded image</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs">
|
|
<summary>
|
|
Invoked when an image is about to be loaded by file path, URL or inline data in 'img' element or background-image CSS style.<br/>
|
|
Allows to overwrite the loaded image by providing the image object manually, or different source (file or URL) to load from.<br/>
|
|
Example: image 'src' can be non-valid string that is interpreted in the overwrite delegate by custom logic to resource image object<br/>
|
|
Example: image 'src' in the html is relative - the overwrite intercepts the load and provide full source URL to load the image from<br/>
|
|
Example: image download requires authentication - the overwrite intercepts the load, downloads the image to disk using custom code and
|
|
provide file path to load the image from. Can also use the asynchronous image overwrite not to block HTML rendering is applicable.<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs._handled">
|
|
<summary>
|
|
use to cancel the image loading by html renderer, the provided image will be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs._src">
|
|
<summary>
|
|
the source of the image (file path or uri)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs._attributes">
|
|
<summary>
|
|
collection of all the attributes that are defined on the image element
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs._callback">
|
|
<summary>
|
|
Callback used to allow setting image externally and async.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,System.String},TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadCallback)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="src">the source of the image (file path or Uri)</param>
|
|
<param name="attributes">collection of all the attributes that are defined on the image element</param>
|
|
<param name="callback">Callback used to allow setting image externally and async.</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Src">
|
|
<summary>
|
|
the source of the image (file path, URL or inline data)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Attributes">
|
|
<summary>
|
|
collection of all the attributes that are defined on the image element or CSS style
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Handled">
|
|
<summary>
|
|
Indicate the image load is handled asynchronously.
|
|
Cancel this image loading and overwrite the image asynchronously using callback method.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Callback">
|
|
<summary>
|
|
Callback to overwrite the loaded image with error image.<br/>
|
|
Can be called directly from delegate handler or asynchronously after setting <see cref="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Handled"/> to True.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Callback(System.String)">
|
|
<summary>
|
|
Callback to overwrite the loaded image with image to load from given URI.<br/>
|
|
Can be called directly from delegate handler or asynchronously after setting <see cref="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Handled"/> to True.<br/>
|
|
</summary>
|
|
<param name="path">the path to the image to load (file path or URL)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Callback(System.String,System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Callback to overwrite the loaded image with image to load from given URI.<br/>
|
|
Can be called directly from delegate handler or asynchronously after setting <see cref="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Handled"/> to True.<br/>
|
|
Only the specified rectangle (x,y,width,height) will be used from the loaded image and not all of it, also
|
|
the rectangle will be used for size and not the actual image size.<br/>
|
|
</summary>
|
|
<param name="path">the path to the image to load (file path or URL)</param>
|
|
<param name="imageRectangle">optional: limit to specific rectangle of the image and not all of it</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Callback(System.Object)">
|
|
<summary>
|
|
Callback to overwrite the loaded image with given image object.<br/>
|
|
Can be called directly from delegate handler or asynchronously after setting <see cref="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Handled"/> to True.<br/>
|
|
If <paramref name="imageRectangle"/> is given (not <see cref="F:TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect.Empty"/>) then only the specified rectangle will
|
|
be used from the loaded image and not all of it, also the rectangle will be used for size and not the actual image size.<br/>
|
|
</summary>
|
|
<param name="image">the image to load</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Callback(System.Object,System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Callback to overwrite the loaded image with given image object.<br/>
|
|
Can be called directly from delegate handler or asynchronously after setting <see cref="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs.Handled"/> to True.<br/>
|
|
Only the specified rectangle (x,y,width,height) will be used from the loaded image and not all of it, also
|
|
the rectangle will be used for size and not the actual image size.<br/>
|
|
</summary>
|
|
<param name="image">the image to load</param>
|
|
<param name="imageRectangle">optional: limit to specific rectangle of the image and not all of it</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs">
|
|
<summary>
|
|
Raised when the user clicks on a link in the html.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs._link">
|
|
<summary>
|
|
the link href that was clicked
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs._attributes">
|
|
<summary>
|
|
collection of all the attributes that are defined on the link element
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs._handled">
|
|
<summary>
|
|
use to cancel the execution of the link
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="link">the link href that was clicked</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs.Link">
|
|
<summary>
|
|
the link href that was clicked
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs.Attributes">
|
|
<summary>
|
|
collection of all the attributes that are defined on the link element
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedEventArgs.Handled">
|
|
<summary>
|
|
use to cancel the execution of the link
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedException">
|
|
<summary>
|
|
Exception thrown when client code subscribed to LinkClicked event thrown exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Exception"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Exception"/> class with a specified error message.
|
|
</summary>
|
|
<param name="message">The message that describes the error. </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlLinkClickedException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Exception"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception. </param><param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. </param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs">
|
|
<summary>
|
|
Raised when html renderer requires refresh of the control hosting (invalidation and re-layout).<br/>
|
|
It can happen if some async event has occurred that requires re-paint and re-layout of the html.<br/>
|
|
Example: async download of image is complete.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs._layout">
|
|
<summary>
|
|
is re-layout is required for the refresh
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs.#ctor(System.Boolean)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="layout">is re-layout is required for the refresh</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRefreshEventArgs.Layout">
|
|
<summary>
|
|
is re-layout is required for the refresh
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs">
|
|
<summary>
|
|
Raised when an error occurred during html rendering.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs._type">
|
|
<summary>
|
|
error type that is reported
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs._message">
|
|
<summary>
|
|
the error message
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs._exception">
|
|
<summary>
|
|
the exception that occurred (can be null)
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs.#ctor(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorType,System.String,System.Exception)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="type">the type of error to report</param>
|
|
<param name="message">the error message</param>
|
|
<param name="exception">optional: the exception that occurred</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs.Type">
|
|
<summary>
|
|
error type that is reported
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs.Message">
|
|
<summary>
|
|
the error message
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorEventArgs.Exception">
|
|
<summary>
|
|
the exception that occurred (can be null)
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorType">
|
|
<summary>
|
|
Enum of possible error types that can be reported.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlScrollEventArgs">
|
|
<summary>
|
|
Raised when Html Renderer request scroll to specific location.<br/>
|
|
This can occur on document anchor click.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlScrollEventArgs._location">
|
|
<summary>
|
|
the location to scroll to
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlScrollEventArgs.#ctor(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="location">the location to scroll to</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlScrollEventArgs.X">
|
|
<summary>
|
|
the x location to scroll to
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlScrollEventArgs.Y">
|
|
<summary>
|
|
the x location to scroll to
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs">
|
|
<summary>
|
|
Invoked when a stylesheet is about to be loaded by file path or URL in 'link' element.<br/>
|
|
Allows to overwrite the loaded stylesheet by providing the stylesheet data manually, or different source (file or URL) to load from.<br/>
|
|
Example: The stylesheet 'href' can be non-valid URI string that is interpreted in the overwrite delegate by custom logic to pre-loaded stylesheet object<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs._src">
|
|
<summary>
|
|
the source of the stylesheet as found in the HTML (file path or URL)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs._attributes">
|
|
<summary>
|
|
collection of all the attributes that are defined on the link element
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs._setSrc">
|
|
<summary>
|
|
provide the new source (file path or URL) to load stylesheet from
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs._setStyleSheet">
|
|
<summary>
|
|
provide the stylesheet to load
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs._setStyleSheetData">
|
|
<summary>
|
|
provide the stylesheet data to load
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="src">the source of the image (file path or URL)</param>
|
|
<param name="attributes">collection of all the attributes that are defined on the image element</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs.Src">
|
|
<summary>
|
|
the source of the stylesheet as found in the HTML (file path or URL)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs.Attributes">
|
|
<summary>
|
|
collection of all the attributes that are defined on the link element
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs.SetSrc">
|
|
<summary>
|
|
provide the new source (file path or URL) to load stylesheet from
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs.SetStyleSheet">
|
|
<summary>
|
|
provide the stylesheet to load
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs.SetStyleSheetData">
|
|
<summary>
|
|
provide the stylesheet data to load
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1">
|
|
<summary>
|
|
Holds data on link element in HTML.<br/>
|
|
Used to expose data outside of HTML Renderer internal structure.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1._id">
|
|
<summary>
|
|
the id of the link element if present
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1._href">
|
|
<summary>
|
|
the href data of the link
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1._rectangle">
|
|
<summary>
|
|
the rectangle of element as calculated by html layout
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1.#ctor(System.String,System.String,`0)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1.Id">
|
|
<summary>
|
|
the id of the link element if present
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1.Href">
|
|
<summary>
|
|
the href data of the link
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1.Rectangle">
|
|
<summary>
|
|
the rectangle of element as calculated by html layout
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1.IsAnchor">
|
|
<summary>
|
|
Is the link is directed to another element in the html
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Entities.LinkElementData`1.AnchorId">
|
|
<summary>
|
|
Return the id of the element this anchor link is referencing.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.BackgroundImageDrawHandler">
|
|
<summary>
|
|
Contains all the paint code to paint different background images.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BackgroundImageDrawHandler.DrawBackgroundImage(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draw the background image of the given box in the given rectangle.<br/>
|
|
Handle background-repeat and background-position values.
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="box">the box to draw its background image</param>
|
|
<param name="imageLoadHandler">the handler that loads image to draw</param>
|
|
<param name="rectangle">the rectangle to draw image in</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BackgroundImageDrawHandler.GetLocation(System.String,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Get top-left location to start drawing the image at depending on background-position value.
|
|
</summary>
|
|
<param name="backgroundPosition">the background-position value</param>
|
|
<param name="rectangle">the rectangle to position image in</param>
|
|
<param name="imgSize">the size of the image</param>
|
|
<returns>the top-left location</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BackgroundImageDrawHandler.DrawRepeatX(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Draw the background image at the required location repeating it over the X axis.<br/>
|
|
Adjust location to left if starting location doesn't include all the range (adjusted to center or right).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BackgroundImageDrawHandler.DrawRepeatY(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Draw the background image at the required location repeating it over the Y axis.<br/>
|
|
Adjust location to top if starting location doesn't include all the range (adjusted to center or bottom).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BackgroundImageDrawHandler.DrawRepeat(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Draw the background image at the required location repeating it over the X and Y axis.<br/>
|
|
Adjust location to left-top if starting location doesn't include all the range (adjusted to center or bottom/right).
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler">
|
|
<summary>
|
|
Contains all the complex paint code to paint different style borders.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler._borderPts">
|
|
<summary>
|
|
used for all border paint to use the same points and not create new array each time.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.DrawBoxBorders(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Draws all the border of the box with respect to style, width, etc.
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="box">the box to draw borders for</param>
|
|
<param name="rect">the bounding rectangle to draw in</param>
|
|
<param name="isFirst">is it the first rectangle of the element</param>
|
|
<param name="isLast">is it the last rectangle of the element</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.DrawBorder(TheArtOfDev.HtmlRenderer.Core.Dom.Border,TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.RBrush,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draw simple border.
|
|
</summary>
|
|
<param name="border">Desired border</param>
|
|
<param name="g">the device to draw to</param>
|
|
<param name="box">Box which the border corresponds</param>
|
|
<param name="brush">the brush to use</param>
|
|
<param name="rectangle">the bounding rectangle to draw in</param>
|
|
<returns>Beveled border path, null if there is no rounded corners</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.DrawBorder(TheArtOfDev.HtmlRenderer.Core.Dom.Border,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Draw specific border (top/bottom/left/right) with the box data (style/width/rounded).<br/>
|
|
</summary>
|
|
<param name="border">desired border to draw</param>
|
|
<param name="box">the box to draw its borders, contain the borders data</param>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="rect">the rectangle the border is enclosing</param>
|
|
<param name="isLineStart">Specifies if the border is for a starting line (no bevel on left)</param>
|
|
<param name="isLineEnd">Specifies if the border is for an ending line (no bevel on right)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.SetInOutsetRectanglePoints(TheArtOfDev.HtmlRenderer.Core.Dom.Border,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Set rectangle for inset/outset border as it need diagonal connection to other borders.
|
|
</summary>
|
|
<param name="border">Desired border</param>
|
|
<param name="b">Box which the border corresponds</param>
|
|
<param name="r">the rectangle the border is enclosing</param>
|
|
<param name="isLineStart">Specifies if the border is for a starting line (no bevel on left)</param>
|
|
<param name="isLineEnd">Specifies if the border is for an ending line (no bevel on right)</param>
|
|
<returns>Beveled border path, null if there is no rounded corners</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.GetRoundedBorderPath(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.Border,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Makes a border path for rounded borders.<br/>
|
|
To support rounded dotted/dashed borders we need to use arc in the border path.<br/>
|
|
Return null if the border is not rounded.<br/>
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="border">Desired border</param>
|
|
<param name="b">Box which the border corresponds</param>
|
|
<param name="r">the rectangle the border is enclosing</param>
|
|
<returns>Beveled border path, null if there is no rounded corners</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.GetPen(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,System.String,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor,System.Double)">
|
|
<summary>
|
|
Get pen to be used for border draw respecting its style.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.GetColor(TheArtOfDev.HtmlRenderer.Core.Dom.Border,TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties,System.String)">
|
|
<summary>
|
|
Get the border color for the given box border.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.GetWidth(TheArtOfDev.HtmlRenderer.Core.Dom.Border,TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties)">
|
|
<summary>
|
|
Get the border width for the given box border.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.GetStyle(TheArtOfDev.HtmlRenderer.Core.Dom.Border,TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties)">
|
|
<summary>
|
|
Get the border style for the given box border.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.BordersDrawHandler.Darken(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Makes the specified color darker for inset/outset borders.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler">
|
|
<summary>
|
|
Handle context menu.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._selectAll">
|
|
<summary>
|
|
select all text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._copy">
|
|
<summary>
|
|
copy selected text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._copyLink">
|
|
<summary>
|
|
copy the link source
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._openLink">
|
|
<summary>
|
|
open link (as left mouse click)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._copyImageLink">
|
|
<summary>
|
|
copy the source of the image
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._copyImage">
|
|
<summary>
|
|
copy image to clipboard
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._saveImage">
|
|
<summary>
|
|
save image to disk
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._openVideo">
|
|
<summary>
|
|
open video in browser
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._copyVideoUrl">
|
|
<summary>
|
|
copy video url to browser
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._selectionHandler">
|
|
<summary>
|
|
the selection handler linked to the context menu handler
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._htmlContainer">
|
|
<summary>
|
|
the html container the handler is on
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._contextMenu">
|
|
<summary>
|
|
the last context menu shown
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._parentControl">
|
|
<summary>
|
|
the control that the context menu was shown on
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._currentRect">
|
|
<summary>
|
|
the css rectangle that context menu shown on
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler._currentLink">
|
|
<summary>
|
|
the css link box that context menu shown on
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.#cctor">
|
|
<summary>
|
|
Init context menu items strings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.#ctor(TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler,TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="selectionHandler">the selection handler linked to the context menu handler</param>
|
|
<param name="htmlContainer">the html container the handler is on</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.ShowContextMenu(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Show context menu clicked on given rectangle.
|
|
</summary>
|
|
<param name="parent">the parent control to show the context menu on</param>
|
|
<param name="rect">the rectangle that was clicked to show context menu</param>
|
|
<param name="link">the link that was clicked to show context menu on</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
<filterpriority>2</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.DisposeContextMenu">
|
|
<summary>
|
|
Dispose of the last used context menu.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.OnOpenLinkClick(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Handle link click.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.OnCopyLinkClick(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Copy the href of a link to clipboard.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.OnSaveImageClick(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Open save as dialog to save the image
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.OnCopyImageLinkClick(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Copy the image source to clipboard.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.OnCopyImageClick(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Copy image object to clipboard.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.OnCopyClick(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Copy selected text.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ContextMenuHandler.OnSelectAllClick(System.Object,System.EventArgs)">
|
|
<summary>
|
|
Select all text.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler">
|
|
<summary>
|
|
Utilities for fonts and fonts families handling.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler._adapter">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler._fontsMapping">
|
|
<summary>
|
|
Allow to map not installed fonts to different
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler._existingFontFamilies">
|
|
<summary>
|
|
collection of all installed and added font families to check if font exists
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler._fontsCache">
|
|
<summary>
|
|
cache of all the font used not to create same font again and again
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler.#ctor(TheArtOfDev.HtmlRenderer.Adapters.RAdapter)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler.IsFontExists(System.String)">
|
|
<summary>
|
|
Check if the given font family exists by name
|
|
</summary>
|
|
<param name="family">the font to check</param>
|
|
<returns>true - font exists by given family name, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler.AddFontFamily(TheArtOfDev.HtmlRenderer.Adapters.RFontFamily)">
|
|
<summary>
|
|
Adds a font family to be used.
|
|
</summary>
|
|
<param name="fontFamily">The font family to add.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler.AddFontFamilyMapping(System.String,System.String)">
|
|
<summary>
|
|
Adds a font mapping from <paramref name="fromFamily"/> to <paramref name="toFamily"/> iff the <paramref name="fromFamily"/> is not found.<br/>
|
|
When the <paramref name="fromFamily"/> font is used in rendered html and is not found in existing
|
|
fonts (installed or added) it will be replaced by <paramref name="toFamily"/>.<br/>
|
|
</summary>
|
|
<param name="fromFamily">the font family to replace</param>
|
|
<param name="toFamily">the font family to replace with</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler.GetCachedFont(System.String,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)">
|
|
<summary>
|
|
Get cached font instance for the given font properties.<br/>
|
|
Improve performance not to create same font multiple times.
|
|
</summary>
|
|
<returns>cached font instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler.TryGetFont(System.String,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)">
|
|
<summary>
|
|
Get cached font if it exists in cache or null if it is not.
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:TheArtOfDev.HtmlRenderer.Core.Handlers.FontsHandler.CreateFont(System.String,System.Double,TheArtOfDev.HtmlRenderer.Adapters.Entities.RFontStyle)" -->
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.DownloadFileAsyncCallback">
|
|
<summary>
|
|
On download file async complete, success or fail.
|
|
</summary>
|
|
<param name="imageUri">The online image uri</param>
|
|
<param name="filePath">the path to the downloaded file</param>
|
|
<param name="error">the error if download failed</param>
|
|
<param name="canceled">is the file download request was canceled</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader">
|
|
<summary>
|
|
Handler for downloading images from the web.<br/>
|
|
Single instance of the handler used for all images downloaded in a single html, this way if the html contains more
|
|
than one reference to the same image it will be downloaded only once.<br/>
|
|
Also handles corrupt, partial and canceled downloads by first downloading to temp file and only if successful moving to cached
|
|
file location.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader._clients">
|
|
<summary>
|
|
the web client used to download image from URL (to cancel on dispose)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader._imageDownloadCallbacks">
|
|
<summary>
|
|
dictionary of image cache path to callbacks of download to handle multiple requests to download the same image
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.DownloadImage(System.Uri,System.String,System.Boolean,TheArtOfDev.HtmlRenderer.Core.Handlers.DownloadFileAsyncCallback)">
|
|
<summary>
|
|
Makes a request to download the image from the server and raises the <see cref="!:cachedFileCallback"/> when it's down.<br/>
|
|
</summary>
|
|
<param name="imageUri">The online image uri</param>
|
|
<param name="filePath">the path on disk to download the file to</param>
|
|
<param name="async">is to download the file sync or async (true-async)</param>
|
|
<param name="cachedFileCallback">This callback will be called with local file path. If something went wrong in the download it will return null.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.DownloadImageFromUrl(System.Uri,System.String,System.String)">
|
|
<summary>
|
|
Download the requested file in the URI to the given file path.<br/>
|
|
Use async sockets API to download from web, <see cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.OnDownloadImageAsyncCompleted(System.Object,System.ComponentModel.AsyncCompletedEventArgs)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.DownloadImageFromUrlAsync(System.Object)">
|
|
<summary>
|
|
Download the requested file in the URI to the given file path.<br/>
|
|
Use async sockets API to download from web, <see cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.OnDownloadImageAsyncCompleted(System.Object,System.ComponentModel.AsyncCompletedEventArgs)"/>.
|
|
</summary>
|
|
<param name="data">key value pair of URL and file info to download the file to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.OnDownloadImageAsyncCompleted(System.Object,System.ComponentModel.AsyncCompletedEventArgs)">
|
|
<summary>
|
|
On download image complete to local file.<br/>
|
|
If the download canceled do nothing, if failed report error.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.OnDownloadImageCompleted(System.Net.WebClient,System.Uri,System.String,System.String,System.Exception,System.Boolean)">
|
|
<summary>
|
|
Checks if the file was downloaded and raises the cachedFileCallback from <see cref="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader._imageDownloadCallbacks"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageDownloader.ReleaseObjects">
|
|
<summary>
|
|
Release the image and client objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler">
|
|
<summary>
|
|
Handler for all loading image logic.<br/>
|
|
<p>
|
|
Loading by <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs"/>.<br/>
|
|
Loading by file path.<br/>
|
|
Loading by URI.<br/>
|
|
</p>
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
Supports sync and async image loading.
|
|
</para>
|
|
<para>
|
|
If the image object is created by the handler on calling dispose of the handler the image will be released, this
|
|
makes release of unused images faster as they can be large.<br/>
|
|
Disposing image load handler will also cancel download of image from the web.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._htmlContainer">
|
|
<summary>
|
|
the container of the html to handle load image for
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._loadCompleteCallback">
|
|
<summary>
|
|
callback raised when image load process is complete with image or without
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._imageFileStream">
|
|
<summary>
|
|
Must be open as long as the image is in use
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._image">
|
|
<summary>
|
|
the image instance of the loaded image
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._imageRectangle">
|
|
<summary>
|
|
the image rectangle restriction as returned from image load event
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._asyncCallback">
|
|
<summary>
|
|
to know if image load event callback was sync or async raised
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._releaseImageObject">
|
|
<summary>
|
|
flag to indicate if to release the image object on box dispose (only if image was loaded by the box)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler._disposed">
|
|
<summary>
|
|
is the handler has been disposed
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.#ctor(TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Core.Utils.ActionInt{TheArtOfDev.HtmlRenderer.Adapters.RImage,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Boolean})">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="htmlContainer">the container of the html to handle load image for</param>
|
|
<param name="loadCompleteCallback">callback raised when image load process is complete with image or without</param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.Image">
|
|
<summary>
|
|
the image instance of the loaded image
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.Rectangle">
|
|
<summary>
|
|
the image rectangle restriction as returned from image load event
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.LoadImage(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Set image of this image box by analyzing the src attribute.<br/>
|
|
Load the image from inline base64 encoded string.<br/>
|
|
Or from calling property/method on the bridge object that returns image or URL to image.<br/>
|
|
Or from file path<br/>
|
|
Or from URI.
|
|
</summary>
|
|
<remarks>
|
|
File path and URI image loading is executed async and after finishing calling <see cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.ImageLoadComplete(System.Boolean)"/>
|
|
on the main thread and not thread-pool.
|
|
</remarks>
|
|
<param name="src">the source of the image to load</param>
|
|
<param name="attributes">the collection of attributes on the element to use in event</param>
|
|
<returns>the image object (null if failed)</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.OnHtmlImageLoadEventCallback(System.String,System.Object,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Set the image using callback from load image event, use the given data.
|
|
</summary>
|
|
<param name="path">the path to the image to load (file path or uri)</param>
|
|
<param name="image">the image to load</param>
|
|
<param name="imageRectangle">optional: limit to specific rectangle of the image and not all of it</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.SetFromInlineData(System.String)">
|
|
<summary>
|
|
Load the image from inline base64 encoded string data.
|
|
</summary>
|
|
<param name="src">the source that has the base64 encoded image</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.GetImageFromData(System.String)">
|
|
<summary>
|
|
Extract image object from inline base64 encoded data in the src of the html img element.
|
|
</summary>
|
|
<param name="src">the source that has the base64 encoded image</param>
|
|
<returns>image from base64 data string or null if failed</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.SetImageFromPath(System.String)">
|
|
<summary>
|
|
Load image from path of image file or URL.
|
|
</summary>
|
|
<param name="path">the file path or uri to load image from</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.SetImageFromFile(System.IO.FileInfo)">
|
|
<summary>
|
|
Load the image file on thread-pool thread and calling <see cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.ImageLoadComplete(System.Boolean)"/> after.
|
|
</summary>
|
|
<param name="source">the file path to get the image from</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.LoadImageFromFile(System.String)">
|
|
<summary>
|
|
Load the image file on thread-pool thread and calling <see cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.ImageLoadComplete(System.Boolean)"/> after.<br/>
|
|
Calling <see cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.ImageLoadComplete(System.Boolean)"/> on the main thread and not thread-pool.
|
|
</summary>
|
|
<param name="source">the file path to get the image from</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.SetImageFromUrl(System.Uri)">
|
|
<summary>
|
|
Load image from the given URI by downloading it.<br/>
|
|
Create local file name in temp folder from the URI, if the file already exists use it as it has already been downloaded.
|
|
If not download the file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.OnDownloadImageCompleted(System.Uri,System.String,System.Exception,System.Boolean)">
|
|
<summary>
|
|
On download image complete to local file use <see cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.LoadImageFromFile(System.String)"/> to load the image file.<br/>
|
|
If the download canceled do nothing, if failed report error.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.ImageLoadComplete(System.Boolean)">
|
|
<summary>
|
|
Flag image load complete and request refresh for re-layout and invalidate.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.ImageLoadHandler.ReleaseObjects">
|
|
<summary>
|
|
Release the image and client objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler">
|
|
<summary>
|
|
Handler for text selection in the html.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._root">
|
|
<summary>
|
|
the root of the handled html tree
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._contextMenuHandler">
|
|
<summary>
|
|
handler for showing context menu on right click
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._selectionStartPoint">
|
|
<summary>
|
|
the mouse location when selection started used to ignore small selections
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._selectionStart">
|
|
<summary>
|
|
the starting word of html selection<br/>
|
|
where the user started the selection, if the selection is backwards then it will be the last selected word.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._selectionEnd">
|
|
<summary>
|
|
the ending word of html selection<br/>
|
|
where the user ended the selection, if the selection is backwards then it will be the first selected word.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._selectionStartIndex">
|
|
<summary>
|
|
the selection start index if the first selected word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._selectionEndIndex">
|
|
<summary>
|
|
the selection end index if the last selected word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._selectionStartOffset">
|
|
<summary>
|
|
the selection start offset if the first selected word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._selectionEndOffset">
|
|
<summary>
|
|
the selection end offset if the last selected word is partially selected (-1 if not selected or fully selected)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._backwardSelection">
|
|
<summary>
|
|
is the selection goes backward in the html, the starting word comes after the ending word in DFS traversing.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._inSelection">
|
|
<summary>
|
|
used to ignore mouse up after selection
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._isDoubleClickSelect">
|
|
<summary>
|
|
current selection process is after double click (full word selection)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._mouseDownInControl">
|
|
<summary>
|
|
used to know if selection is in the control or started outside so it needs to be ignored
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._mouseDownOnSelectedWord" -->
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._cursorChanged">
|
|
<summary>
|
|
is the cursor on the control has been changed by the selection handler
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._lastMouseDown">
|
|
<summary>
|
|
used to know if double click selection is requested
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "F:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler._dragDropData" -->
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.#ctor(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="root">the root of the handled html tree</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.SelectAll(TheArtOfDev.HtmlRenderer.Adapters.RControl)">
|
|
<summary>
|
|
Select all the words in the html.
|
|
</summary>
|
|
<param name="control">the control hosting the html to invalidate</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.SelectWord(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Select the word at the given location if found.
|
|
</summary>
|
|
<param name="control">the control hosting the html to invalidate</param>
|
|
<param name="loc">the location to select word at</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.HandleMouseDown(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.Boolean)">
|
|
<summary>
|
|
Handle mouse down to handle selection.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="loc">the location of the mouse on the html</param>
|
|
<param name="isMouseInContainer"> </param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.HandleMouseUp(TheArtOfDev.HtmlRenderer.Adapters.RControl,System.Boolean)">
|
|
<summary>
|
|
Handle mouse up to handle selection and link click.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="leftMouseButton">is the left mouse button has been released</param>
|
|
<returns>is the mouse up should be ignored</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.HandleMouseMove(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Handle mouse move to handle hover cursor and text selection.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
<param name="loc">the location of the mouse on the html</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.HandleMouseLeave(TheArtOfDev.HtmlRenderer.Adapters.RControl)">
|
|
<summary>
|
|
On mouse leave change the cursor back to default.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.CopySelectedHtml">
|
|
<summary>
|
|
Copy the currently selected html segment to clipboard.<br/>
|
|
Copy rich html text and plain text.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.GetSelectedText">
|
|
<summary>
|
|
Get the currently selected text segment in the html.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.GetSelectedHtml">
|
|
<summary>
|
|
Copy the currently selected html segment with style.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.GetSelectingStartIndex(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
The selection start index if the first selected word is partially selected (-1 if not selected or fully selected)<br/>
|
|
if the given word is not starting or ending selection word -1 is returned as full word selection is in place.
|
|
</summary>
|
|
<remarks>
|
|
Handles backward selecting by returning the selection end data instead of start.
|
|
</remarks>
|
|
<param name="word">the word to return the selection start index for</param>
|
|
<returns>data value or -1 if not applicable</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.GetSelectedEndIndexOffset(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
The selection end index if the last selected word is partially selected (-1 if not selected or fully selected)<br/>
|
|
if the given word is not starting or ending selection word -1 is returned as full word selection is in place.
|
|
</summary>
|
|
<remarks>
|
|
Handles backward selecting by returning the selection end data instead of start.
|
|
</remarks>
|
|
<param name="word">the word to return the selection end index for</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.GetSelectedStartOffset(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
The selection start offset if the first selected word is partially selected (-1 if not selected or fully selected)<br/>
|
|
if the given word is not starting or ending selection word -1 is returned as full word selection is in place.
|
|
</summary>
|
|
<remarks>
|
|
Handles backward selecting by returning the selection end data instead of start.
|
|
</remarks>
|
|
<param name="word">the word to return the selection start offset for</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.GetSelectedEndOffset(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
The selection end offset if the last selected word is partially selected (-1 if not selected or fully selected)<br/>
|
|
if the given word is not starting or ending selection word -1 is returned as full word selection is in place.
|
|
</summary>
|
|
<remarks>
|
|
Handles backward selecting by returning the selection end data instead of start.
|
|
</remarks>
|
|
<param name="word">the word to return the selection end offset for</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.ClearSelection">
|
|
<summary>
|
|
Clear the current selection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
<filterpriority>2</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.HandleSelection(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.Boolean)">
|
|
<summary>
|
|
Handle html text selection by mouse move over the html with left mouse button pressed.<br/>
|
|
Calculate the words in the selected range and set their selected property.
|
|
</summary>
|
|
<param name="control">the control hosting the html to invalidate</param>
|
|
<param name="loc">the mouse location</param>
|
|
<param name="allowPartialSelect">true - partial word selection allowed, false - only full words selection</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.ClearSelection(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Clear the selection from all the words in the css box recursively.
|
|
</summary>
|
|
<param name="box">the css box to selectionStart clear at</param>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.StartDragDrop(TheArtOfDev.HtmlRenderer.Adapters.RControl)" -->
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.SelectAllWords(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Select all the words that are under <paramref name="box"/> DOM hierarchy.<br/>
|
|
</summary>
|
|
<param name="box">the box to start select all at</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.CheckNonEmptySelection(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.Boolean)">
|
|
<summary>
|
|
Check if the current selection is non empty, has some selection data.
|
|
</summary>
|
|
<param name="loc"></param>
|
|
<param name="allowPartialSelect">true - partial word selection allowed, false - only full words selection</param>
|
|
<returns>true - is non empty selection, false - empty selection</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.SelectWordsInRange(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
Select all the words that are between <paramref name="selectionStart"/> word and <paramref name="selectionEnd"/> word in the DOM hierarchy.<br/>
|
|
</summary>
|
|
<param name="root">the root of the DOM sub-tree the selection is in</param>
|
|
<param name="selectionStart">selection start word limit</param>
|
|
<param name="selectionEnd">selection end word limit</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.SelectWordsInRange(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,System.Boolean@)">
|
|
<summary>
|
|
Select all the words that are between <paramref name="selectionStart"/> word and <paramref name="selectionEnd"/> word in the DOM hierarchy.
|
|
</summary>
|
|
<param name="box">the current traversal node</param>
|
|
<param name="selectionStart">selection start word limit</param>
|
|
<param name="selectionEnd">selection end word limit</param>
|
|
<param name="inSelection">used to know the traversal is currently in selected range</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.CalculateWordCharIndexAndOffset(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.Boolean)">
|
|
<summary>
|
|
Calculate the character index and offset by characters for the given word and given offset.<br/>
|
|
<seealso cref="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.CalculateWordCharIndexAndOffset(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.Boolean)"/>.
|
|
</summary>
|
|
<param name="control">used to create graphics to measure string</param>
|
|
<param name="word">the word to calculate its index and offset</param>
|
|
<param name="loc">the location to calculate for</param>
|
|
<param name="selectionStart">to set the starting or ending char and offset data</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.CalculateWordCharIndexAndOffset(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.Boolean,System.Int32@,System.Double@)">
|
|
<summary>
|
|
Calculate the character index and offset by characters for the given word and given offset.<br/>
|
|
If the location is below the word line then set the selection to the end.<br/>
|
|
If the location is to the right of the word then set the selection to the end.<br/>
|
|
If the offset is to the left of the word set the selection to the beginning.<br/>
|
|
Otherwise calculate the width of each substring to find the char the location is on.
|
|
</summary>
|
|
<param name="control">used to create graphics to measure string</param>
|
|
<param name="word">the word to calculate its index and offset</param>
|
|
<param name="loc">the location to calculate for</param>
|
|
<param name="inclusive">is to include the first character in the calculation</param>
|
|
<param name="selectionIndex">return the index of the char under the location</param>
|
|
<param name="selectionOffset">return the offset of the char under the location</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.SelectionHandler.CheckSelectionDirection">
|
|
<summary>
|
|
Check if the selection direction is forward or backward.<br/>
|
|
Is the selection start word is before the selection end word in DFS traversal.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Handlers.StylesheetLoadHandler">
|
|
<summary>
|
|
Handler for loading a stylesheet data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.StylesheetLoadHandler.LoadStylesheet(TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.String@,TheArtOfDev.HtmlRenderer.Core.CssData@)">
|
|
<summary>
|
|
Load stylesheet data from the given source.<br/>
|
|
The source can be local file or web URI.<br/>
|
|
First raise <see cref="T:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs"/> event to allow the client to overwrite the stylesheet loading.<br/>
|
|
If the stylesheet is downloaded from URI we will try to correct local URIs to absolute.<br/>
|
|
</summary>
|
|
<param name="htmlContainer">the container of the html to handle load stylesheet for</param>
|
|
<param name="src">the source of the element to load the stylesheet by</param>
|
|
<param name="attributes">the attributes of the link element</param>
|
|
<param name="stylesheet">return the stylesheet string that has been loaded (null if failed or <paramref name="stylesheetData"/> is given)</param>
|
|
<param name="stylesheetData">return stylesheet data object that was provided by overwrite (null if failed or <paramref name="stylesheet"/> is given)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.StylesheetLoadHandler.LoadStylesheet(TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,System.String)">
|
|
<summary>
|
|
Load stylesheet string from given source (file path or uri).
|
|
</summary>
|
|
<param name="htmlContainer">the container of the html to handle load stylesheet for</param>
|
|
<param name="src">the file path or uri to load the stylesheet from</param>
|
|
<returns>the stylesheet string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.StylesheetLoadHandler.LoadStylesheetFromFile(TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,System.String)">
|
|
<summary>
|
|
Load the stylesheet from local file by given path.
|
|
</summary>
|
|
<param name="htmlContainer">the container of the html to handle load stylesheet for</param>
|
|
<param name="path">the stylesheet file to load</param>
|
|
<returns>the loaded stylesheet string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.StylesheetLoadHandler.LoadStylesheetFromUri(TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,System.Uri)">
|
|
<summary>
|
|
Load the stylesheet from uri by downloading the string.
|
|
</summary>
|
|
<param name="htmlContainer">the container of the html to handle load stylesheet for</param>
|
|
<param name="uri">the uri to download from</param>
|
|
<returns>the loaded stylesheet string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Handlers.StylesheetLoadHandler.CorrectRelativeUrls(System.String,System.Uri)">
|
|
<summary>
|
|
Make relative URLs absolute in the stylesheet using the URI of the stylesheet.
|
|
</summary>
|
|
<param name="stylesheet">the stylesheet to correct</param>
|
|
<param name="baseUri">the stylesheet uri to use to create absolute URLs</param>
|
|
<returns>Corrected stylesheet</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt">
|
|
<summary>
|
|
Low level handling of Html Renderer logic.<br/>
|
|
Allows html layout and rendering without association to actual control, those allowing to handle html rendering on any graphics object.<br/>
|
|
Using this class will require the client to handle all propagation's of mouse/keyboard events, layout/paint calls, scrolling offset,
|
|
location/size/rectangle handling and UI refresh requests.<br/>
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
<b>MaxSize and ActualSize:</b><br/>
|
|
The max width and height of the rendered html.<br/>
|
|
The max width will effect the html layout wrapping lines, resize images and tables where possible.<br/>
|
|
The max height does NOT effect layout, but will not render outside it (clip).<br/>
|
|
<see cref="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ActualSize"/> can exceed the max size by layout restrictions (unwrap-able line, set image size, etc.).<br/>
|
|
Set zero for unlimited (width/height separately).<br/>
|
|
</para>
|
|
<para>
|
|
<b>ScrollOffset:</b><br/>
|
|
This will adjust the rendered html by the given offset so the content will be "scrolled".<br/>
|
|
Element that is rendered at location (50,100) with offset of (0,200) will not be rendered
|
|
at -100, therefore outside the client rectangle.
|
|
</para>
|
|
<para>
|
|
<b>LinkClicked event</b><br/>
|
|
Raised when the user clicks on a link in the html.<br/>
|
|
Allows canceling the execution of the link to overwrite by custom logic.<br/>
|
|
If error occurred in event handler it will propagate up the stack.
|
|
</para>
|
|
<para>
|
|
<b>StylesheetLoad event:</b><br/>
|
|
Raised when a stylesheet is about to be loaded by file path or URL in 'link' element.<br/>
|
|
Allows to overwrite the loaded stylesheet by providing the stylesheet data manually, or different source (file or URL) to load from.<br/>
|
|
Example: The stylesheet 'href' can be non-valid URI string that is interpreted in the overwrite delegate by custom logic to pre-loaded stylesheet object<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
</para>
|
|
<para>
|
|
<b>ImageLoad event:</b><br/>
|
|
Raised when an image is about to be loaded by file path, URL or inline data in 'img' element or background-image CSS style.<br/>
|
|
Allows to overwrite the loaded image by providing the image object manually, or different source (file or URL) to load from.<br/>
|
|
Example: image 'src' can be non-valid string that is interpreted in the overwrite delegate by custom logic to resource image object<br/>
|
|
Example: image 'src' in the html is relative - the overwrite intercepts the load and provide full source URL to load the image from<br/>
|
|
Example: image download requires authentication - the overwrite intercepts the load, downloads the image to disk using custom code and provide
|
|
file path to load the image from.<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
</para>
|
|
<para>
|
|
<b>Refresh event:</b><br/>
|
|
Raised when html renderer requires refresh of the control hosting (invalidation and re-layout).<br/>
|
|
There is no guarantee that the event will be raised on the main thread, it can be raised on thread-pool thread.
|
|
</para>
|
|
<para>
|
|
<b>RenderError event:</b><br/>
|
|
Raised when an error occurred during html rendering.<br/>
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._adapter">
|
|
<summary>
|
|
Main adapter to framework specific logic.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._cssParser">
|
|
<summary>
|
|
parser for CSS data
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._root">
|
|
<summary>
|
|
the root css box of the parsed html
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._hoverBoxes">
|
|
<summary>
|
|
list of all css boxes that have ":hover" selector on them
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._selectionHandler">
|
|
<summary>
|
|
Handler for text selection in the html.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._imageDownloader">
|
|
<summary>
|
|
Handler for downloading of images in the html
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._selectionForeColor">
|
|
<summary>
|
|
the text fore color use for selected text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._selectionBackColor">
|
|
<summary>
|
|
the back-color to use for selected text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._cssData">
|
|
<summary>
|
|
the parsed stylesheet data used for handling the html
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._isSelectionEnabled">
|
|
<summary>
|
|
Is content selection is enabled for the rendered html (default - true).<br/>
|
|
If set to 'false' the rendered html will be static only with ability to click on links.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._isContextMenuEnabled">
|
|
<summary>
|
|
Is the build-in context menu enabled (default - true)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._avoidGeometryAntialias">
|
|
<summary>
|
|
Gets or sets a value indicating if anti-aliasing should be avoided
|
|
for geometry like backgrounds and borders
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._avoidAsyncImagesLoading">
|
|
<summary>
|
|
Gets or sets a value indicating if image asynchronous loading should be avoided (default - false).<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._avoidImagesLateLoading">
|
|
<summary>
|
|
Gets or sets a value indicating if image loading only when visible should be avoided (default - false).<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._loadComplete">
|
|
<summary>
|
|
is the load of the html document is complete
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._location">
|
|
<summary>
|
|
the top-left most location of the rendered html
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._maxSize">
|
|
<summary>
|
|
the max width and height of the rendered html, effects layout, actual size cannot exceed this values.<br/>
|
|
Set zero for unlimited.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._scrollOffset">
|
|
<summary>
|
|
Gets or sets the scroll offset of the document for scroll controls
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._actualSize">
|
|
<summary>
|
|
The actual size of the rendered html (after layout)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._marginTop">
|
|
<summary>
|
|
the top margin between the page start and the text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._marginBottom">
|
|
<summary>
|
|
the bottom margin between the page end and the text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._marginLeft">
|
|
<summary>
|
|
the left margin between the page start and the text
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt._marginRight">
|
|
<summary>
|
|
the right margin between the page end and the text
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.#ctor(TheArtOfDev.HtmlRenderer.Adapters.RAdapter)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.Adapter">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.CssParser">
|
|
<summary>
|
|
parser for CSS data
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.LoadComplete">
|
|
<summary>
|
|
Raised when the set html document has been fully loaded.<br/>
|
|
Allows manipulation of the html dom, scroll position, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.LinkClicked">
|
|
<summary>
|
|
Raised when the user clicks on a link in the html.<br/>
|
|
Allows canceling the execution of the link.
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.Refresh">
|
|
<summary>
|
|
Raised when html renderer requires refresh of the control hosting (invalidation and re-layout).
|
|
</summary>
|
|
<remarks>
|
|
There is no guarantee that the event will be raised on the main thread, it can be raised on thread-pool thread.
|
|
</remarks>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ScrollChange">
|
|
<summary>
|
|
Raised when Html Renderer request scroll to specific location.<br/>
|
|
This can occur on document anchor click.
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.RenderError">
|
|
<summary>
|
|
Raised when an error occurred during html rendering.<br/>
|
|
</summary>
|
|
<remarks>
|
|
There is no guarantee that the event will be raised on the main thread, it can be raised on thread-pool thread.
|
|
</remarks>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.StylesheetLoad">
|
|
<summary>
|
|
Raised when a stylesheet is about to be loaded by file path or URI by link element.<br/>
|
|
This event allows to provide the stylesheet manually or provide new source (file or Uri) to load from.<br/>
|
|
If no alternative data is provided the original source will be used.<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ImageLoad">
|
|
<summary>
|
|
Raised when an image is about to be loaded by file path or URI.<br/>
|
|
This event allows to provide the image manually, if not handled the image will be loaded from file or download from URI.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.CssData">
|
|
<summary>
|
|
the parsed stylesheet data used for handling the html
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.AvoidGeometryAntialias">
|
|
<summary>
|
|
Gets or sets a value indicating if anti-aliasing should be avoided for geometry like backgrounds and borders (default - false).
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.AvoidAsyncImagesLoading">
|
|
<summary>
|
|
Gets or sets a value indicating if image asynchronous loading should be avoided (default - false).<br/>
|
|
True - images are loaded synchronously during html parsing.<br/>
|
|
False - images are loaded asynchronously to html parsing when downloaded from URL or loaded from disk.<br/>
|
|
</summary>
|
|
<remarks>
|
|
Asynchronously image loading allows to unblock html rendering while image is downloaded or loaded from disk using IO
|
|
ports to achieve better performance.<br/>
|
|
Asynchronously image loading should be avoided when the full html content must be available during render, like render to image.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.AvoidImagesLateLoading">
|
|
<summary>
|
|
Gets or sets a value indicating if image loading only when visible should be avoided (default - false).<br/>
|
|
True - images are loaded as soon as the html is parsed.<br/>
|
|
False - images that are not visible because of scroll location are not loaded until they are scrolled to.
|
|
</summary>
|
|
<remarks>
|
|
Images late loading improve performance if the page contains image outside the visible scroll area, especially if there is large
|
|
amount of images, as all image loading is delayed (downloading and loading into memory).<br/>
|
|
Late image loading may effect the layout and actual size as image without set size will not have actual size until they are loaded
|
|
resulting in layout change during user scroll.<br/>
|
|
Early image loading may also effect the layout if image without known size above the current scroll location are loaded as they
|
|
will push the html elements down.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.IsSelectionEnabled">
|
|
<summary>
|
|
Is content selection is enabled for the rendered html (default - true).<br/>
|
|
If set to 'false' the rendered html will be static only with ability to click on links.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.IsContextMenuEnabled">
|
|
<summary>
|
|
Is the build-in context menu enabled and will be shown on mouse right click (default - true)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ScrollOffset">
|
|
<summary>
|
|
The scroll offset of the html.<br/>
|
|
This will adjust the rendered html by the given offset so the content will be "scrolled".<br/>
|
|
</summary>
|
|
<example>
|
|
Element that is rendered at location (50,100) with offset of (0,200) will not be rendered as it
|
|
will be at -100 therefore outside the client rectangle.
|
|
</example>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.Location">
|
|
<summary>
|
|
The top-left most location of the rendered html.<br/>
|
|
This will offset the top-left corner of the rendered html.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.MaxSize">
|
|
<summary>
|
|
The max width and height of the rendered html.<br/>
|
|
The max width will effect the html layout wrapping lines, resize images and tables where possible.<br/>
|
|
The max height does NOT effect layout, but will not render outside it (clip).<br/>
|
|
<see cref="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ActualSize"/> can be exceed the max size by layout restrictions (unwrapable line, set image size, etc.).<br/>
|
|
Set zero for unlimited (width\height separately).<br/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ActualSize">
|
|
<summary>
|
|
The actual size of the rendered html (after layout)
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.MarginTop">
|
|
<summary>
|
|
the top margin between the page start and the text
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.MarginBottom">
|
|
<summary>
|
|
the bottom margin between the page end and the text
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.MarginLeft">
|
|
<summary>
|
|
the left margin between the page start and the text
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.MarginRight">
|
|
<summary>
|
|
the right margin between the page end and the text
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.SetMargins(System.Int32)">
|
|
<summary>
|
|
Set all 4 margins to the given value.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.SelectedText">
|
|
<summary>
|
|
Get the currently selected text segment in the html.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.SelectedHtml">
|
|
<summary>
|
|
Copy the currently selected html segment with style.
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.Root">
|
|
<summary>
|
|
the root css box of the parsed html
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.SelectionForeColor">
|
|
<summary>
|
|
the text fore color use for selected text
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.SelectionBackColor">
|
|
<summary>
|
|
the back-color to use for selected text
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.SetHtml(System.String,TheArtOfDev.HtmlRenderer.Core.CssData)">
|
|
<summary>
|
|
Init with optional document and stylesheet.
|
|
</summary>
|
|
<param name="htmlSource">the html to init with, init empty if not given</param>
|
|
<param name="baseCssData">optional: the stylesheet to init with, init default if not given</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.Clear">
|
|
<summary>
|
|
Clear the content of the HTML container releasing any resources used to render previously existing content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ClearSelection">
|
|
<summary>
|
|
Clear the current selection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.GetHtml(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle)">
|
|
<summary>
|
|
Get html from the current DOM tree with style if requested.
|
|
</summary>
|
|
<param name="styleGen">Optional: controls the way styles are generated when html is generated (default: <see cref="F:TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle.Inline"/>)</param>
|
|
<returns>generated html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.GetAttributeAt(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.String)">
|
|
<summary>
|
|
Get attribute value of element at the given x,y location by given key.<br/>
|
|
If more than one element exist with the attribute at the location the inner most is returned.
|
|
</summary>
|
|
<param name="location">the location to find the attribute at</param>
|
|
<param name="attribute">the attribute key to get value by</param>
|
|
<returns>found attribute value or null if not found</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.GetLinks">
|
|
<summary>
|
|
Get all the links in the HTML with the element rectangle and href data.
|
|
</summary>
|
|
<returns>collection of all the links in the HTML</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.GetLinkAt(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Get css link href at the given x,y location.
|
|
</summary>
|
|
<param name="location">the location to find the link at</param>
|
|
<returns>css link href if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.GetElementRectangle(System.String)">
|
|
<summary>
|
|
Get the rectangle of html element as calculated by html layout.<br/>
|
|
Element if found by id (id attribute on the html element).<br/>
|
|
Note: to get the screen rectangle you need to adjust by the hosting control.<br/>
|
|
</summary>
|
|
<param name="elementId">the id of the element to get its rectangle</param>
|
|
<returns>the rectangle of the element or null if not found</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.PerformLayout(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Measures the bounds of box and children, recursively.
|
|
</summary>
|
|
<param name="g">Device context to draw</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.PerformPaint(TheArtOfDev.HtmlRenderer.Adapters.RGraphics)">
|
|
<summary>
|
|
Render the html using the given device.
|
|
</summary>
|
|
<param name="g">the device to use to render</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.HandleMouseDown(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Handle mouse down to handle selection.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="location">the location of the mouse</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.HandleMouseUp(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Adapters.Entities.RMouseEvent)">
|
|
<summary>
|
|
Handle mouse up to handle selection and link click.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="location">the location of the mouse</param>
|
|
<param name="e">the mouse event data</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.HandleMouseDoubleClick(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Handle mouse double click to select word under the mouse.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
<param name="location">the location of the mouse</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.HandleMouseMove(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Handle mouse move to handle hover cursor and text selection.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
<param name="location">the location of the mouse</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.HandleMouseLeave(TheArtOfDev.HtmlRenderer.Adapters.RControl)">
|
|
<summary>
|
|
Handle mouse leave to handle hover cursor.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to set cursor and invalidate</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.HandleKeyDown(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RKeyEvent)">
|
|
<summary>
|
|
Handle key down event for selection and copy.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="e">the pressed key</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.RaiseHtmlStylesheetLoadEvent(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlStylesheetLoadEventArgs)">
|
|
<summary>
|
|
Raise the stylesheet load event with the given event args.
|
|
</summary>
|
|
<param name="args">the event args</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.RaiseHtmlImageLoadEvent(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlImageLoadEventArgs)">
|
|
<summary>
|
|
Raise the image load event with the given event args.
|
|
</summary>
|
|
<param name="args">the event args</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.RequestRefresh(System.Boolean)">
|
|
<summary>
|
|
Request invalidation and re-layout of the control hosting the renderer.
|
|
</summary>
|
|
<param name="layout">is re-layout is required for the refresh</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.ReportError(TheArtOfDev.HtmlRenderer.Core.Entities.HtmlRenderErrorType,System.String,System.Exception)">
|
|
<summary>
|
|
Report error in html render process.
|
|
</summary>
|
|
<param name="type">the type of error to report</param>
|
|
<param name="message">the error message</param>
|
|
<param name="exception">optional: the exception that occured</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.HandleLinkClicked(TheArtOfDev.HtmlRenderer.Adapters.RControl,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Handle link clicked going over <see cref="E:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.LinkClicked"/> event and using <see cref="M:System.Diagnostics.Process.Start"/> if not canceled.
|
|
</summary>
|
|
<param name="parent">the control hosting the html to invalidate</param>
|
|
<param name="location">the location of the mouse</param>
|
|
<param name="link">the link that was clicked</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.AddHoverBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Add css box that has ":hover" selector to be handled on mouse hover.
|
|
</summary>
|
|
<param name="box">the box that has the hover selector</param>
|
|
<param name="block">the css block with the css data with the selector</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.GetImageDownloader">
|
|
<summary>
|
|
Get image downloader to be used to download images for the current html rendering.<br/>
|
|
Lazy create single downloader to be used for all images in the current html.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
<filterpriority>2</filterpriority>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.OffsetByScroll(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Adjust the offset of the given location by the current scroll offset.
|
|
</summary>
|
|
<param name="location">the location to adjust</param>
|
|
<returns>the adjusted location</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.IsMouseInContainer(TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Check if the mouse is currently on the html container.<br/>
|
|
Relevant if the html container is not filled in the hosted control (location is not zero and the size is not the full size of the control).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt.Dispose(System.Boolean)">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.HtmlRendererUtils">
|
|
<summary>
|
|
General utilities.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlRendererUtils.MeasureHtmlByRestrictions(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Measure the size of the html by performing layout under the given restrictions.
|
|
</summary>
|
|
<param name="g">the graphics to use</param>
|
|
<param name="htmlContainer">the html to calculate the layout for</param>
|
|
<param name="minSize">the minimal size of the rendered html (zero - not limit the width/height)</param>
|
|
<param name="maxSize">the maximum size of the rendered html, if not zero and html cannot be layout within the limit it will be clipped (zero - not limit the width/height)</param>
|
|
<returns>return: the size of the html to be rendered within the min/max limits</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.HtmlRendererUtils.Layout(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Perform the layout of the html container by given size restrictions returning the final size.<br/>
|
|
The layout can be effected by the HTML content in the <paramref name="htmlContainer"/> if <paramref name="autoSize"/> or
|
|
<paramref name="autoSizeHeightOnly"/> is set to true.<br/>
|
|
Handle minimum and maximum size restrictions.<br/>
|
|
Handle auto size and auto size for height only. if <paramref name="autoSize"/> is true <paramref name="autoSizeHeightOnly"/>
|
|
is ignored.<br/>
|
|
</summary>
|
|
<param name="g">the graphics used for layout</param>
|
|
<param name="htmlContainer">the html container to layout</param>
|
|
<param name="size">the current size</param>
|
|
<param name="minSize">the min size restriction - can be empty for no restriction</param>
|
|
<param name="maxSize">the max size restriction - can be empty for no restriction</param>
|
|
<param name="autoSize">if to modify the size (width and height) by html content layout</param>
|
|
<param name="autoSizeHeightOnly">if to modify the height by html content layout</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser">
|
|
<summary>
|
|
Parser to parse CSS stylesheet source string into CSS objects.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser._cssBlockSplitters">
|
|
<summary>
|
|
split CSS rule
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser._adapter">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser._valueParser">
|
|
<summary>
|
|
Utility for value parsing.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser._cssClassTrimChars">
|
|
<summary>
|
|
The chars to trim the css class name by
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.#ctor(TheArtOfDev.HtmlRenderer.Adapters.RAdapter)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseStyleSheet(System.String,System.Boolean)">
|
|
<summary>
|
|
Parse the given stylesheet source to CSS blocks dictionary.<br/>
|
|
The CSS blocks are organized into two level buckets of media type and class name.<br/>
|
|
Root media type are found under 'all' bucket.<br/>
|
|
If <paramref name="combineWithDefault"/> is true the parsed css blocks are added to the
|
|
default css data (as defined by W3), merged if class name already exists. If false only the data in the given stylesheet is returned.
|
|
</summary>
|
|
<seealso cref="!:http://www.w3.org/TR/CSS21/sample.html"/>
|
|
<param name="stylesheet">raw css stylesheet to parse</param>
|
|
<param name="combineWithDefault">true - combine the parsed css data with default css data, false - return only the parsed css data</param>
|
|
<returns>the CSS data with parsed CSS objects (never null)</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseStyleSheet(TheArtOfDev.HtmlRenderer.Core.CssData,System.String)">
|
|
<summary>
|
|
Parse the given stylesheet source to CSS blocks dictionary.<br/>
|
|
The CSS blocks are organized into two level buckets of media type and class name.<br/>
|
|
Root media type are found under 'all' bucket.<br/>
|
|
The parsed css blocks are added to the given css data, merged if class name already exists.
|
|
</summary>
|
|
<param name="cssData">the CSS data to fill with parsed CSS objects</param>
|
|
<param name="stylesheet">raw css stylesheet to parse</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseCssBlock(System.String,System.String)">
|
|
<summary>
|
|
Parse single CSS block source into CSS block instance.
|
|
</summary>
|
|
<param name="className">the name of the css class of the block</param>
|
|
<param name="blockSource">the CSS block to parse</param>
|
|
<returns>the created CSS block instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseFontFamily(System.String)">
|
|
<summary>
|
|
Parse a complex font family css property to check if it contains multiple fonts and if the font exists.<br/>
|
|
returns the font family name to use or 'inherit' if failed.
|
|
</summary>
|
|
<param name="value">the font-family value to parse</param>
|
|
<returns>parsed font-family value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseColor(System.String)">
|
|
<summary>
|
|
Parses a color value in CSS style; e.g. #ff0000, red, rgb(255,0,0), rgb(100%, 0, 0)
|
|
</summary>
|
|
<param name="colorStr">color string value to parse</param>
|
|
<returns>color value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.RemoveStylesheetComments(System.String)">
|
|
<summary>
|
|
Remove comments from the given stylesheet.
|
|
</summary>
|
|
<param name="stylesheet">the stylesheet to remove comments from</param>
|
|
<returns>stylesheet without comments</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseStyleBlocks(TheArtOfDev.HtmlRenderer.Core.CssData,System.String)">
|
|
<summary>
|
|
Parse given stylesheet for CSS blocks<br/>
|
|
This blocks are added under the "all" keyword.
|
|
</summary>
|
|
<param name="cssData">the CSS data to fill with parsed CSS objects</param>
|
|
<param name="stylesheet">the stylesheet to parse</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseMediaStyleBlocks(TheArtOfDev.HtmlRenderer.Core.CssData,System.String)">
|
|
<summary>
|
|
Parse given stylesheet for media CSS blocks<br/>
|
|
This blocks are added under the specific media block they are found.
|
|
</summary>
|
|
<param name="cssData">the CSS data to fill with parsed CSS objects</param>
|
|
<param name="stylesheet">the stylesheet to parse</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.FeedStyleBlock(TheArtOfDev.HtmlRenderer.Core.CssData,System.String,System.String)">
|
|
<summary>
|
|
Feeds the style with a block about the specific media.<br/>
|
|
When no media is specified, "all" will be used.
|
|
</summary>
|
|
<param name="cssData"> </param>
|
|
<param name="block">the CSS block to handle</param>
|
|
<param name="media">optional: the media (default - all)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseCssBlockImp(System.String,System.String)">
|
|
<summary>
|
|
Parse single CSS block source into CSS block instance.
|
|
</summary>
|
|
<param name="className">the name of the css class of the block</param>
|
|
<param name="blockSource">the CSS block to parse</param>
|
|
<returns>the created CSS block instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseCssBlockSelector(System.String,System.String@)">
|
|
<summary>
|
|
Parse css block selector to support hierarchical selector (p class1 > class2).
|
|
</summary>
|
|
<param name="className">the class selector to parse</param>
|
|
<param name="firstClass">return the main class the css block is on</param>
|
|
<returns>returns the hierarchy of classes or null if single class selector</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseCssBlockProperties(System.String)">
|
|
<summary>
|
|
Parse the properties of the given css block into a key-value dictionary.
|
|
</summary>
|
|
<param name="blockSource">the raw css block to parse</param>
|
|
<returns>dictionary with parsed css block properties</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.AddProperty(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Add the given property to the given properties collection, if the property is complex containing
|
|
multiple css properties then parse them and add the inner properties.
|
|
</summary>
|
|
<param name="propName">the name of the css property to add</param>
|
|
<param name="propValue">the value of the css property to add</param>
|
|
<param name="properties">the properties collection to add to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseLengthProperty(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse length property to add only valid lengths.
|
|
</summary>
|
|
<param name="propName">the name of the css property to add</param>
|
|
<param name="propValue">the value of the css property to add</param>
|
|
<param name="properties">the properties collection to add to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseColorProperty(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse color property to add only valid color.
|
|
</summary>
|
|
<param name="propName">the name of the css property to add</param>
|
|
<param name="propValue">the value of the css property to add</param>
|
|
<param name="properties">the properties collection to add to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseFontProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse a complex font property value that contains multiple css properties into specific css properties.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse to specific values</param>
|
|
<param name="properties">the properties collection to add the specific properties to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseImageProperty(System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse</param>
|
|
<returns>parsed value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseFontFamilyProperty(System.String)">
|
|
<summary>
|
|
Parse a complex font family css property to check if it contains multiple fonts and if the font exists.<br/>
|
|
returns the font family name to use or 'inherit' if failed.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse</param>
|
|
<returns>parsed font-family value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorderProperty(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse a complex border property value that contains multiple css properties into specific css properties.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse to specific values</param>
|
|
<param name="direction">the left, top, right or bottom direction of the border to parse</param>
|
|
<param name="properties">the properties collection to add the specific properties to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseMarginProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse a complex margin property value that contains multiple css properties into specific css properties.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse to specific values</param>
|
|
<param name="properties">the properties collection to add the specific properties to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorderStyleProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse a complex border style property value that contains multiple css properties into specific css properties.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse to specific values</param>
|
|
<param name="properties">the properties collection to add the specific properties to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorderWidthProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse a complex border width property value that contains multiple css properties into specific css properties.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse to specific values</param>
|
|
<param name="properties">the properties collection to add the specific properties to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorderColorProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse a complex border color property value that contains multiple css properties into specific css properties.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse to specific values</param>
|
|
<param name="properties">the properties collection to add the specific properties to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParsePaddingProperty(System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Parse a complex padding property value that contains multiple css properties into specific css properties.
|
|
</summary>
|
|
<param name="propValue">the value of the property to parse to specific values</param>
|
|
<param name="properties">the properties collection to add the specific properties to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.SplitMultiDirectionValues(System.String,System.String@,System.String@,System.String@,System.String@)">
|
|
<summary>
|
|
Split multi direction value into the proper direction values (left, top, right, bottom).
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.SplitValues(System.String,System.Char)">
|
|
<summary>
|
|
Split the value by the specified separator; e.g. Useful in values like 'padding:5 4 3 inherit'
|
|
</summary>
|
|
<param name="value">Value to be splitted</param>
|
|
<param name="separator"> </param>
|
|
<returns>Splitted and trimmed values</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorder(System.String,System.String@,System.String@,System.String@)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="value"></param>
|
|
<param name="width"> </param>
|
|
<param name="style"></param>
|
|
<param name="color"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorderWidth(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Parse the given substring to extract border width substring.
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>found border width value or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorderStyle(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Parse the given substring to extract border style substring.<br/>
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>found border width value or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssParser.ParseBorderColor(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Parse the given substring to extract border style substring.<br/>
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>found border width value or null</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser">
|
|
<summary>
|
|
Parse CSS properties values like numbers, Urls, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser._adapter">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.#ctor(TheArtOfDev.HtmlRenderer.Adapters.RAdapter)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.IsFloat(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Check if the given substring is a valid double number.
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>true - valid double number, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.IsInt(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Check if the given substring is a valid double number.
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>true - valid int number, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.IsValidLength(System.String)">
|
|
<summary>
|
|
Check if the given string is a valid length value.
|
|
</summary>
|
|
<param name="value">the string value to check</param>
|
|
<returns>true - valid, false - invalid</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.ParseNumber(System.String,System.Double)">
|
|
<summary>
|
|
Evals a number and returns it. If number is a percentage, it will be multiplied by <see cref="!:hundredPercent"/>
|
|
</summary>
|
|
<param name="number">Number to be parsed</param>
|
|
<param name="hundredPercent">Number that represents the 100% if parsed number is a percentage</param>
|
|
<returns>Parsed number. Zero if error while parsing.</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.ParseLength(System.String,System.Double,TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties,System.Boolean)">
|
|
<summary>
|
|
Parses a length. Lengths are followed by an unit identifier (e.g. 10px, 3.1em)
|
|
</summary>
|
|
<param name="length">Specified length</param>
|
|
<param name="hundredPercent">Equivalent to 100 percent when length is percentage</param>
|
|
<param name="fontAdjust">if the length is in pixels and the length is font related it needs to use 72/96 factor</param>
|
|
<param name="box"></param>
|
|
<returns>the parsed length value with adjustments</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.ParseLength(System.String,System.Double,TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties,System.String)">
|
|
<summary>
|
|
Parses a length. Lengths are followed by an unit identifier (e.g. 10px, 3.1em)
|
|
</summary>
|
|
<param name="length">Specified length</param>
|
|
<param name="hundredPercent">Equivalent to 100 percent when length is percentage</param>
|
|
<param name="box"></param>
|
|
<param name="defaultUnit"></param>
|
|
<returns>the parsed length value with adjustments</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.ParseLength(System.String,System.Double,System.Double,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Parses a length. Lengths are followed by an unit identifier (e.g. 10px, 3.1em)
|
|
</summary>
|
|
<param name="length">Specified length</param>
|
|
<param name="hundredPercent">Equivalent to 100 percent when length is percentage</param>
|
|
<param name="emFactor"></param>
|
|
<param name="defaultUnit"></param>
|
|
<param name="fontAdjust">if the length is in pixels and the length is font related it needs to use 72/96 factor</param>
|
|
<param name="returnPoints">Allows the return double to be in points. If false, result will be pixels</param>
|
|
<returns>the parsed length value with adjustments</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.GetUnit(System.String,System.String,System.Boolean@)">
|
|
<summary>
|
|
Get the unit to use for the length, use default if no unit found in length string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.IsColorValid(System.String)">
|
|
<summary>
|
|
Check if the given color string value is valid.
|
|
</summary>
|
|
<param name="colorValue">color string value to parse</param>
|
|
<returns>true - valid, false - invalid</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.GetActualColor(System.String)">
|
|
<summary>
|
|
Parses a color value in CSS style; e.g. #ff0000, red, rgb(255,0,0), rgb(100%, 0, 0)
|
|
</summary>
|
|
<param name="colorValue">color string value to parse</param>
|
|
<returns>Color value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.TryGetColor(System.String,System.Int32,System.Int32,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor@)">
|
|
<summary>
|
|
Parses a color value in CSS style; e.g. #ff0000, RED, RGB(255,0,0), RGB(100%, 0, 0)
|
|
</summary>
|
|
<param name="str">color substring value to parse</param>
|
|
<param name="idx">substring start idx </param>
|
|
<param name="length">substring length</param>
|
|
<param name="color">return the parsed color</param>
|
|
<returns>true - valid color, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.GetActualBorderWidth(System.String,TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties)">
|
|
<summary>
|
|
Parses a border value in CSS style; e.g. 1px, 1, thin, thick, medium
|
|
</summary>
|
|
<param name="borderValue"></param>
|
|
<param name="b"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.GetColorByHex(System.String,System.Int32,System.Int32,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor@)">
|
|
<summary>
|
|
Get color by parsing given hex value color string (#A28B34).
|
|
</summary>
|
|
<returns>true - valid color, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.GetColorByRgb(System.String,System.Int32,System.Int32,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor@)">
|
|
<summary>
|
|
Get color by parsing given RGB value color string (RGB(255,180,90))
|
|
</summary>
|
|
<returns>true - valid color, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.GetColorByRgba(System.String,System.Int32,System.Int32,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor@)">
|
|
<summary>
|
|
Get color by parsing given RGBA value color string (RGBA(255,180,90,180))
|
|
</summary>
|
|
<returns>true - valid color, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.GetColorByName(System.String,System.Int32,System.Int32,TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor@)">
|
|
<summary>
|
|
Get color by given name, including .NET name.
|
|
</summary>
|
|
<returns>true - valid color, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.ParseIntAtIndex(System.String,System.Int32@)">
|
|
<summary>
|
|
Parse the given decimal number string to positive int value.<br/>
|
|
Start at given <paramref name="startIdx"/>, ignore whitespaces and take
|
|
as many digits as possible to parse to int.
|
|
</summary>
|
|
<param name="str">the string to parse</param>
|
|
<param name="startIdx">the index to start parsing at</param>
|
|
<returns>parsed int or 0</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.ParseInt(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Parse the given decimal number string to positive int value.
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>int value, -1 if not valid</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.CssValueParser.ParseHexInt(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Parse the given hex number string to positive int value.
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>int value, -1 if not valid</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser">
|
|
<summary>
|
|
Handle css DOM tree generation from raw html and stylesheet.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser._cssParser">
|
|
<summary>
|
|
Parser for CSS
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.#ctor(TheArtOfDev.HtmlRenderer.Core.Parse.CssParser)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.GenerateCssTree(System.String,TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Core.CssData@)">
|
|
<summary>
|
|
Generate css tree by parsing the given html and applying the given css style data on it.
|
|
</summary>
|
|
<param name="html">the html to parse</param>
|
|
<param name="htmlContainer">the html container to use for reference resolve</param>
|
|
<param name="cssData">the css data to use</param>
|
|
<returns>the root of the generated tree</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CascadeParseStyles(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Core.CssData@,System.Boolean@)">
|
|
<summary>
|
|
Read styles defined inside the dom structure in links and style elements.<br/>
|
|
If the html tag is "style" tag parse it content and add to the css data for all future tags parsing.<br/>
|
|
If the html tag is "link" that point to style data parse it content and add to the css data for all future tags parsing.<br/>
|
|
</summary>
|
|
<param name="box">the box to parse style data in</param>
|
|
<param name="htmlContainer">the html container to use for reference resolve</param>
|
|
<param name="cssData">the style data to fill with found styles</param>
|
|
<param name="cssDataChanged">check if the css data has been modified by the handled html not to change the base css data</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CascadeApplyStyles(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.CssData)">
|
|
<summary>
|
|
Applies style to all boxes in the tree.<br/>
|
|
If the html tag has style defined for each apply that style to the css box of the tag.<br/>
|
|
If the html tag has "class" attribute and the class name has style defined apply that style on the tag css box.<br/>
|
|
If the html tag has "style" attribute parse it and apply the parsed style on the tag css box.<br/>
|
|
</summary>
|
|
<param name="box">the box to apply the style to</param>
|
|
<param name="cssData">the style data for the html</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.SetTextSelectionStyle(TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Core.CssData)">
|
|
<summary>
|
|
Set the selected text style (selection text color and background color).
|
|
</summary>
|
|
<param name="htmlContainer"> </param>
|
|
<param name="cssData">the style data</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.AssignClassCssBlocks(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.CssData)">
|
|
<summary>
|
|
Assigns the given css classes to the given css box checking if matching.<br/>
|
|
Support multiple classes in single attribute separated by whitespace.
|
|
</summary>
|
|
<param name="box">the css box to assign css to</param>
|
|
<param name="cssData">the css data to use to get the matching css blocks</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.AssignCssBlocks(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.CssData,System.String)">
|
|
<summary>
|
|
Assigns the given css style blocks to the given css box checking if matching.
|
|
</summary>
|
|
<param name="box">the css box to assign css to</param>
|
|
<param name="cssData">the css data to use to get the matching css blocks</param>
|
|
<param name="className">the class selector to search for css blocks</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.IsBlockAssignableToBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Check if the given css block is assignable to the given css box.<br/>
|
|
the block is assignable if it has no hierarchical selectors or if the hierarchy matches.<br/>
|
|
Special handling for ":hover" pseudo-class.<br/>
|
|
</summary>
|
|
<param name="box">the box to check assign to</param>
|
|
<param name="block">the block to check assign of</param>
|
|
<returns>true - the block is assignable to the box, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.IsBlockAssignableToBoxWithSelector(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Check if the given css block is assignable to the given css box by validating the selector.<br/>
|
|
</summary>
|
|
<param name="box">the box to check assign to</param>
|
|
<param name="block">the block to check assign of</param>
|
|
<returns>true - the block is assignable to the box, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.AssignCssBlock(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.CssBlock)">
|
|
<summary>
|
|
Assigns the given css style block properties to the given css box.
|
|
</summary>
|
|
<param name="box">the css box to assign css to</param>
|
|
<param name="block">the css block to assign</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.IsStyleOnElementAllowed(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String,System.String)">
|
|
<summary>
|
|
Check if the given style is allowed to be set on the given css box.<br/>
|
|
Used to prevent invalid CssBoxes creation like table with inline display style.
|
|
</summary>
|
|
<param name="box">the css box to assign css to</param>
|
|
<param name="key">the style key to cehck</param>
|
|
<param name="value">the style value to check</param>
|
|
<returns>true - style allowed, false - not allowed</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CloneCssData(TheArtOfDev.HtmlRenderer.Core.CssData@,System.Boolean@)">
|
|
<summary>
|
|
Clone css data if it has not already been cloned.<br/>
|
|
Used to preserve the base css data used when changed by style inside html.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.TranslateAttributes(TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="tag"></param>
|
|
<param name="box"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.TranslateLength(System.String)">
|
|
<summary>
|
|
Converts an HTML length into a Css length
|
|
</summary>
|
|
<param name="htmlLength"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.ApplyTableBorder(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String)">
|
|
<summary>
|
|
Cascades to the TD's the border spacified in the TABLE tag.
|
|
</summary>
|
|
<param name="table"></param>
|
|
<param name="border"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.ApplyTablePadding(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String)">
|
|
<summary>
|
|
Cascades to the TD's the border spacified in the TABLE tag.
|
|
</summary>
|
|
<param name="table"></param>
|
|
<param name="padding"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.SetForAllCells(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Utils.ActionInt{TheArtOfDev.HtmlRenderer.Core.Dom.CssBox})">
|
|
<summary>
|
|
Execute action on all the "td" cells of the table.<br/>
|
|
Handle if there is "theader" or "tbody" exists.
|
|
</summary>
|
|
<param name="table">the table element</param>
|
|
<param name="action">the action to execute</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CorrectTextBoxes(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Go over all the text boxes (boxes that have some text that will be rendered) and
|
|
remove all boxes that have only white-spaces but are not 'preformatted' so they do not effect
|
|
the rendered html.
|
|
</summary>
|
|
<param name="box">the current box to correct its sub-tree</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CorrectImgBoxes(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Go over all image boxes and if its display style is set to block, put it inside another block but set the image to inline.
|
|
</summary>
|
|
<param name="box">the current box to correct its sub-tree</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CorrectLineBreaksBlocks(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Boolean@)">
|
|
<summary>
|
|
Correct the DOM tree recursively by replacing "br" html boxes with anonymous blocks that respect br spec.<br/>
|
|
If the "br" tag is after inline box then the anon block will have zero height only acting as newline,
|
|
but if it is after block box then it will have min-height of the font size so it will create empty line.
|
|
</summary>
|
|
<param name="box">the current box to correct its sub-tree</param>
|
|
<param name="followingBlock">used to know if the br is following a box so it should create an empty line or not so it only
|
|
move to a new line</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CorrectBlockInsideInline(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Correct DOM tree if there is block boxes that are inside inline blocks.<br/>
|
|
Need to rearrange the tree so block box will be only the child of other block box.
|
|
</summary>
|
|
<param name="box">the current box to correct its sub-tree</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CorrectBlockInsideInlineImp(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Rearrange the DOM of the box to have block box with boxes before the inner block box and after.
|
|
</summary>
|
|
<param name="box">the box that has the problem</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CorrectBlockSplitBadBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Split bad box that has inline and block boxes into two parts, the left - before the block box
|
|
and right - after the block box.
|
|
</summary>
|
|
<param name="parentBox">the parent box that has the problem</param>
|
|
<param name="badBox">the box to split into different boxes</param>
|
|
<param name="leftBlock">the left block box that is created for the split</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.CorrectInlineBoxesParent(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Makes block boxes be among only block boxes and all inline boxes have block parent box.<br/>
|
|
Inline boxes should live in a pool of Inline boxes only so they will define a single block.<br/>
|
|
At the end of this process a block box will have only block siblings and inline box will have
|
|
only inline siblings.
|
|
</summary>
|
|
<param name="box">the current box to correct its sub-tree</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.ContainsInlinesOnlyDeep(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Check if the given box contains only inline child boxes in all subtree.
|
|
</summary>
|
|
<param name="box">the box to check</param>
|
|
<returns>true - only inline child boxes, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.DomParser.ContainsVariantBoxes(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Check if the given box contains inline and block child boxes.
|
|
</summary>
|
|
<param name="box">the box to check</param>
|
|
<returns>true - has variant child boxes, false - otherwise</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Parse.HtmlParser">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.HtmlParser.ParseDocument(System.String)">
|
|
<summary>
|
|
Parses the source html to css boxes tree structure.
|
|
</summary>
|
|
<param name="source">the html source to parse</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.HtmlParser.AddTextBox(System.String,System.Int32,System.Int32,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox@)">
|
|
<summary>
|
|
Add html text anon box to the current box, this box will have the rendered text<br/>
|
|
Adding box also for text that contains only whitespaces because we don't know yet if
|
|
the box is preformatted. At later stage they will be removed if not relevant.
|
|
</summary>
|
|
<param name="source">the html source to parse</param>
|
|
<param name="startIdx">the start of the html part</param>
|
|
<param name="tagIdx">the index of the next html tag</param>
|
|
<param name="curBox">the current box in html tree parsing</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.HtmlParser.ParseHtmlTag(System.String,System.Int32,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox@)">
|
|
<summary>
|
|
Parse the html part, the part from prev parsing index to the beginning of the next html tag.<br/>
|
|
</summary>
|
|
<param name="source">the html source to parse</param>
|
|
<param name="tagIdx">the index of the next html tag</param>
|
|
<param name="curBox">the current box in html tree parsing</param>
|
|
<returns>the end of the parsed part, the new start index</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.HtmlParser.ParseHtmlTag(System.String,System.Int32,System.Int32,System.String@,System.Collections.Generic.Dictionary{System.String,System.String}@)">
|
|
<summary>
|
|
Parse raw html tag source to <seealso cref="T:TheArtOfDev.HtmlRenderer.Core.Dom.HtmlTag"/> object.<br/>
|
|
Extract attributes found on the tag.
|
|
</summary>
|
|
<param name="source">the html source to parse</param>
|
|
<param name="idx">the start index of the tag in the source</param>
|
|
<param name="length">the length of the tag from the start index in the source</param>
|
|
<param name="name">return the name of the html tag</param>
|
|
<param name="attributes">return the dictionary of tag attributes</param>
|
|
<returns>true - the tag is closing tag, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.HtmlParser.ExtractAttributes(System.String,System.Int32,System.Int32,System.Collections.Generic.Dictionary{System.String,System.String}@)">
|
|
<summary>
|
|
Extract html tag attributes from the given sub-string.
|
|
</summary>
|
|
<param name="source">the html source to parse</param>
|
|
<param name="idx">the start index of the tag attributes in the source</param>
|
|
<param name="length">the length of the tag attributes from the start index in the source</param>
|
|
<param name="attributes">return the dictionary of tag attributes</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils">
|
|
<summary>
|
|
Collection of regular expressions used when parsing
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssMediaTypes">
|
|
<summary>
|
|
Extracts the media types from a media at-rule; e.g. @media print, 3d, screen {
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssBlocks">
|
|
<summary>
|
|
Extracts defined blocks in CSS.
|
|
WARNING: Blocks will include blocks inside at-rules.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssNumber">
|
|
<summary>
|
|
Extracts a number; e.g. 5, 6, 7.5, 0.9
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssPercentage">
|
|
<summary>
|
|
Extracts css percentages from the string; e.g. 100% .5% 5.4%
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssLength">
|
|
<summary>
|
|
Extracts CSS lengths; e.g. 9px 3pt .89em
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssLineHeight">
|
|
<summary>
|
|
Extracts line-height values (normal, numbers, lengths, percentages)
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssFontFamily">
|
|
<summary>
|
|
Extracts font-family values
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssFontStyle">
|
|
<summary>
|
|
Extracts CSS font-styles; e.g. normal italic oblique
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssFontVariant">
|
|
<summary>
|
|
Extracts CSS font-variant values; e.g. normal, small-caps
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssFontWeight">
|
|
<summary>
|
|
Extracts font-weight values; e.g. normal, bold, bolder...
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssFontSize">
|
|
<summary>
|
|
Exracts font sizes: xx-small, larger, small, 34pt, 30%, 2em
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.CssFontSizeAndLineHeight">
|
|
<summary>
|
|
Gets the font-size[/line-height]? on the font shorthand property.
|
|
Check http://www.w3.org/TR/CSS21/fonts.html#font-shorthand
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils._regexes">
|
|
<summary>
|
|
the regexes cache that is used by the parser so not to create regex each time
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.GetCssAtRules(System.String,System.Int32@)">
|
|
<summary>
|
|
Get CSS at rule from the given stylesheet.
|
|
</summary>
|
|
<param name="stylesheet">the stylesheet data to retrieve the rule from</param>
|
|
<param name="startIdx">the index to start the search for the rule, on return will be the value of the end of the found rule</param>
|
|
<returns>the found at rule or null if not exists</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.Match(System.String,System.String)">
|
|
<summary>
|
|
Extracts matches from the specified source
|
|
</summary>
|
|
<param name="regex">Regular expression to extract matches</param>
|
|
<param name="source">Source to extract matches</param>
|
|
<returns>Collection of matches</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.Search(System.String,System.String)">
|
|
<summary>
|
|
Searches the specified regex on the source
|
|
</summary>
|
|
<param name="regex"></param>
|
|
<param name="source"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.Search(System.String,System.String,System.Int32@)">
|
|
<summary>
|
|
Searches the specified regex on the source
|
|
</summary>
|
|
<param name="regex"></param>
|
|
<param name="source"></param>
|
|
<param name="position"> </param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Parse.RegexParserUtils.GetRegex(System.String)">
|
|
<summary>
|
|
Get regex instance for the given regex string.
|
|
</summary>
|
|
<param name="regex">the regex string to use</param>
|
|
<returns>the regex instance</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.ArgChecker">
|
|
<summary>
|
|
Static class that contains argument-checking methods
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.ArgChecker.AssertIsTrue``1(System.Boolean,System.String)">
|
|
<summary>
|
|
Validate given <see cref="!:condition"/> is true, otherwise throw exception.
|
|
</summary>
|
|
<typeparam name="TException">Exception type to throw.</typeparam>
|
|
<param name="condition">Condition to assert.</param>
|
|
<param name="message">Exception message in-case of assert failure.</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.ArgChecker.AssertArgNotNull(System.Object,System.String)">
|
|
<summary>
|
|
Validate given argument isn't Null.
|
|
</summary>
|
|
<param name="arg">argument to validate</param>
|
|
<param name="argName">Name of the argument checked</param>
|
|
<exception cref="T:System.ArgumentNullException">if <paramref name="arg"/> is Null</exception>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.ArgChecker.AssertArgNotNull(System.IntPtr,System.String)">
|
|
<summary>
|
|
Validate given argument isn't <see cref="F:System.IntPtr.Zero"/>.
|
|
</summary>
|
|
<param name="arg">argument to validate</param>
|
|
<param name="argName">Name of the argument checked</param>
|
|
<exception cref="T:System.ArgumentNullException">if <paramref name="arg"/> is <see cref="F:System.IntPtr.Zero"/></exception>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.ArgChecker.AssertArgNotNullOrEmpty(System.String,System.String)">
|
|
<summary>
|
|
Validate given argument isn't Null or empty.
|
|
</summary>
|
|
<param name="arg">argument to validate</param>
|
|
<param name="argName">Name of the argument checked</param>
|
|
<exception cref="T:System.ArgumentNullException">if <paramref name="arg"/> is Null or empty</exception>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.ArgChecker.AssertArgOfType``1(System.Object,System.String)">
|
|
<summary>
|
|
Validate given argument isn't Null.
|
|
</summary>
|
|
<typeparam name="T">Type expected of <see cref="!:arg"/></typeparam>
|
|
<param name="arg">argument to validate</param>
|
|
<param name="argName">Name of the argument checked</param>
|
|
<exception cref="T:System.ArgumentNullException">if <paramref name="arg"/> is Null</exception>
|
|
<returns><see cref="!:arg"/> cast as <see cref="!:T"/></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.ArgChecker.AssertFileExist(System.String,System.String)">
|
|
<summary>
|
|
Validate given argument isn't Null or empty AND argument value is the path of existing file.
|
|
</summary>
|
|
<param name="arg">argument to validate</param>
|
|
<param name="argName">Name of the argument checked</param>
|
|
<exception cref="T:System.ArgumentNullException">if <paramref name="arg"/> is Null or empty</exception>
|
|
<exception cref="T:System.IO.FileNotFoundException">if <see cref="!:arg"/> file-path not exist</exception>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils">
|
|
<summary>
|
|
Utility methods for general stuff.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils._romanDigitsTable">
|
|
<summary>
|
|
Table to convert numbers into roman digits
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils._tempPath">
|
|
<summary>
|
|
the temp path to use for local files
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.IsAsianCharecter(System.Char)">
|
|
<summary>
|
|
Check if the given char is of Asian range.
|
|
</summary>
|
|
<param name="ch">the character to check</param>
|
|
<returns>true - Asian char, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.IsDigit(System.Char,System.Boolean)">
|
|
<summary>
|
|
Check if the given char is a digit character (0-9) and (0-9, a-f for HEX)
|
|
</summary>
|
|
<param name="ch">the character to check</param>
|
|
<param name="hex">optional: is hex digit check</param>
|
|
<returns>true - is digit, false - not a digit</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.ToDigit(System.Char,System.Boolean)">
|
|
<summary>
|
|
Convert the given char to digit.
|
|
</summary>
|
|
<param name="ch">the character to check</param>
|
|
<param name="hex">optional: is hex digit check</param>
|
|
<returns>true - is digit, false - not a digit</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.Max(TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize,TheArtOfDev.HtmlRenderer.Adapters.Entities.RSize)">
|
|
<summary>
|
|
Get size that is max of <paramref name="size"/> and <paramref name="other"/> for width and height separately.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.TryGetUri(System.String)">
|
|
<summary>
|
|
Get Uri object for the given path if it is valid uri path.
|
|
</summary>
|
|
<param name="path">the path to get uri for</param>
|
|
<returns>uri or null if not valid</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.GetFirstValueOrDefault``2(System.Collections.Generic.IDictionary{``0,``1},``1)">
|
|
<summary>
|
|
Get the first value in the given dictionary.
|
|
</summary>
|
|
<typeparam name="TKey">the type of dictionary key</typeparam>
|
|
<typeparam name="TValue">the type of dictionary value</typeparam>
|
|
<param name="dic">the dictionary</param>
|
|
<param name="defaultValue">optional: the default value to return of no elements found in dictionary </param>
|
|
<returns>first element or default value</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.TryGetFileInfo(System.String)">
|
|
<summary>
|
|
Get file info object for the given path if it is valid file path.
|
|
</summary>
|
|
<param name="path">the path to get file info for</param>
|
|
<returns>file info or null if not valid</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.GetResponseContentType(System.Net.WebClient)">
|
|
<summary>
|
|
Get web client response content type.
|
|
</summary>
|
|
<param name="client">the web client to get the response content type from</param>
|
|
<returns>response content type or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.GetLocalfileName(System.Uri)">
|
|
<summary>
|
|
Gets the representation of the online uri on the local disk.
|
|
</summary>
|
|
<param name="imageUri">The online image uri.</param>
|
|
<returns>The path of the file on the disk.</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.GetNextSubString(System.String,System.Int32,System.Int32@)">
|
|
<summary>
|
|
Get substring separated by whitespace starting from the given idex.
|
|
</summary>
|
|
<param name="str">the string to get substring in</param>
|
|
<param name="idx">the index to start substring search from</param>
|
|
<param name="length">return the length of the found string</param>
|
|
<returns>the index of the substring, -1 if no valid sub-string found</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.SubStringEquals(System.String,System.Int32,System.Int32,System.String)">
|
|
<summary>
|
|
Compare that the substring of <paramref name="str"/> is equal to <paramref name="str2"/>
|
|
Assume given substring is not empty and all indexes are valid!<br/>
|
|
</summary>
|
|
<returns>true - equals, false - not equals</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.GetValidFileName(System.String)">
|
|
<summary>
|
|
Replaces invalid filename chars to '_'
|
|
</summary>
|
|
<param name="source">The possibly-not-valid filename</param>
|
|
<returns>A valid filename.</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.ConvertToAlphaNumber(System.Int32,System.String)">
|
|
<summary>
|
|
Convert number to alpha numeric system by the requested style (UpperAlpha, LowerRoman, Hebrew, etc.).
|
|
</summary>
|
|
<param name="number">the number to convert</param>
|
|
<param name="style">the css style to convert by</param>
|
|
<returns>converted string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.ConvertToEnglishNumber(System.Int32,System.Boolean)">
|
|
<summary>
|
|
Convert the given integer into alphabetic numeric format (D, AU, etc.)
|
|
</summary>
|
|
<param name="number">the number to convert</param>
|
|
<param name="lowercase">is to use lowercase</param>
|
|
<returns>the roman number string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.ConvertToGreekNumber(System.Int32)">
|
|
<summary>
|
|
Convert the given integer into alphabetic numeric format (alpha, AU, etc.)
|
|
</summary>
|
|
<param name="number">the number to convert</param>
|
|
<returns>the roman number string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.ConvertToRomanNumbers(System.Int32,System.Boolean)">
|
|
<summary>
|
|
Convert the given integer into roman numeric format (II, VI, IX, etc.)
|
|
</summary>
|
|
<param name="number">the number to convert</param>
|
|
<param name="lowercase">if to use lowercase letters for roman digits</param>
|
|
<returns>the roman number string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.ConvertToSpecificNumbers(System.Int32,System.String[0:,0:])">
|
|
<summary>
|
|
Convert the given integer into given alphabet numeric system.
|
|
</summary>
|
|
<param name="number">the number to convert</param>
|
|
<param name="alphabet">the alphabet system to use</param>
|
|
<returns>the number string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CommonUtils.ConvertToSpecificNumbers2(System.Int32,System.String[])">
|
|
<summary>
|
|
Convert the given integer into given alphabet numeric system.
|
|
</summary>
|
|
<param name="number">the number to convert</param>
|
|
<param name="alphabet">the alphabet system to use</param>
|
|
<returns>the number string</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants">
|
|
<summary>
|
|
String constants to avoid typing errors.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.Cm">
|
|
<summary>
|
|
Centimeters
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.Mm">
|
|
<summary>
|
|
Millimeters
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.Px">
|
|
<summary>
|
|
Pixels
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.In">
|
|
<summary>
|
|
Inches
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.Em">
|
|
<summary>
|
|
Em - The font size of the relevant font
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.Ex">
|
|
<summary>
|
|
The 'x-height' of the relevan font
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.Pt">
|
|
<summary>
|
|
Points
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.Pc">
|
|
<summary>
|
|
Picas
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.FontSize">
|
|
<summary>
|
|
Default font size in points. Change this value to modify the default font size.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssConstants.DefaultFont">
|
|
<summary>
|
|
Default font used for the generic 'serif' family
|
|
</summary>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.CssUtils">
|
|
<summary>
|
|
Utility method for handling CSS stuff.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.CssUtils._defaultSelectionBackcolor">
|
|
<summary>
|
|
Brush for selection background
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Utils.CssUtils.DefaultSelectionBackcolor">
|
|
<summary>
|
|
Brush for selection background
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CssUtils.WhiteSpace(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBoxProperties)">
|
|
<summary>
|
|
Gets the white space width of the specified box
|
|
</summary>
|
|
<param name="g"></param>
|
|
<param name="box"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CssUtils.GetPropertyValue(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String)">
|
|
<summary>
|
|
Get CSS box property value by the CSS name.<br/>
|
|
Used as a mapping between CSS property and the class property.
|
|
</summary>
|
|
<param name="cssBox">the CSS box to get it's property value</param>
|
|
<param name="propName">the name of the CSS property</param>
|
|
<returns>the value of the property, null if no such property exists</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.CssUtils.SetPropertyValue(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String,System.String)">
|
|
<summary>
|
|
Set CSS box property value by the CSS name.<br/>
|
|
Used as a mapping between CSS property and the class property.
|
|
</summary>
|
|
<param name="cssBox">the CSS box to set it's property value</param>
|
|
<param name="propName">the name of the CSS property</param>
|
|
<param name="value">the value to set</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils">
|
|
<summary>
|
|
Utility class for traversing DOM structure and execution stuff on it.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.IsInBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Check if the given location is inside the given box deep.<br/>
|
|
Check inner boxes and all lines that the given box spans to.
|
|
</summary>
|
|
<param name="box">the box to check</param>
|
|
<param name="location">the location to check</param>
|
|
<returns>true - location inside the box, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.ContainsInlinesOnly(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Check if the given box contains only inline child boxes.
|
|
</summary>
|
|
<param name="box">the box to check</param>
|
|
<returns>true - only inline child boxes, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.FindParent(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Recursively searches for the parent with the specified HTML Tag name
|
|
</summary>
|
|
<param name="root"></param>
|
|
<param name="tagName"></param>
|
|
<param name="box"></param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetPreviousSibling(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the previous sibling of this box.
|
|
</summary>
|
|
<returns>Box before this one on the tree. Null if its the first</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetPreviousContainingBlockSibling(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the previous sibling of this box.
|
|
</summary>
|
|
<returns>Box before this one on the tree. Null if its the first</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.IsBoxHasWhitespace(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
fix word space for first word in inline tag.
|
|
</summary>
|
|
<param name="box">the box to check</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetNextSibling(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Gets the next sibling of this box.
|
|
</summary>
|
|
<returns>Box before this one on the tree. Null if its the first</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetAttribute(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String)">
|
|
<summary>
|
|
Get attribute value by given key starting search from given box, search up the tree until
|
|
attribute found or root.
|
|
</summary>
|
|
<param name="box">the box to start lookup at</param>
|
|
<param name="attribute">the attribute to get</param>
|
|
<returns>the value of the attribute or null if not found</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetCssBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint,System.Boolean)">
|
|
<summary>
|
|
Get css box under the given sub-tree at the given x,y location, get the inner most.<br/>
|
|
the location must be in correct scroll offset.
|
|
</summary>
|
|
<param name="box">the box to start search from</param>
|
|
<param name="location">the location to find the box by</param>
|
|
<param name="visible">Optional: if to get only visible boxes (default - true)</param>
|
|
<returns>css link box if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetAllLinkBoxes(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Collections.Generic.List{TheArtOfDev.HtmlRenderer.Core.Dom.CssBox})">
|
|
<summary>
|
|
Collect all link boxes found in the HTML tree.
|
|
</summary>
|
|
<param name="box">the box to start search from</param>
|
|
<param name="linkBoxes">collection to add all link boxes to</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetLinkBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Get css link box under the given sub-tree at the given x,y location.<br/>
|
|
the location must be in correct scroll offset.
|
|
</summary>
|
|
<param name="box">the box to start search from</param>
|
|
<param name="location">the location to find the box by</param>
|
|
<returns>css link box if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetBoxById(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.String)">
|
|
<summary>
|
|
Get css box under the given sub-tree with the given id.<br/>
|
|
</summary>
|
|
<param name="box">the box to start search from</param>
|
|
<param name="id">the id to find the box by</param>
|
|
<returns>css box if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetCssLineBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Get css line box under the given sub-tree at the given y location or the nearest line from the top.<br/>
|
|
the location must be in correct scroll offset.
|
|
</summary>
|
|
<param name="box">the box to start search from</param>
|
|
<param name="location">the location to find the box at</param>
|
|
<returns>css word box if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetCssBoxWord(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Get css word box under the given sub-tree at the given x,y location.<br/>
|
|
the location must be in correct scroll offset.
|
|
</summary>
|
|
<param name="box">the box to start search from</param>
|
|
<param name="location">the location to find the box at</param>
|
|
<returns>css word box if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetCssBoxWord(TheArtOfDev.HtmlRenderer.Core.Dom.CssLineBox,TheArtOfDev.HtmlRenderer.Adapters.Entities.RPoint)">
|
|
<summary>
|
|
Get css word box under the given sub-tree at the given x,y location.<br/>
|
|
the location must be in correct scroll offset.
|
|
</summary>
|
|
<param name="lineBox">the line box to search in</param>
|
|
<param name="location">the location to find the box at</param>
|
|
<returns>css word box if exists or null</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetCssLineBoxByWord(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect)">
|
|
<summary>
|
|
Find the css line box that the given word is in.
|
|
</summary>
|
|
<param name="word">the word to search for it's line box</param>
|
|
<returns>line box that the word is in</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetSelectedPlainText(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Get selected plain text of the given html sub-tree.
|
|
</summary>
|
|
<param name="root">the DOM box to get selected text from its sub-tree</param>
|
|
<returns>the selected plain text string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GenerateHtml(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle,System.Boolean)">
|
|
<summary>
|
|
Generate html from the given DOM tree.<br/>
|
|
Generate all the style inside the html, in header or for every tag depending on <paramref name="styleGen"/> value.
|
|
</summary>
|
|
<param name="root">the box of the html generate html from</param>
|
|
<param name="styleGen">Optional: controls the way styles are generated when html is generated</param>
|
|
<param name="onlySelected">Optional: true - generate only selected html subset, false - generate all (default - false)</param>
|
|
<returns>generated html</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GenerateBoxTree(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Generate textual tree representation of the css boxes tree starting from the given root.<br/>
|
|
Used for debugging html parsing.
|
|
</summary>
|
|
<param name="root">the root to generate tree from</param>
|
|
<returns>generated tree</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetSelectedPlainText(System.Text.StringBuilder,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Get selected plain text of the given html sub-tree.<br/>
|
|
Append all the selected words.
|
|
</summary>
|
|
<param name="sb">the builder to append the selected text to</param>
|
|
<param name="box">the DOM box to get selected text from its sub-tree</param>
|
|
<returns>the index of the last word appended</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.CollectSelectedBoxes(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Collect the boxes that have at least one word down the hierarchy that is selected recursively.<br/>
|
|
</summary>
|
|
<param name="root">the box to check its sub-tree</param>
|
|
<returns>the collection to add the selected tags to</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.CollectSelectedBoxes(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Collections.Generic.Dictionary{TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Boolean},System.Collections.Generic.Dictionary{TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Boolean})">
|
|
<summary>
|
|
Collect the boxes that have at least one word down the hierarchy that is selected recursively.<br/>
|
|
Use <paramref name="maybeBoxes"/> to handle boxes that are between selected words but don't have selected word inside.<br/>
|
|
</summary>
|
|
<param name="box">the box to check its sub-tree</param>
|
|
<param name="selectedBoxes">the hash to add the selected boxes to</param>
|
|
<param name="maybeBoxes">used to handle boxes that are between selected words but don't have selected word inside</param>
|
|
<returns>is the current box is in selected sub-tree</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetSelectionRoot(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Collections.Generic.Dictionary{TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Boolean})">
|
|
<summary>
|
|
find the box the is the root of selected boxes (the first box to contain multiple selected boxes)
|
|
</summary>
|
|
<param name="root">the root of the boxes tree</param>
|
|
<param name="selectedBoxes">the selected boxes to find selection root in</param>
|
|
<returns>the box that is the root of selected boxes</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.ContainsNamedBox(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Check if the given box has a names child box (has html tag) recursively.
|
|
</summary>
|
|
<param name="box">the box to check</param>
|
|
<returns>true - in sub-tree there is a named box, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.WriteHtml(TheArtOfDev.HtmlRenderer.Core.Parse.CssParser,System.Text.StringBuilder,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle,System.Collections.Generic.Dictionary{TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Boolean},TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Write the given html DOM sub-tree into the given string builder.<br/>
|
|
If <paramref name="selectedBoxes"/> are given write html only from those tags.
|
|
</summary>
|
|
<param name="cssParser">used to parse CSS data</param>
|
|
<param name="sb">the string builder to write html into</param>
|
|
<param name="box">the html sub-tree to write</param>
|
|
<param name="styleGen">Controls the way styles are generated when html is generated</param>
|
|
<param name="selectedBoxes">Control if to generate only selected boxes, if given only boxes found in hash will be generated</param>
|
|
<param name="selectionRoot">the box the is the root of selected boxes (the first box to contain multiple selected boxes)</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.WriteHtmlTag(TheArtOfDev.HtmlRenderer.Core.Parse.CssParser,System.Text.StringBuilder,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,TheArtOfDev.HtmlRenderer.Core.Entities.HtmlGenerationStyle)">
|
|
<summary>
|
|
Write the given html tag with all its attributes and styles.
|
|
</summary>
|
|
<param name="cssParser">used to parse CSS data</param>
|
|
<param name="sb">the string builder to write html into</param>
|
|
<param name="box">the css box with the html tag to write</param>
|
|
<param name="styleGen">Controls the way styles are generated when html is generated</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.StripDefaultStyles(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Clean the given style collection by removing default styles so only custom styles remain.<br/>
|
|
Return new collection where the old remains unchanged.
|
|
</summary>
|
|
<param name="box">the box the styles apply to, used to know the default style</param>
|
|
<param name="tagStyles">the collection of styles to clean</param>
|
|
<returns>new cleaned styles collection</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.WriteStylesheet(System.Text.StringBuilder,TheArtOfDev.HtmlRenderer.Core.CssData)">
|
|
<summary>
|
|
Write stylesheet data inline into the html.
|
|
</summary>
|
|
<param name="sb">the string builder to write stylesheet into</param>
|
|
<param name="cssData">the css data to write to the head</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GetSelectedWord(TheArtOfDev.HtmlRenderer.Core.Dom.CssRect,System.Boolean)">
|
|
<summary>
|
|
Get the selected word with respect to partial selected words.
|
|
</summary>
|
|
<param name="rect">the word to append</param>
|
|
<param name="selectedText">is to get selected text or all the text in the word</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.DomUtils.GenerateBoxTree(TheArtOfDev.HtmlRenderer.Core.Dom.CssBox,System.Text.StringBuilder,System.Int32)">
|
|
<summary>
|
|
Generate textual tree representation of the css boxes tree starting from the given root.<br/>
|
|
Used for debugging html parsing.
|
|
</summary>
|
|
<param name="box">the box to generate for</param>
|
|
<param name="builder">the string builder to generate to</param>
|
|
<param name="indent">the current indent level to set indent of generated text</param>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlConstants">
|
|
<summary>
|
|
Defines HTML strings
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils._list">
|
|
<summary>
|
|
List of html tags that don't have content
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils._encodeDecode">
|
|
<summary>
|
|
the html encode\decode pairs
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils._decodeOnly">
|
|
<summary>
|
|
the html decode only pairs
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils.#cctor">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils.IsSingleTag(System.String)">
|
|
<summary>
|
|
Is the given html tag is single tag or can have content.
|
|
</summary>
|
|
<param name="tagName">the tag to check (must be lower case)</param>
|
|
<returns>true - is single tag, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils.DecodeHtml(System.String)">
|
|
<summary>
|
|
Decode html encoded string to regular string.<br/>
|
|
Handles <, >, "&.
|
|
</summary>
|
|
<param name="str">the string to decode</param>
|
|
<returns>decoded string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils.EncodeHtml(System.String)">
|
|
<summary>
|
|
Encode regular string into html encoded string.<br/>
|
|
Handles <, >, "&.
|
|
</summary>
|
|
<param name="str">the string to encode</param>
|
|
<returns>encoded string</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils.DecodeHtmlCharByCode(System.String)">
|
|
<summary>
|
|
Decode html special charecters encoded using char entity code (€)
|
|
</summary>
|
|
<param name="str">the string to decode</param>
|
|
<returns>decoded string</returns>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:TheArtOfDev.HtmlRenderer.Core.Utils.HtmlUtils.DecodeHtmlCharByName(System.String)" -->
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.RenderUtils">
|
|
<summary>
|
|
Provides some drawing functionality
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.RenderUtils.IsColorVisible(TheArtOfDev.HtmlRenderer.Adapters.Entities.RColor)">
|
|
<summary>
|
|
Check if the given color is visible if painted (has alpha and color values)
|
|
</summary>
|
|
<param name="color">the color to check</param>
|
|
<returns>true - visible, false - not visible</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.RenderUtils.ClipGraphicsByOverflow(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.Dom.CssBox)">
|
|
<summary>
|
|
Clip the region the graphics will draw on by the overflow style of the containing block.<br/>
|
|
Recursively travel up the tree to find containing block that has overflow style set to hidden. if not
|
|
block found there will be no clipping and null will be returned.
|
|
</summary>
|
|
<param name="g">the graphics to clip</param>
|
|
<param name="box">the box that is rendered to get containing blocks</param>
|
|
<returns>true - was clipped, false - not clipped</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.RenderUtils.DrawImageLoadingIcon(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draw image loading icon.
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="htmlContainer"></param>
|
|
<param name="r">the rectangle to draw icon in</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.RenderUtils.DrawImageErrorIcon(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Core.HtmlContainerInt,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect)">
|
|
<summary>
|
|
Draw image failed to load icon.
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="htmlContainer"></param>
|
|
<param name="r">the rectangle to draw icon in</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.RenderUtils.GetRoundRect(TheArtOfDev.HtmlRenderer.Adapters.RGraphics,TheArtOfDev.HtmlRenderer.Adapters.Entities.RRect,System.Double,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Creates a rounded rectangle using the specified corner radius<br/>
|
|
NW-----NE
|
|
| |
|
|
| |
|
|
SW-----SE
|
|
</summary>
|
|
<param name="g">the device to draw into</param>
|
|
<param name="rect">Rectangle to round</param>
|
|
<param name="nwRadius">Radius of the north east corner</param>
|
|
<param name="neRadius">Radius of the north west corner</param>
|
|
<param name="seRadius">Radius of the south east corner</param>
|
|
<param name="swRadius">Radius of the south west corner</param>
|
|
<returns>GraphicsPath with the lines of the rounded rectangle ready to be painted</returns>
|
|
</member>
|
|
<member name="T:TheArtOfDev.HtmlRenderer.Core.Utils.SubString">
|
|
<summary>
|
|
Represents sub-string of a full string starting at specific location with a specific length.
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.SubString._fullString">
|
|
<summary>
|
|
the full string that this sub-string is part of
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.SubString._startIdx">
|
|
<summary>
|
|
the start index of the sub-string
|
|
</summary>
|
|
</member>
|
|
<member name="F:TheArtOfDev.HtmlRenderer.Core.Utils.SubString._length">
|
|
<summary>
|
|
the length of the sub-string starting at <see cref="F:TheArtOfDev.HtmlRenderer.Core.Utils.SubString._startIdx"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.#ctor(System.String)">
|
|
<summary>
|
|
Init sub-string that is the full string.
|
|
</summary>
|
|
<param name="fullString">the full string that this sub-string is part of</param>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.#ctor(System.String,System.Int32,System.Int32)">
|
|
<summary>
|
|
Init.
|
|
</summary>
|
|
<param name="fullString">the full string that this sub-string is part of</param>
|
|
<param name="startIdx">the start index of the sub-string</param>
|
|
<param name="length">the length of the sub-string starting at <paramref name="startIdx"/></param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="fullString"/> is null</exception>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.FullString">
|
|
<summary>
|
|
the full string that this sub-string is part of
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.StartIdx">
|
|
<summary>
|
|
the start index of the sub-string
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.Length">
|
|
<summary>
|
|
the length of the sub-string starting at <see cref="F:TheArtOfDev.HtmlRenderer.Core.Utils.SubString._startIdx"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.Item(System.Int32)">
|
|
<summary>
|
|
Get string char at specific index.
|
|
</summary>
|
|
<param name="idx">the idx to get the char at</param>
|
|
<returns>char at index</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.IsEmpty">
|
|
<summary>
|
|
Is the sub-string is empty string.
|
|
</summary>
|
|
<returns>true - empty string, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.IsEmptyOrWhitespace">
|
|
<summary>
|
|
Is the sub-string is empty string or contains only whitespaces.
|
|
</summary>
|
|
<returns>true - empty or whitespace string, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.IsWhitespace">
|
|
<summary>
|
|
Is the sub-string contains only whitespaces (at least one).
|
|
</summary>
|
|
<returns>true - empty or whitespace string, false - otherwise</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.CutSubstring">
|
|
<summary>
|
|
Get a string of the sub-string.<br/>
|
|
This will create a new string object!
|
|
</summary>
|
|
<returns>new string that is the sub-string represented by this instance</returns>
|
|
</member>
|
|
<member name="M:TheArtOfDev.HtmlRenderer.Core.Utils.SubString.Substring(System.Int32,System.Int32)">
|
|
<summary>
|
|
Retrieves a substring from this instance. The substring starts at a specified character position and has a specified length.
|
|
</summary>
|
|
<param name="startIdx">The zero-based starting character position of a substring in this instance.</param>
|
|
<param name="length">The number of characters in the substring. </param>
|
|
<returns>A String equivalent to the substring of length length that begins at startIndex in this instance, or
|
|
Empty if startIndex is equal to the length of this instance and length is zero. </returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|