Class CoreControls.Link
Represents an internal link in a Document.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CoreControls.Link(bbox, pageNum, vpos, hpos)
Represents a link to an internal document location with page number and x,y position
|
| Field Attributes | Field Name and Description |
|---|---|
|
An alias for the bounding box
|
| Method Attributes | Method Name and Description |
|---|---|
|
Gets the bounding box of the link.
|
|
|
GetHPos()
Gets the horizontal position that the link will scroll to on the linked page.
|
|
|
Gets the page number that the link links to.
|
|
|
GetVPos()
Gets the vertical position that the link will scroll to on the linked page.
|
Class Detail
CoreControls.Link(bbox, pageNum, vpos, hpos)
Represents a link to an internal document location with page number and x,y position
- Parameters:
- {array} bbox
- The bounding box of the link [x1, y1, x2, y2]
- {number} pageNum
- The page number that the link links to
- {number} vpos
- The vertical position that the linked page will be scrolled to
- {number} hpos
- The horizontal position that the linked page will be scrolled to
Field Detail
Rect
An alias for the bounding box
Method Detail
GetBoundingBox()
Gets the bounding box of the link.
- Returns:
- The bounding box represented by an array of points [x1, y1, x2, y2]
GetHPos()
Gets the horizontal position that the link will scroll to on the linked page.
- Returns:
- The horizontal position on the linked page.
GetPageNumber()
Gets the page number that the link links to.
- Returns:
- The linked page number.
GetVPos()
Gets the vertical position that the link will scroll to on the linked page.
- Returns:
- The vertical position on the linked page.