-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBunifu.UI.WinForms.BunifuLabel.xml
9096 lines (9082 loc) · 510 KB
/
Bunifu.UI.WinForms.BunifuLabel.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Bunifu.UI.WinForms.BunifuLabel</name>
</assembly>
<members>
<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.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.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.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.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.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.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.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.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>