Skip to content

Commit 5d08078

Browse files
committedFeb 10, 2020
WinForms - Update xml doc Dock = DockStyle.Fill is the default
Make it clear we are setting the default to DockStyle.Fill, this may not be expected by some. It has been that way for 5+ years, so changing the default would be difficult and unexpected, instead we make it clearer this is the case. Resolves cefsharp#3019
1 parent 3601c30 commit 5d08078

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed
 

‎CefSharp.WinForms/ChromiumWebBrowser.cs

+8-4
Original file line numberDiff line numberDiff line change
@@ -416,21 +416,25 @@ public ChromiumWebBrowser()
416416

417417
/// <summary>
418418
/// Initializes a new instance of the <see cref="ChromiumWebBrowser"/> class.
419+
/// **Important** - When using this constructor the <see cref="Control.Dock"/> property
420+
/// will default to <see cref="DockStyle.Fill"/>.
419421
/// </summary>
420422
/// <param name="html">html string to be initially loaded in the browser.</param>
421-
/// <param name="requestContext">Request context that will be used for this browser instance,
422-
/// if null the Global Request Context will be used</param>
423+
/// <param name="requestContext">(Optional) Request context that will be used for this browser instance, if null the Global
424+
/// Request Context will be used.</param>
423425
public ChromiumWebBrowser(HtmlString html, IRequestContext requestContext = null) : this(html.ToDataUriString(), requestContext)
424426
{
425427

426428
}
427429

428430
/// <summary>
429431
/// Initializes a new instance of the <see cref="ChromiumWebBrowser"/> class.
432+
/// **Important** - When using this constructor the <see cref="Control.Dock"/> property
433+
/// will default to <see cref="DockStyle.Fill"/>.
430434
/// </summary>
431435
/// <param name="address">The address.</param>
432-
/// <param name="requestContext">Request context that will be used for this browser instance,
433-
/// if null the Global Request Context will be used</param>
436+
/// <param name="requestContext">(Optional) Request context that will be used for this browser instance, if null the Global
437+
/// Request Context will be used.</param>
434438
public ChromiumWebBrowser(string address, IRequestContext requestContext = null)
435439
{
436440
Dock = DockStyle.Fill;

0 commit comments

Comments
 (0)
Please sign in to comment.