mcs/class/System.Windows.Forms/Documentation/en/System.Windows.Forms/SelectionRange.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="SelectionRange" FullName="System.Windows.Forms.SelectionRange">
   3   <TypeSignature Language="C#" Value="public sealed class SelectionRange" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Object</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Attributes>
  14     <Attribute>
  15       <AttributeName>System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.SelectionRangeConverter))</AttributeName>
  16     </Attribute>
  17   </Attributes>
  18   <Docs>
  19     <remarks>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>The <see cref="T:System.Windows.Forms.SelectionRange" /> is the date or dates selected and highlighted on the <see cref="T:System.Windows.Forms.MonthCalendar" /> control. If only one date is selected, the <see cref="P:System.Windows.Forms.SelectionRange.Start" /> and <see cref="P:System.Windows.Forms.SelectionRange.End" /> property values will be equal. The <see cref="T:System.Windows.Forms.SelectionRange" /> can be changed by the user clicking a date while dragging the mouse pointer across the desired dates, or you can set the range in code. For example, you might want to have the user enter a date range into two <see cref="T:System.Windows.Forms.TextBox" /> controls or two <see cref="T:System.Windows.Forms.DateTimePicker" /> controls and set the <see cref="T:System.Windows.Forms.SelectionRange" /> based on those dates.</para>
  22     </remarks>
  23     <summary>
  24       <attribution license="cc4" from="Microsoft" modified="false" />
  25       <para>Represents a date selection range in a month calendar control.</para>
  26     </summary>
  27   </Docs>
  28   <Members>
  29     <Member MemberName=".ctor">
  30       <MemberSignature Language="C#" Value="public SelectionRange ();" />
  31       <MemberType>Constructor</MemberType>
  32       <Parameters />
  33       <Docs>
  34         <remarks>
  35           <attribution license="cc4" from="Microsoft" modified="false" />
  36           <para>The <see cref="P:System.Windows.Forms.SelectionRange.Start" /> and <see cref="P:System.Windows.Forms.SelectionRange.End" /> values are set to null when this constructor is used.</para>
  37         </remarks>
  38         <summary>
  39           <attribution license="cc4" from="Microsoft" modified="false" />
  40           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.SelectionRange" /> class.</para>
  41         </summary>
  42       </Docs>
  43       <AssemblyInfo>
  44         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  45         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47     </Member>
  48     <Member MemberName=".ctor">
  49       <MemberSignature Language="C#" Value="public SelectionRange (System.Windows.Forms.SelectionRange range);" />
  50       <MemberType>Constructor</MemberType>
  51       <Parameters>
  52         <Parameter Name="range" Type="System.Windows.Forms.SelectionRange" />
  53       </Parameters>
  54       <Docs>
  55         <remarks>
  56           <attribution license="cc4" from="Microsoft" modified="false" />
  57           <para>The <see cref="P:System.Windows.Forms.SelectionRange.Start" /> and <see cref="P:System.Windows.Forms.SelectionRange.End" /> property values are assigned the <see cref="P:System.Windows.Forms.SelectionRange.Start" /> and <see cref="P:System.Windows.Forms.SelectionRange.End" /> property values of the assigned <see cref="T:System.Windows.Forms.SelectionRange" /> object.</para>
  58         </remarks>
  59         <summary>
  60           <attribution license="cc4" from="Microsoft" modified="false" />
  61           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.SelectionRange" /> class with the specified selection range.</para>
  62         </summary>
  63         <param name="range">
  64           <attribution license="cc4" from="Microsoft" modified="false" />The existing <see cref="T:System.Windows.Forms.SelectionRange" />. </param>
  65       </Docs>
  66       <AssemblyInfo>
  67         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  68         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70     </Member>
  71     <Member MemberName=".ctor">
  72       <MemberSignature Language="C#" Value="public SelectionRange (DateTime lower, DateTime upper);" />
  73       <MemberType>Constructor</MemberType>
  74       <Parameters>
  75         <Parameter Name="lower" Type="System.DateTime" />
  76         <Parameter Name="upper" Type="System.DateTime" />
  77       </Parameters>
  78       <Docs>
  79         <remarks>
  80           <attribution license="cc4" from="Microsoft" modified="false" />
  81           <block subset="none" type="note">
  82             <para>If the <paramref name="lower" /> <see cref="T:System.DateTime" /> value is greater than the <paramref name="upper" /> <see cref="T:System.DateTime" /> value, the <paramref name="lower" /> value will be assigned to the <see cref="P:System.Windows.Forms.SelectionRange.End" /> property instead of the <see cref="P:System.Windows.Forms.SelectionRange.Start" /> property.</para>
  83           </block>
  84         </remarks>
  85         <summary>
  86           <attribution license="cc4" from="Microsoft" modified="false" />
  87           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.SelectionRange" /> class with the specified beginning and ending dates.</para>
  88         </summary>
  89         <param name="lower">
  90           <attribution license="cc4" from="Microsoft" modified="false" />The starting date in the <see cref="T:System.Windows.Forms.SelectionRange" />. </param>
  91         <param name="upper">
  92           <attribution license="cc4" from="Microsoft" modified="false" />The ending date in the <see cref="T:System.Windows.Forms.SelectionRange" />. </param>
  93       </Docs>
  94       <AssemblyInfo>
  95         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  96         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  97       </AssemblyInfo>
  98     </Member>
  99     <Member MemberName="End">
 100       <MemberSignature Language="C#" Value="public DateTime End { set; get; }" />
 101       <MemberType>Property</MemberType>
 102       <ReturnValue>
 103         <ReturnType>System.DateTime</ReturnType>
 104       </ReturnValue>
 105       <Docs>
 106         <value>To be added.</value>
 107         <remarks>To be added.</remarks>
 108         <summary>
 109           <attribution license="cc4" from="Microsoft" modified="false" />
 110           <para>Gets or sets the ending date and time of the selection range.</para>
 111         </summary>
 112       </Docs>
 113       <AssemblyInfo>
 114         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 115         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 116       </AssemblyInfo>
 117     </Member>
 118     <Member MemberName="Start">
 119       <MemberSignature Language="C#" Value="public DateTime Start { set; get; }" />
 120       <MemberType>Property</MemberType>
 121       <ReturnValue>
 122         <ReturnType>System.DateTime</ReturnType>
 123       </ReturnValue>
 124       <Docs>
 125         <value>To be added.</value>
 126         <remarks>To be added.</remarks>
 127         <summary>
 128           <attribution license="cc4" from="Microsoft" modified="false" />
 129           <para>Gets or sets the starting date and time of the selection range.</para>
 130         </summary>
 131       </Docs>
 132       <AssemblyInfo>
 133         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 134         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 135       </AssemblyInfo>
 136     </Member>
 137     <Member MemberName="ToString">
 138       <MemberSignature Language="C#" Value="public override string ToString ();" />
 139       <MemberType>Method</MemberType>
 140       <ReturnValue>
 141         <ReturnType>System.String</ReturnType>
 142       </ReturnValue>
 143       <Parameters />
 144       <Docs>
 145         <remarks>
 146           <attribution license="cc4" from="Microsoft" modified="false" />
 147           <para>The <see cref="M:System.Windows.Forms.SelectionRange.ToString" /> method returns a string that includes the values for the <see cref="P:System.Windows.Forms.SelectionRange.Start" /> and <see cref="P:System.Windows.Forms.SelectionRange.End" /> properties.</para>
 148         </remarks>
 149         <summary>
 150           <attribution license="cc4" from="Microsoft" modified="false" />
 151           <para>Returns a string that represents the <see cref="T:System.Windows.Forms.SelectionRange" />.</para>
 152         </summary>
 153         <returns>
 154           <attribution license="cc4" from="Microsoft" modified="false" />
 155           <para>A string that represents the current <see cref="T:System.Windows.Forms.SelectionRange" />.</para>
 156         </returns>
 157       </Docs>
 158       <AssemblyInfo>
 159         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 160         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162     </Member>
 163   </Members>
 164 </Type>