Link Field style is used to link a field name to the topic describing that field.
To create a link using this style, select the link text and press Link Field on the Doc-To-Help Documenter for .NET toolbar.
For this style, the Doc-To-Help compiler will apply the nested type separator substitution to the link text, if applicable, see Special Characters in Link Text, add the word Field to the text, and establish a link to the topic with the title coinciding with the resulting text.
By default, Doc-To-Help removes the name of the type containing the field, if the type name is present. You can change this behavior by using the special characters, exclamation sign and parenthesis. See Special Characters in Link Text.
The following table demonstrates the usage of the Link Field style:
In document |
In help file |
Links to topic |
Timeout.Infinite |
Infinite |
Timeout.Infinite Field |
!Timeout.Infinite |
Timeout.Infinite |
Timeout.Infinite Field |
System.Threading.Timeout.Infinite |
Infinite |
System.Threading.Timeout.Infinite Field |
!System.Threading.Timeout.Infinite |
System.Threading.Timeout.Infinite |
System.Threading.Timeout.Infinite Field |
(System.Threading.)Timeout.Infinite |
System.Threading.Timeout.Infinite |
Timeout.Infinite Field |