96 lines
6.7 KiB
XML
96 lines
6.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="ConvertEventArgs" FullName="System.Windows.Forms.ConvertEventArgs">
|
|
<TypeSignature Language="C#" Value="public class ConvertEventArgs : EventArgs" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Windows.Forms</AssemblyName>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.EventArgs</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Windows.Forms.ConvertEventArgs" /> is used to format and unformat values displayed by a Windows Forms control that is bound to data through a <see cref="T:System.Windows.Forms.Binding" /> object. The <see cref="E:System.Windows.Forms.Binding.Format" /> event occurs whenever a control property is bound to a value and the <see cref="E:System.Windows.Forms.Binding.Parse" /> event occurs whenever the bound value changes.</para>
|
|
<para>The <see cref="E:System.Windows.Forms.Binding.Format" /> and <see cref="E:System.Windows.Forms.Binding.Parse" /> events allow you to create custom formats for displaying data. For example, if the data in a table is of type <see cref="T:System.Decimal" />, you can specify that the data should be displayed in the local currency format--by setting the <see cref="P:System.Windows.Forms.ConvertEventArgs.Value" /> property of the <see cref="T:System.Windows.Forms.ConvertEventArgs" /> to the formatted value in the <see cref="E:System.Windows.Forms.Binding.Format" /> event. You must consequently unformat the displayed value in the <see cref="E:System.Windows.Forms.Binding.Parse" /> event.</para>
|
|
<para>For more information about handling events, see <format type="text/html"><a href="01E4F1BC-E55E-413F-98C7-6588493E5F67">[<topic://cpconEventsOverview>]</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides data for the <see cref="E:System.Windows.Forms.Binding.Format" /> and <see cref="E:System.Windows.Forms.Binding.Parse" /> events.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public ConvertEventArgs (object value, Type desiredType);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="value" Type="System.Object" />
|
|
<Parameter Name="desiredType" Type="System.Type" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ConvertEventArgs" /> class.</para>
|
|
</summary>
|
|
<param name="value">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that contains the value of the current property. </param>
|
|
<param name="desiredType">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the value. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="DesiredType">
|
|
<MemberSignature Language="C#" Value="public Type DesiredType { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Type</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="P:System.Windows.Forms.ConvertEventArgs.DesiredType" /> property enables you to check the type of the property that the value is being converted to.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the data type of the desired value.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Value">
|
|
<MemberSignature Language="C#" Value="public object Value { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The value contained by the <see cref="P:System.Windows.Forms.ConvertEventArgs.Value" /> property depends on the event in which the <see cref="T:System.Windows.Forms.ConvertEventArgs" /> is returned. The <see cref="T:System.Windows.Forms.ConvertEventArgs" /> can be returned in either the <see cref="E:System.Windows.Forms.Binding.Format" /> event or the <see cref="E:System.Windows.Forms.Binding.Parse" /> event.</para>
|
|
<para>When the <see cref="T:System.Windows.Forms.ConvertEventArgs" /> is returned in the <see cref="E:System.Windows.Forms.Binding.Format" /> event, the <see cref="P:System.Windows.Forms.ConvertEventArgs.Value" /> property contains the unformatted property value of the data source. Within the <see cref="E:System.Windows.Forms.Binding.Format" /> event, you can read the property value, format the value, and reset the <see cref="P:System.Windows.Forms.ConvertEventArgs.Value" /> property to the new (formatted) value, thereby setting the value displayed in the data-bound control.</para>
|
|
<para>When the <see cref="T:System.Windows.Forms.ConvertEventArgs" /> is returned in the <see cref="E:System.Windows.Forms.Binding.Parse" /> event, the property contains the custom-formatted value of the data-bound control. Within the <see cref="E:System.Windows.Forms.Binding.Parse" /> event, you must read the formatted value, parse it, and convert it back to the same data type as the data source. You can then reset the <see cref="P:System.Windows.Forms.ConvertEventArgs.Value" /> property to the unformatted value, and thereby set the value of the data source. To determine the type of the data source, examine the <see cref="P:System.Windows.Forms.ConvertEventArgs.DesiredType" /> property value.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the value of the <see cref="T:System.Windows.Forms.ConvertEventArgs" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |