You are here: Documenter for .NET > Using Documenter Styles to Create Links > The Link Type Style

The Link Type Style

Link Type style is used to link a type name to the topic describing that type. A type can be a class, an enumeration, an interface, a structure or a delegate.

Note: Using this style is not necessary and not recommended. You can always use a specialized style instead, one of the following: Link Class, Link Enumeration, Link Interface, Link Structure, or Link Delegate. The Link Type style is used by Documenter for .NET for internal purposes, to simplify the process of generating the document, and is documented here only for completeness.

The link text starts with a special character followed by colon. The special character specifies the kind of the type:

С Class

D Delegate

E Enumeration

I Interface

S Structure

For this style, the Doc-To-Help compiler removes the special character and colon. The target topic title is determined by the remainder of the link text with the added type kind name, which is one of the words Class, Delegate, Enumeration, Interface or Structure.

To create a link using this style, prepend the text with one of the special characters (uppercase) and colon, select the text including the special character and format it with the Link Type style using standard Microsoft Word style formatting.

For this style, Doc-To-Help applies all transformations determined by the special characters !, () and +, as for the corresponding specialized styles for type links, see Special Characters in Link Text.

The following table demonstrates the usage of the Link Type style:

 

In document

In help file

Links to topic

C:FileInfo

FileInfo

FileInfo Class

I:IResourceReader

IresourceReader

IResourceReader Interface

S:Point

Point

Point Structure

E:TraceMode

TaceMode

TraceMode Enumeration

D:TypeFilter

TypeFilter

TypeFilter Delegate

 

The following table demonstrates using special characters with the Link Type style:

 

In document

In help file

Links to topic

C:FileInfo

FileInfo

FileInfo Class

C:System.IO.FileInfo

FileInfo

System.IO.FileInfo Class

C:!System.IO.FileInfo

System.IO.FileInfo

System.IO.FileInfo Class

C:(System.IO.)FileInfo

System.IO.FileInfo

FileInfo Class