/// <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>
private static SizeF RenderHtml(Graphics g, string html, PointF location, SizeF maxSize, CssData cssData, bool useGdiPlusTextRendering, EventHandler <HtmlStylesheetLoadEventArgs> stylesheetLoad, EventHandler <HtmlImageLoadEventArgs> imageLoad)
{
SizeF actualSize = SizeF.Empty;
if (!string.IsNullOrEmpty(html))
{
using (var container = new HtmlContainer())
{
container.Location = location;
container.MaxSize = maxSize;
container.AvoidAsyncImagesLoading = true;
container.AvoidImagesLateLoading = true;
container.UseGdiPlusTextRendering = useGdiPlusTextRendering;
if (stylesheetLoad != null)
{
container.StylesheetLoad += stylesheetLoad;
}
if (imageLoad != null)
{
container.ImageLoad += imageLoad;
}
container.SetHtml(html, cssData);
container.PerformLayout(g);
container.PerformPaint(g);
actualSize = container.ActualSize;
}
}
return(actualSize);
}
/// <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 widht 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">optiona: the style to use for html rendering (default - use W3 default style)</param>
/// <param name="bridge">optional: used to resolve external references in html code (property and method calls)</param>
/// <returns>the actual size of the rendered html</returns>
public static SizeF Render(Graphics g, string html, PointF location, SizeF maxSize, CssData cssData = null, object bridge = null)
{
ArgChecker.AssertArgNotNull(g, "g");
SizeF actualSize = SizeF.Empty;
if (!string.IsNullOrEmpty(html))
{
Region prevClip = null;
if (maxSize.Height > 0)
{
prevClip = g.Clip;
g.SetClip(new RectangleF(location, maxSize));
}
var container = new HtmlContainer(html, bridge, cssData);
container.Location = location;
container.MaxSize = maxSize;
container.PerformLayout(g);
container.PerformPaint(g);
if (prevClip != null)
{
g.SetClip(prevClip, CombineMode.Replace);
}
actualSize = container.ActualSize;
}
return(actualSize);
}
private void OnToolTipDraw(object sender, DrawToolTipEventArgs e)
{
e.Graphics.Clear(Color.White);
if (_htmlContainer != null)
{
_htmlContainer.PerformPaint(e.Graphics);
}
}
/// <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"/> 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/>
/// 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="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="ArgumentOutOfRangeException">if <paramref name="backgroundColor"/> is <see cref="Color.Transparent"/></exception>.
public static Image RenderToImage(string html, Size minSize, Size maxSize, Color backgroundColor = new Color(), CssData cssData = null,
EventHandler <HtmlStylesheetLoadEventArgs> stylesheetLoad = null, EventHandler <HtmlImageLoadEventArgs> imageLoad = null)
{
if (backgroundColor == Color.Transparent)
{
throw new ArgumentOutOfRangeException("backgroundColor", "Transparent background in not supported");
}
if (string.IsNullOrEmpty(html))
{
return(new Bitmap(0, 0, PixelFormat.Format32bppArgb));
}
using (var container = new HtmlContainer())
{
container.AvoidAsyncImagesLoading = true;
container.AvoidImagesLateLoading = true;
if (stylesheetLoad != null)
{
container.StylesheetLoad += stylesheetLoad;
}
if (imageLoad != null)
{
container.ImageLoad += imageLoad;
}
container.SetHtml(html, cssData);
var finalSize = MeasureHtmlByRestrictions(container, minSize, maxSize);
container.MaxSize = finalSize;
// create the final image to render into by measured size
var image = new Bitmap(finalSize.Width, finalSize.Height, PixelFormat.Format32bppArgb);
// create memory buffer from desktop handle that supports alpha channel
IntPtr dib;
var memoryHdc = Win32Utils.CreateMemoryHdc(IntPtr.Zero, image.Width, image.Height, out dib);
try
{
// render HTML into the memory buffer
using (var memoryGraphics = Graphics.FromHdc(memoryHdc))
{
memoryGraphics.Clear(backgroundColor != Color.Empty ? backgroundColor : Color.White);
container.PerformPaint(memoryGraphics);
}
// copy from memory buffer to image
CopyBufferToImage(memoryHdc, image);
}
finally
{
Win32Utils.ReleaseMemoryHdc(memoryHdc, dib);
}
return(image);
}
}
/// <summary>
/// Perform paint of the html in the control.
/// </summary>
protected override void OnPaint(PaintEventArgs e)
{
base.OnPaint(e);
if (_htmlContainer != null)
{
e.Graphics.TextRenderingHint = TextRenderingHint.ClearTypeGridFit;
_htmlContainer.PerformPaint(e.Graphics);
}
}
/// <summary>
/// Perform paint of the html in the control.
/// </summary>
protected override void OnPaint(PaintEventArgs e)
{
base.OnPaint(e);
if (_htmlContainer != null)
{
_htmlContainer.ScrollOffset = AutoScrollPosition;
e.Graphics.TextRenderingHint = System.Drawing.Text.TextRenderingHint.ClearTypeGridFit;
_htmlContainer.PerformPaint(e.Graphics);
}
}
/// <summary>
/// Perform paint of the html in the control.
/// </summary>
protected override void OnPaint(PaintEventArgs e)
{
base.OnPaint(e);
if (_htmlContainer != null)
{
_htmlContainer.ScrollOffset = AutoScrollPosition;
_htmlContainer.PerformPaint(e.Graphics);
// call mouse move to handle paint after scroll or html change affecting mouse cursor.
var mp = PointToClient(MousePosition);
_htmlContainer.HandleMouseMove(this, new MouseEventArgs(MouseButtons.None, 0, mp.X, mp.Y, 0));
}
}
/// <summary>
/// Draw the html using the tooltip graphics.
/// </summary>
private void OnToolTipDraw(object sender, DrawToolTipEventArgs e)
{
if (_tooltipHandle == IntPtr.Zero)
{
// get the handle of the tooltip window using the graphics device context
var hdc = e.Graphics.GetHdc();
_tooltipHandle = Win32Utils.WindowFromDC(hdc);
e.Graphics.ReleaseHdc(hdc);
AdjustTooltipPosition(e.AssociatedControl, e.Bounds.Size);
}
e.Graphics.Clear(Color.White);
_htmlContainer.PerformPaint(e.Graphics);
}
/// <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 widht 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">optiona: 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>
public static SizeF Render(Graphics g, string html, PointF location, SizeF maxSize, CssData cssData, EventHandler <HtmlStylesheetLoadEventArgs> stylesheetLoad, EventHandler <HtmlImageLoadEventArgs> imageLoad)
{
ArgChecker.AssertArgNotNull(g, "g");
SizeF actualSize = SizeF.Empty;
if (!string.IsNullOrEmpty(html))
{
Region prevClip = null;
if (maxSize.Height > 0)
{
prevClip = g.Clip;
g.SetClip(new RectangleF(location, maxSize));
}
var container = new HtmlContainer();
if (stylesheetLoad != null)
{
container.StylesheetLoad += stylesheetLoad;
}
if (imageLoad != null)
{
container.ImageLoad += imageLoad;
}
container.SetHtml(html, cssData);
container.Location = location;
container.MaxSize = maxSize;
container.PerformLayout(g);
container.PerformPaint(g);
if (stylesheetLoad != null)
{
container.StylesheetLoad -= stylesheetLoad;
}
if (imageLoad != null)
{
container.ImageLoad -= imageLoad;
}
if (prevClip != null)
{
g.SetClip(prevClip, CombineMode.Replace);
}
actualSize = container.ActualSize;
}
return(actualSize);
}
/// <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"/> 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/>
/// 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="TextRenderingHint"/>.<br/>
/// See "Rendering to image" remarks section on <see cref="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>
public static Image RenderToImageGdiPlus(string html, Size minSize, Size maxSize, TextRenderingHint textRenderingHint = TextRenderingHint.SingleBitPerPixelGridFit, CssData cssData = null,
EventHandler <HtmlStylesheetLoadEventArgs> stylesheetLoad = null, EventHandler <HtmlImageLoadEventArgs> imageLoad = null)
{
if (string.IsNullOrEmpty(html))
{
return(new Bitmap(0, 0, PixelFormat.Format32bppArgb));
}
using (var container = new HtmlContainer())
{
container.AvoidAsyncImagesLoading = true;
container.AvoidImagesLateLoading = true;
container.UseGdiPlusTextRendering = true;
if (stylesheetLoad != null)
{
container.StylesheetLoad += stylesheetLoad;
}
if (imageLoad != null)
{
container.ImageLoad += imageLoad;
}
container.SetHtml(html, cssData);
var finalSize = MeasureHtmlByRestrictions(container, minSize, maxSize);
container.MaxSize = finalSize;
// create the final image to render into by measured size
var image = new Bitmap(finalSize.Width, finalSize.Height, PixelFormat.Format32bppArgb);
// render HTML into the image
using (var g = Graphics.FromImage(image))
{
g.TextRenderingHint = textRenderingHint;
container.PerformPaint(g);
}
return(image);
}
}
/// <summary>
/// Renders the specified HTML into 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/>
/// </summary>
/// <param name="html">HTML source to render</param>
/// <param name="maxWidth">the max width of the rendered html</param>
/// <param name="maxHeight">optional: the max height of the rendered html, if above zero it will be clipped</param>
/// <param name="cssData">optiona: 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>
public static Image RenderToImage(string html, int maxWidth, int maxHeight = 0, CssData cssData = null, EventHandler<HtmlStylesheetLoadEventArgs> stylesheetLoad = null, EventHandler<HtmlImageLoadEventArgs> imageLoad = null)
{
if (string.IsNullOrEmpty(html))
return new Bitmap(0, 0, PixelFormat.Format32bppArgb);
using (var htmlContainer = new HtmlContainer())
{
// use desktop created graphics to measure the HTML
using (var measureGraphics = Graphics.FromHwnd(IntPtr.Zero))
{
if (stylesheetLoad != null)
htmlContainer.StylesheetLoad += stylesheetLoad;
if (imageLoad != null)
htmlContainer.ImageLoad += imageLoad;
htmlContainer.SetHtml(html, cssData);
htmlContainer.PerformLayout(measureGraphics);
if (maxWidth > 0 && maxWidth < htmlContainer.ActualSize.Width)
{
// to allow the actual size be smaller than max we need to set max size only if it is really larger
htmlContainer.MaxSize = new SizeF(maxWidth, 0);
htmlContainer.PerformLayout(measureGraphics);
}
}
var size = new Size(maxWidth > 0 ? Math.Min(maxWidth, (int) htmlContainer.ActualSize.Width) : (int) htmlContainer.ActualSize.Width,
maxHeight > 0 ? Math.Min(maxHeight, (int) htmlContainer.ActualSize.Height) : (int) htmlContainer.ActualSize.Height);
// create the final image to render into by measured size
var image = new Bitmap(size.Width, size.Height, PixelFormat.Format32bppArgb);
// create memory buffer from desktop handle that supports alpha chanel
IntPtr dib;
var memoryHdc = Win32Utils.CreateMemoryHdc(IntPtr.Zero, image.Width, image.Height, out dib);
try
{
// render HTML into the memory buffer
using (var memoryGraphics = Graphics.FromHdc(memoryHdc))
{
memoryGraphics.Clear(Color.White);
htmlContainer.PerformPaint(memoryGraphics);
}
// copy from memory buffer to image
using (var imageGraphics = Graphics.FromImage(image))
{
var imgHdc = imageGraphics.GetHdc();
Win32Utils.BitBlt(imgHdc, 0, 0, image.Width, image.Height, memoryHdc, 0, 0, Win32Utils.BitBltCopy);
imageGraphics.ReleaseHdc(imgHdc);
}
}
finally
{
Win32Utils.ReleaseMemoryHdc(memoryHdc, dib);
}
return image;
}
}
/// <summary>
/// Renders the specified HTML into image of the requested size.<br/>
/// The HTML will be layout by the given size but will be clipped if cannot fit.
/// </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="cssData">optiona: 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>
public static Image RenderToImage(string html, Size size, CssData cssData = null, EventHandler<HtmlStylesheetLoadEventArgs> stylesheetLoad = null, EventHandler<HtmlImageLoadEventArgs> imageLoad = null)
{
// create the final image to render into
var image = new Bitmap(size.Width, size.Height, PixelFormat.Format32bppArgb);
if (!string.IsNullOrEmpty(html))
{
// create memory buffer from desktop handle that supports alpha chanel
IntPtr dib;
var memoryHdc = Win32Utils.CreateMemoryHdc(IntPtr.Zero, image.Width, image.Height, out dib);
try
{
// create memory buffer graphics to use for HTML rendering
using (var memoryGraphics = Graphics.FromHdc(memoryHdc))
{
memoryGraphics.Clear(Color.White);
// render HTML into the memory buffer
using (var htmlContainer = new HtmlContainer())
{
if (stylesheetLoad != null)
htmlContainer.StylesheetLoad += stylesheetLoad;
if (imageLoad != null)
htmlContainer.ImageLoad += imageLoad;
htmlContainer.SetHtml(html, cssData);
htmlContainer.MaxSize = size;
htmlContainer.PerformLayout(memoryGraphics);
htmlContainer.PerformPaint(memoryGraphics);
}
}
// copy from memory buffer to image
using (var imageGraphics = Graphics.FromImage(image))
{
var imgHdc = imageGraphics.GetHdc();
Win32Utils.BitBlt(imgHdc, 0, 0, image.Width, image.Height, memoryHdc, 0, 0, Win32Utils.BitBltCopy);
imageGraphics.ReleaseHdc(imgHdc);
}
}
finally
{
Win32Utils.ReleaseMemoryHdc(memoryHdc, dib);
}
}
return image;
}
/// <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 widht 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">optiona: 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>
public static SizeF Render(Graphics g, string html, PointF location, SizeF maxSize, CssData cssData, EventHandler<HtmlStylesheetLoadEventArgs> stylesheetLoad, EventHandler<HtmlImageLoadEventArgs> imageLoad)
{
ArgChecker.AssertArgNotNull(g, "g");
SizeF actualSize = SizeF.Empty;
if (!string.IsNullOrEmpty(html))
{
Region prevClip = null;
if (maxSize.Height > 0)
{
prevClip = g.Clip;
g.SetClip(new RectangleF(location, maxSize));
}
using (var container = new HtmlContainer())
{
if (stylesheetLoad != null)
container.StylesheetLoad += stylesheetLoad;
if (imageLoad != null)
container.ImageLoad += imageLoad;
container.SetHtml(html, cssData);
container.Location = location;
container.MaxSize = maxSize;
container.PerformLayout(g);
container.PerformPaint(g);
if (prevClip != null)
{
g.SetClip(prevClip, CombineMode.Replace);
}
actualSize = container.ActualSize;
}
}
return actualSize;
}
/// <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 widht 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">optiona: the style to use for html rendering (default - use W3 default style)</param>
/// <param name="bridge">optional: used to resolve external references in html code (property and method calls)</param>
/// <returns>the actual size of the rendered html</returns>
public static SizeF Render(Graphics g, string html, PointF location, SizeF maxSize, CssData cssData = null, object bridge = null)
{
ArgChecker.AssertArgNotNull(g, "g");
SizeF actualSize = SizeF.Empty;
if(!string.IsNullOrEmpty(html))
{
Region prevClip = null;
if (maxSize.Height > 0)
{
prevClip = g.Clip;
g.SetClip(new RectangleF(location, maxSize));
}
var container = new HtmlContainer(html, bridge, cssData);
container.Location = location;
container.MaxSize = maxSize;
container.PerformLayout(g);
container.PerformPaint(g);
if (prevClip != null)
{
g.SetClip(prevClip, CombineMode.Replace);
}
actualSize = container.ActualSize;
}
return actualSize;
}
