Table of Contents

Class LinkRegion

Namespace
DocWright.Core.Rendering
Assembly
DocWright.Core.dll

A page region tied to a link target: the clickable area of a hyperlink, or a marker that names a destination or an outline entry at that position. Whatever produces the page adds them as it places content; the PDF renderer turns them into link annotations, destinations and the outline, and a raster has nothing to draw for them. Kind says which of those a region is.

public sealed class LinkRegion : ILayoutPrimitive
Inheritance
LinkRegion
Implements
Inherited Members

Constructors

LinkRegion(Twips, Twips, Twips, Twips, string)

Initializes a link region.

LinkRegion(Twips, Twips, Twips, Twips, string, int, string)

Initializes a link region that belongs to a logical-structure element.

LinkRegion(Twips, Twips, Twips, Twips, string, int, string, LinkRegionKind)

Initializes a link, or a destination, whose kind is stated rather than read from its target.

Properties

Height

Gets the height in twips.

Kind

Gets what this region is: a link, a destination, or an outline entry.

OutlineLevel

Gets the outline level of an OutlineEntry, 0 for the top level; 0 for every other kind.

OutlineTitle

Gets the title of an OutlineEntry; the empty string for every other kind.

StructureElementId

Gets the logical-structure element this region belongs to, or 0 when it belongs to none.

Target

Gets the target URI or bookmark reference.

Text

Gets the text under this region; the empty string when it has none.

Width

Gets the width in twips.

X

Gets the left coordinate in twips.

Y

Gets the top coordinate in twips.

Methods

CreateOutlineEntry(Twips, Twips, int, string)

Creates an entry of the document outline at a position on the page.

WithBounds(Twips, Twips, Twips, Twips)

Returns a copy of this region with another position and size and everything else unchanged.