-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
WebBrowserProgressChangedEventArgs.xml
190 lines (171 loc) · 13.8 KB
/
WebBrowserProgressChangedEventArgs.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
<Type Name="WebBrowserProgressChangedEventArgs" FullName="System.Windows.Forms.WebBrowserProgressChangedEventArgs">
<TypeSignature Language="C#" Value="public class WebBrowserProgressChangedEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WebBrowserProgressChangedEventArgs extends System.EventArgs" />
<TypeSignature Language="DocId" Value="T:System.Windows.Forms.WebBrowserProgressChangedEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class WebBrowserProgressChangedEventArgs
Inherits EventArgs" />
<TypeSignature Language="F#" Value="type WebBrowserProgressChangedEventArgs = class
 inherit EventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class WebBrowserProgressChangedEventArgs : EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides data for the <see cref="E:System.Windows.Forms.WebBrowser.ProgressChanged" /> event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You can handle the <xref:System.Windows.Forms.WebBrowser.ProgressChanged?displayProperty=nameWithType> event to implement a navigation progress bar for the <xref:System.Windows.Forms.WebBrowser> control similar to the one in Internet Explorer. Use the <xref:System.Windows.Forms.WebBrowserProgressChangedEventArgs.CurrentProgress%2A> property to determine the number of bytes that have been downloaded successfully. Use the <xref:System.Windows.Forms.WebBrowserProgressChangedEventArgs.MaximumProgress%2A> property to determine the number of bytes available for downloading.
## Examples
The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.WebBrowser.ProgressChanged> event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing <xref:System.Windows.Forms.MessageBox.Show%2A> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of type <xref:System.Windows.Forms.WebBrowser> named `WebBrowser1`. Then ensure that the event handler is associated with the <xref:System.Windows.Forms.WebBrowser.ProgressChanged> event.
:::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet652":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet652":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Forms.ProgressBar" />
<altmember cref="T:System.Windows.Forms.WebBrowser" />
<altmember cref="E:System.Windows.Forms.WebBrowser.ProgressChanged" />
<altmember cref="T:System.Windows.Forms.WebBrowserProgressChangedEventHandler" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebBrowserProgressChangedEventArgs (long currentProgress, long maximumProgress);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 currentProgress, int64 maximumProgress) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Forms.WebBrowserProgressChangedEventArgs.#ctor(System.Int64,System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (currentProgress As Long, maximumProgress As Long)" />
<MemberSignature Language="F#" Value="new System.Windows.Forms.WebBrowserProgressChangedEventArgs : int64 * int64 -> System.Windows.Forms.WebBrowserProgressChangedEventArgs" Usage="new System.Windows.Forms.WebBrowserProgressChangedEventArgs (currentProgress, maximumProgress)" />
<MemberSignature Language="C++ CLI" Value="public:
 WebBrowserProgressChangedEventArgs(long currentProgress, long maximumProgress);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="currentProgress" Type="System.Int64" />
<Parameter Name="maximumProgress" Type="System.Int64" />
</Parameters>
<Docs>
<param name="currentProgress">The number of bytes that are loaded already.</param>
<param name="maximumProgress">The total number of bytes to be loaded.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Forms.WebBrowserProgressChangedEventArgs" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentProgress">
<MemberSignature Language="C#" Value="public long CurrentProgress { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 CurrentProgress" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.WebBrowserProgressChangedEventArgs.CurrentProgress" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CurrentProgress As Long" />
<MemberSignature Language="F#" Value="member this.CurrentProgress : int64" Usage="System.Windows.Forms.WebBrowserProgressChangedEventArgs.CurrentProgress" />
<MemberSignature Language="C++ CLI" Value="public:
 property long CurrentProgress { long get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the number of bytes that have been downloaded.</summary>
<value>The number of bytes that have been loaded or -1 to indicate that the download has completed.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You can use this property to display the current navigation progress in a <xref:System.Windows.Forms.ProgressBar> control. Use the <xref:System.Windows.Forms.WebBrowserProgressChangedEventArgs.MaximumProgress%2A> property to determine the total number of bytes available for downloading.
## Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.WebBrowser.ProgressChanged?displayProperty=nameWithType> event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing <xref:System.Windows.Forms.MessageBox.Show%2A?displayProperty=nameWithType> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of type <xref:System.Windows.Forms.WebBrowser> named `WebBrowser1`. Then ensure that the event handler is associated with the <xref:System.Windows.Forms.WebBrowser.ProgressChanged?displayProperty=nameWithType> event.
:::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet652":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet652":::
]]></format>
</remarks>
<altmember cref="P:System.Windows.Forms.WebBrowserProgressChangedEventArgs.MaximumProgress" />
<altmember cref="T:System.Windows.Forms.ProgressBar" />
<altmember cref="T:System.Windows.Forms.WebBrowser" />
<altmember cref="E:System.Windows.Forms.WebBrowser.ProgressChanged" />
</Docs>
</Member>
<Member MemberName="MaximumProgress">
<MemberSignature Language="C#" Value="public long MaximumProgress { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MaximumProgress" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.WebBrowserProgressChangedEventArgs.MaximumProgress" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MaximumProgress As Long" />
<MemberSignature Language="F#" Value="member this.MaximumProgress : int64" Usage="System.Windows.Forms.WebBrowserProgressChangedEventArgs.MaximumProgress" />
<MemberSignature Language="C++ CLI" Value="public:
 property long MaximumProgress { long get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the total number of bytes in the document being loaded.</summary>
<value>The total number of bytes to be loaded.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You can use this property to display the current navigation progress in a <xref:System.Windows.Forms.ProgressBar> control. Use the <xref:System.Windows.Forms.WebBrowserProgressChangedEventArgs.CurrentProgress%2A> property to determine the number of bytes that have been downloaded successfully.
## Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.WebBrowser.ProgressChanged?displayProperty=nameWithType> event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing <xref:System.Windows.Forms.MessageBox.Show%2A?displayProperty=nameWithType> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of type <xref:System.Windows.Forms.WebBrowser> named `WebBrowser1`. Then ensure that the event handler is associated with the <xref:System.Windows.Forms.WebBrowser.ProgressChanged?displayProperty=nameWithType> event.
:::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet652":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet652":::
]]></format>
</remarks>
<altmember cref="P:System.Windows.Forms.WebBrowserProgressChangedEventArgs.CurrentProgress" />
<altmember cref="T:System.Windows.Forms.ProgressBar" />
<altmember cref="T:System.Windows.Forms.WebBrowser" />
<altmember cref="E:System.Windows.Forms.WebBrowser.ProgressChanged" />
</Docs>
</Member>
</Members>
</Type>