FoxitPDFSDKforWeb v10.0.0
Foxit PDF SDK for Web
bookmark

A module that contains Bookmark APIs. More...

Classes

interface  BookmarkDestination
 Represents information about the destination of a bookmark. More...
 
interface  BookmarkFontStyle
 Represents the font style of a bookmark. More...
 

Enumerations

enum  BookmarkRelationship {
  FIRST_CHILD = 0, LAST_CHILD = 1, PREVIOUS_SIBLING = 2, NEXT_SIBLING = 3,
  FIRST_SIBLING = 4, LAST_SIBLING = 5
}
 Enumeration for bookmark relationships. Values of this enumeration should be used alone, representing the relationship between a bookmark and another bookmark. More...
 
enum  BookmarkZoomMode { ,
  ZoomFitBBox, ZoomFitBHorz, ZoomFitBVert, ZoomFitHorz,
  ZoomFitVert, ZoomFitPage, ZoomFitRect, ZoomXYZ
}
 Enumeration for zoom mode. More...
 

Detailed Description

A module that contains Bookmark APIs.

Enumeration Type Documentation

◆ BookmarkRelationship

Enumeration for bookmark relationships. Values of this enumeration should be used alone, representing the relationship between a bookmark and another bookmark.

Since
10.0.0
Enumerator
FIRST_CHILD 

A bookmark is the first child of another specified bookmark.

LAST_CHILD 

A bookmark is the last child of another specified bookmark.

PREVIOUS_SIBLING 

A bookmark is the previous sibling of another specified bookmark.

NEXT_SIBLING 

A bookmark is the next sibling of another specified bookmark.

FIRST_SIBLING 

A bookmark is the first sibling of another specified bookmark.

LAST_SIBLING 

A bookmark is the last sibling of another specified bookmark.

◆ BookmarkZoomMode

enum BookmarkZoomMode

Enumeration for zoom mode.

Since
10.0.0
Enumerator
ZoomFitBBox 

Fit the bounding box of page entirely within the display area when display the page. If this is used, that means the contents of the page should be magnified just enough to fit its bounding box entirely within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the display area in the other dimension.

Since
10.0.0
ZoomFitBHorz 

Fit the entire width of the page's bounding box within the display area when display the page. If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page's bounding box within the display area.

Since
10.0.0
ZoomFitBVert 

Fit the entire height of the page's bounding box within the display area when display the page. If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page's bounding box within the display area.

Since
10.0.0
ZoomFitHorz 

Fit the entire width of the page within the display area when display the page. If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page within the display area.

Since
10.0.0
ZoomFitVert 

Fit the entire height of the page within the display area when display the page. If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page within the display area.

Since
10.0.0
ZoomFitPage 

Fit the entire page within the display area when display the page. If this is used, that means the contents of the page should be magnified just enough to fit the entire page within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

Since
10.0.0
ZoomFitRect 

Fit the page content in a specified rectangle entirely within the display area when display the page. If this is used, that means the contents of the page should be magnified just enough to fit the page content in the specified rectangle entirely within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the display area in the other dimension.

Since
10.0.0
ZoomXYZ 

Display page with a specified position and a specified zoom factor. If this is used, that means the specified position of the page will be treated as the left-top position when the page is rendered and this position should be at the upper-left corner of the display area. Contents of the page should be magnified by the specified zoom factor.

Since
10.0.0

Foxit Software Corporation Logo
@2024 Foxit Software Incorporated. All rights reserved.