Table of Contents

Constructor LinkRegion

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

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

Initializes a link region.

public LinkRegion(Twips x, Twips y, Twips width, Twips height, string target)

Parameters

x Twips

Left coordinate in twips.

y Twips

Top coordinate in twips.

width Twips

Width in twips.

height Twips

Height in twips.

target string

Link target URI or bookmark reference.

Remarks

Kind is read from target as it was before LinkRegionKind existed; prefer the constructor that states it.

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

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

public LinkRegion(Twips x, Twips y, Twips width, Twips height, string target, int structureElementId, string text)

Parameters

x Twips

Left coordinate in twips.

y Twips

Top coordinate in twips.

width Twips

Width in twips.

height Twips

Height in twips.

target string

Link target URI or bookmark reference.

structureElementId int

The Link element enclosing this region, or 0 when the region is outside logical structure (a bookmark destination marker, or a document rendered with tagging off).

text string

The text under this region, for the annotation's description.

Remarks

Kind is read from target as it was before LinkRegionKind existed: a target in the old outline encoding is an OutlineEntry; # and a name is a Destination on a region with no area and an InternalLink on one with an area; anything else is an ExternalUri. Prefer the constructor that states it.

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.

public LinkRegion(Twips x, Twips y, Twips width, Twips height, string target, int structureElementId, string text, LinkRegionKind kind)

Parameters

x Twips

Left coordinate in twips.

y Twips

Top coordinate in twips.

width Twips

Width in twips; zero for a Destination.

height Twips

Height in twips; zero for a Destination.

target string

The URI for ExternalUri; # and the destination's name for InternalLink and Destination.

structureElementId int

The Link element enclosing this region, or 0.

text string

The text under this region, for the annotation's description.

kind LinkRegionKind

What the region is. An outline entry is made by CreateOutlineEntry(Twips, Twips, int, string).

Exceptions

ArgumentNullException

target is null.

ArgumentException

kind is OutlineEntry.

ArgumentOutOfRangeException

kind is not a defined value.