Enum LinkRegionKind

Namespace

DocWright.Core.Rendering

Assembly

DocWright.Core.dll

What a LinkRegion is: a link to follow, a place a link can go to, or an entry of the document outline.

public enum LinkRegionKind

Fields

ExternalUri = 0

A link to an external resource: Target is a URI.

InternalLink = 1

A link to a named destination in the same document: Target is # followed by the destination's name.

Destination = 2

A named destination at this region's position, which internal links go to (a bookmark): Target is # followed by its name, and the region has no area.

OutlineEntry = 3

An entry of the document outline (a PDF's bookmarks panel) at this region's position: its level and title are OutlineLevel and OutlineTitle.

Remarks

Added in Phase 72. Before it, the kind travelled inside Target: a leading # meant a bookmark, a region with no area and such a target was the bookmark's destination rather than a link to it, and an outline entry was a target starting docwright-outline://. A renderer that did not know those conventions drew an outline entry as a web link. Regions built with the constructors that take no kind still carry those targets, and their Kind is read from them exactly as the PDF renderer always read them.