246 lines
14 KiB
XML
246 lines
14 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="LinkArea" FullName="System.Windows.Forms.LinkArea">
|
|
<TypeSignature Language="C#" Value="public struct LinkArea" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Windows.Forms</AssemblyName>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.ValueType</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.LinkArea+LinkAreaConverter))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>There are two ways to add a hyperlink to the text of a <see cref="T:System.Windows.Forms.LinkLabel" /> control. You can access the <see cref="M:System.Windows.Forms.LinkLabel.LinkCollection.Add(System.Int32,System.Int32)" /> method of the <see cref="T:System.Windows.Forms.LinkLabel.LinkCollection" /> class through the <see cref="P:System.Windows.Forms.LinkLabel.Links" /> property of the <see cref="T:System.Windows.Forms.LinkLabel" /> to add multiple hyperlinks to the control's text. If you only need to add a single hyperlink to the text of the control, you can use the <see cref="P:System.Windows.Forms.LinkLabel.LinkArea" /> property of the <see cref="T:System.Windows.Forms.LinkLabel" />. This property accepts a <see cref="T:System.Windows.Forms.LinkArea" /> that defines the location of the hyperlink within the control's text. When a hyperlink is specified using the <see cref="T:System.Windows.Forms.LinkArea" /> property, the link area is then added to the <see cref="T:System.Windows.Forms.LinkLabel.LinkCollection" /> in the same manner as adding the link using the <see cref="M:System.Windows.Forms.LinkLabel.LinkCollection.Add(System.Int32,System.Int32)" /> method of the <see cref="T:System.Windows.Forms.LinkLabel.LinkCollection" />.</para>
|
|
<para>The <see cref="P:System.Windows.Forms.LinkArea.Length" /> property specifies the number of characters within the text of the <see cref="T:System.Windows.Forms.LinkLabel" /> to include in the link area. The <see cref="P:System.Windows.Forms.LinkArea.Start" /> property specifies the first character in the control text to include in the hyperlink. If you want to determine whether a specific <see cref="T:System.Windows.Forms.LinkArea" /> is empty, you can use the <see cref="P:System.Windows.Forms.LinkArea.IsEmpty" /> property instead of checking the values of the <see cref="P:System.Windows.Forms.LinkArea.Start" /> and <see cref="P:System.Windows.Forms.LinkArea.Length" /> properties.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents an area within a <see cref="T:System.Windows.Forms.LinkLabel" /> control that represents a hyperlink within the control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public LinkArea (int start, int length);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="start" Type="System.Int32" />
|
|
<Parameter Name="length" Type="System.Int32" />
|
|
</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.LinkArea" /> class.</para>
|
|
</summary>
|
|
<param name="start">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The zero-based starting location of the link area within the text of the <see cref="T:System.Windows.Forms.LinkLabel" />. </param>
|
|
<param name="length">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The number of characters, after the starting character, to include in the link area. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Equals">
|
|
<MemberSignature Language="C#" Value="public override bool Equals (object o);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="o" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Determines whether this <see cref="T:System.Windows.Forms.LinkArea" /> is equal to the specified object.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if the specified object is equal to the current <see cref="T:System.Windows.Forms.LinkArea" />; otherwise, false.</para>
|
|
</returns>
|
|
<param name="o">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The object to compare to this <see cref="T:System.Windows.Forms.LinkArea" />.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="GetHashCode">
|
|
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="IsEmpty">
|
|
<MemberSignature Language="C#" Value="public bool IsEmpty { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
|
|
</Attribute>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>You can use this property to determine whether a valid link area has been specified in this object instead of evaluating the values of the <see cref="P:System.Windows.Forms.LinkArea.Length" /> and <see cref="P:System.Windows.Forms.LinkArea.Start" /> properties.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a value indicating whether the <see cref="T:System.Windows.Forms.LinkArea" /> is empty.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Length">
|
|
<MemberSignature Language="C#" Value="public int Length { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>To specify text from the <see cref="T:System.Windows.Forms.LinkLabel" /> to display as a link, set the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property to the location in the text to start creating the link. After the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property is set, set the value of the <see cref="P:System.Windows.Forms.LinkArea.Length" /> property to the number of characters, including the character position specified in the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property, that you want to make the link text. For example, if you want to make the first word of the text "The quick brown fox" a link, you set the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property to zero (0) and the <see cref="P:System.Windows.Forms.LinkArea.Length" /> property to three (3).</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the number of characters in the link area.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="op_Equality">
|
|
<MemberSignature Language="C#" Value="public static bool op_Equality (System.Windows.Forms.LinkArea linkArea1, System.Windows.Forms.LinkArea linkArea2);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="linkArea1" Type="System.Windows.Forms.LinkArea" />
|
|
<Parameter Name="linkArea2" Type="System.Windows.Forms.LinkArea" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a value indicating whether two instances of the <see cref="T:System.Windows.Forms.LinkArea" /> class are equal.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if two instances of the <see cref="T:System.Windows.Forms.LinkArea" /> class are equal; otherwise, false.</para>
|
|
</returns>
|
|
<param name="linkArea1">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.LinkArea" /> to compare.</param>
|
|
<param name="linkArea2">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.LinkArea" /> to compare.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="op_Inequality">
|
|
<MemberSignature Language="C#" Value="public static bool op_Inequality (System.Windows.Forms.LinkArea linkArea1, System.Windows.Forms.LinkArea linkArea2);" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="linkArea1" Type="System.Windows.Forms.LinkArea" />
|
|
<Parameter Name="linkArea2" Type="System.Windows.Forms.LinkArea" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Returns a value indicating whether two instances of the <see cref="T:System.Windows.Forms.LinkArea" /> class are not equal.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>true if two instances of the <see cref="T:System.Windows.Forms.LinkArea" /> class are not equal; otherwise, false.</para>
|
|
</returns>
|
|
<param name="linkArea1">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.LinkArea" /> to compare.</param>
|
|
<param name="linkArea2">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.LinkArea" /> to compare.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Start">
|
|
<MemberSignature Language="C#" Value="public int Start { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>To specify text from the <see cref="T:System.Windows.Forms.LinkLabel" /> to display as a link, set the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property to the location in the text to start creating the link. After the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property is set, set the value of the <see cref="P:System.Windows.Forms.LinkArea.Length" /> property to the number of characters, including the character position specified in the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property, that you want to make the link text. For example, if you want to make the first word of the text "The quick brown fox" a link, you set the <see cref="P:System.Windows.Forms.LinkArea.Start" /> property to zero (0) and the <see cref="P:System.Windows.Forms.LinkArea.Length" /> property to three (3).</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the starting location of the link area within the text of the <see cref="T:System.Windows.Forms.LinkLabel" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ToString">
|
|
<MemberSignature Language="C#" Value="public override string ToString ();" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |