Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::DocViewerPrefs类 参考

## Public 成员函数
| constructor (document, pdf_dict)
| 带参数的构造函数。 更多...
| GetDict ()
| 从当前对象获取 PDF 字典。 更多...
| GetNonFullScreenPageMode ()
| 获取显示模式,该模式指定当文档的显示模式为全屏时 退出全屏模式时如何显示文档。 更多...
| GetPrintArea ()
| 获取表示打印文档时要渲染的页面区域的页面边界。 更多...
| GetPrintClip ()
| 获取打印文档时页面内容要裁剪到的页面边界。 更多...
| GetPrintCopies ()
| 获取为 PDF 文档打开打印对话框时要打印的份数。 更多...
| GetPrintRange ()
| 获取用于在为 PDF 文档打开打印对话框时初始化打印对话框的 页面范围信息。 更多...
| GetPrintScale ()
| 获取为 PDF 文档显示打印对话框时要选择的页面缩放选项。 更多...
| GetReadingDirection ()
| 获取文本的主要阅读方向。 更多...
| GetUIDisplayStatus (pref)
| 获取指定查看器首选项项类型的 UI 显示状态。 更多...
| GetViewArea ()
| 获取表示在屏幕上查看文档时要显示的页面区域的 页面边界。 更多...
| GetViewClip ()
| 获取在屏幕上查看文档时页面内容要裁剪到的 页面边界。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetNonFullScreenPageMode (display_mode)
| 设置显示模式,该模式指定当文档的显示模式为全屏时 退出全屏模式时如何显示文档。 更多...
| SetPrintArea (box_type)
| 设置表示打印文档时要渲染的页面区域的页面边界。 更多...
| SetPrintClip (box_type)
| 设置打印文档时页面内容要裁剪到的页面边界。 更多...
| SetPrintCopies (print_copies)
| 设置为 PDF 文档打开打印对话框时要打印的份数。 更多...
| SetPrintRange (page_range)
| 设置用于在为 PDF 文档打开打印对话框时初始化打印对话框的 页面范围。 更多...
| SetPrintScale (print_scale)
| 设置为 PDF 文档显示打印对话框时要选择的页面缩放选项。 更多...
| SetReadingDirection (is_left_to_right)
| 设置文本的主要阅读方向。 更多...
| SetUIDisplayStatus (pref, value)
| 设置指定查看器首选项项类型的 UI 显示状态。 更多...
| SetViewArea (box_type)
| 设置表示在屏幕上查看文档时要显示的页面区域的 页面边界。 更多...
| SetViewClip (box_type)
| 设置在屏幕上查看文档时页面内容要裁剪到的 页面边界。 更多...

## 静态 Public 属性
static | e_CenterWindow
| 指定是否将文档窗口定位在屏幕中心的标志。
static | e_DisplayDocTitle
| 指定窗口标题栏是否应显示从文档信息字典的 "Title" 条目中 获取的文档标题的标志。如果为 false,标题栏应改为显示 包含文档的 PDF 文件名。
static | e_FitWindow
| 指定是否调整文档窗口大小以适应第一个显示页面大小的标志。
static | e_HideMenubar
| 指定当文档处于活动状态时是否隐藏查看器应用程序的菜单栏的标志。
static | e_HideToolbar
| 文档打开时各种 GUI 元素应如何表现的枚举。 更多...
static | e_HideWindowUI
| 指定是否隐藏文档窗口中的用户界面元素(例如 滚动条和导航控件),仅显示文档内容的标志。
static | e_PrintScaleAppDefault
| 这表示应用程序应使用当前打印缩放。
static | e_PrintScaleNone
| 页面缩放选项的枚举。 更多...

## 详细描述

查看器首选项定义了文档在屏幕上或打印时的呈现方式。 此类应由有效的 PDF 文档对象构造。此类提供函数来 获取/设置 PDF 文档查看器首选项的不同部分,例如 UI 可见性、 非全屏模式的显示模式、阅读方向、用于指定目的的框项类型、 用于打印的一些首选项选项等。

参见
  FSDK.PDFDoc

## 成员函数说明

## ◆ constructor()

FSDK::DocViewerPrefs::constructor | ( | document | ,
|  | pdf_dict |
| ) |  |

带参数的构造函数。

当输入参数 pdf_dict 为 null 时,Foxit PDF SDK 将尝试 访问指定 PDF 文档中的查看器首选项信息: 如果 PDF 文档中存在查看器首选项信息,此函数只是 构造一个文档查看器首选项对象以与这些信息关联; 如果指定的 PDF 文档中不存在此类信息,构造的文档查看器首选项对象 可用于将这些信息设置到 PDF 文档。

参数

  [in] | document | 一个有效的 PDF 文档对象。
  [in] | pdf_dict | 表示 PDF 文档查看器首选项信息的 PDF 字典。 如果此参数不是 null,此 PDF 字典应已存在于 指定的 PDF 文档中。如果此参数为 null,表示 访问指定 PDF 文档中的查看器首选项信息。 有关更多详细信息,请参阅 "Details" 部分。默认值:null。

## ◆ GetDict()

FSDK::DocViewerPrefs::GetDict | ( |  | ) |

从当前对象获取 PDF 字典。

返回
  PDF 字典。如果有任何错误,此函数将返回 null。

## ◆ GetNonFullScreenPageMode()

FSDK::DocViewerPrefs::GetNonFullScreenPageMode | ( |  | ) |

获取显示模式,该模式指定当文档的显示模式为全屏时 退出全屏模式时如何显示文档。

此显示模式仅在文档的显示模式为全屏时有用。 函数 FSDK.PDFDoc.GetDisplayMode 可用于检查文档的显示模式。

返回
  非全屏模式的值。它将是以下值之一:
  - FSDK.PDFDoc.e_DisplayUseNone
  - FSDK.PDFDoc.e_DisplayUseOutlines
  - FSDK.PDFDoc.e_DisplayUseThumbs
  - FSDK.PDFDoc.e_DisplayUseOC

## ◆ GetPrintArea()

FSDK::DocViewerPrefs::GetPrintArea | ( |  | ) |

获取表示打印文档时要渲染的页面区域的页面边界。

返回
  页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这将是这些值之一。

## ◆ GetPrintClip()

FSDK::DocViewerPrefs::GetPrintClip | ( |  | ) |

获取打印文档时页面内容要裁剪到的页面边界。

返回
  页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这将是这些值之一。

## ◆ GetPrintCopies()

FSDK::DocViewerPrefs::GetPrintCopies | ( |  | ) |

获取为 PDF 文档打开打印对话框时要打印的份数。

返回
  份数。

## ◆ GetPrintRange()

FSDK::DocViewerPrefs::GetPrintRange | ( |  | ) |

获取用于在为 PDF 文档打开打印对话框时初始化打印对话框的 页面范围信息。

页面范围中指定的所有索引都是从 0 到 (pagecount - 1)。 如果页面范围信息无效,此函数将抛出异常 FSDK.e_ErrFormat。

返回
  页面范围。

## ◆ GetPrintScale()

FSDK::DocViewerPrefs::GetPrintScale | ( |  | ) |

获取为 PDF 文档显示打印对话框时要选择的页面缩放选项。

返回
  页面缩放选项字符串值。请参考从 FSDK.DocViewerPrefs.e_PrintScaleNone 开始的值,这将是这些值之一。

## ◆ GetReadingDirection()

FSDK::DocViewerPrefs::GetReadingDirection | ( |  | ) |

获取文本的主要阅读方向。

阅读方向信息对文档的内容或页码没有直接影响, 但可用于确定页面并排显示或以 n 合 1 方式打印时 (即在单页上打印多个 PDF 页面)的相对定位。

返回
  true 表示从左到右的阅读顺序,而 false 表示从右到左的阅读顺序。

## ◆ GetUIDisplayStatus()

FSDK::DocViewerPrefs::GetUIDisplayStatus | ( | pref |  | ) |

获取指定查看器首选项项类型的 UI 显示状态。

参数

  [in] | pref | 查看器首选项项类型。请参考从 FSDK.DocViewerPrefs.e_HideToolbar 开始的值,这应该是这些值之一。

返回
  指定查看器首选项项类型的值。

## ◆ GetViewArea()

FSDK::DocViewerPrefs::GetViewArea | ( |  | ) |

获取表示在屏幕上查看文档时要显示的页面区域的 页面边界。

返回
  页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这将是这些值之一。

## ◆ GetViewClip()

FSDK::DocViewerPrefs::GetViewClip | ( |  | ) |

获取在屏幕上查看文档时页面内容要裁剪到的 页面边界。

返回
  页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这将是这些值之一。

## ◆ IsEmpty()

FSDK::DocViewerPrefs::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时,意味着当前对象无用。

返回
  true 表示当前对象为空,而 false 表示不为空。

## ◆ SetNonFullScreenPageMode()

FSDK::DocViewerPrefs::SetNonFullScreenPageMode | ( | display_mode |  | ) |

设置显示模式,该模式指定当文档的显示模式为全屏时 退出全屏模式时如何显示文档。

此显示模式仅在文档的显示模式为全屏时有用。 函数 FSDK.PDFDoc.GetDisplayMode 可用于文档的显示模式。

参数

  [in] | display_mode | 退出全屏模式时的新显示模式。它应该是以下值之一: FSDK.PDFDoc.e_DisplayUseNone FSDK.PDFDoc.e_DisplayUseOutlines FSDK.PDFDoc.e_DisplayUseThumbs FSDK.PDFDoc.e_DisplayUseOC

返回
  无。

## ◆ SetPrintArea()

FSDK::DocViewerPrefs::SetPrintArea | ( | box_type |  | ) |

设置表示打印文档时要渲染的页面区域的页面边界。

参数

  [in] | box_type | 页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这应该是这些值之一。

返回
  无。

## ◆ SetPrintClip()

FSDK::DocViewerPrefs::SetPrintClip | ( | box_type |  | ) |

设置打印文档时页面内容要裁剪到的页面边界。

参数

  [in] | box_type | 页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这应该是这些值之一。

返回
  无。

## ◆ SetPrintCopies()

FSDK::DocViewerPrefs::SetPrintCopies | ( | print_copies |  | ) |

设置为 PDF 文档打开打印对话框时要打印的份数。

参数

  [in] | print_copies | 份数的新整数值。有效范围:从 1 到 5。 如果输入值超出有效范围,Foxit PDF SDK 将默认使用 1。

返回
  无。

## ◆ SetPrintRange()

FSDK::DocViewerPrefs::SetPrintRange | ( | page_range |  | ) |

设置用于在为 PDF 文档打开打印对话框时初始化打印对话框的 页面范围。

参数

  [in] | page_range | 表示新页面范围信息的范围对象。它应至少包含 一个有效的范围段。此范围指定的所有索引应 从 0 到 (pagecount - 1)。pagecount 由函数 FSDK.PDFDoc.GetPageCount 返回。

返回
  无。

## ◆ SetPrintScale()

FSDK::DocViewerPrefs::SetPrintScale | ( | print_scale |  | ) |

设置为 PDF 文档显示打印对话框时要选择的页面缩放选项。

参数

  [in] | print_scale | 新的页面缩放选项字符串。请参考从 FSDK.DocViewerPrefs.e_PrintScaleNone 开始的值,这应该是这些值之一。

返回
  无。

## ◆ SetReadingDirection()

FSDK::DocViewerPrefs::SetReadingDirection | ( | is_left_to_right |  | ) |

设置文本的主要阅读方向。

阅读方向信息对文档的内容或页码没有直接影响, 但可用于确定页面并排显示或以 n 合 1 方式打印时 (即在单页上打印多个 PDF 页面)的相对定位。

参数

  [in] | is_left_to_right | 新的阅读方向:true 表示从左到右的阅读顺序, 而 false 表示从右到左的阅读顺序。

返回
  无。

## ◆ SetUIDisplayStatus()

FSDK::DocViewerPrefs::SetUIDisplayStatus | ( | pref | ,
|  | value |
| ) |  |

设置指定查看器首选项项类型的 UI 显示状态。

如果查看器首选项项类型之前不存在且从未设置过, 该值默认为 false。

参数

  [in] | pref | 查看器首选项项类型。请参考从 FSDK.DocViewerPrefs.e_HideToolbar 开始的值,这应该是这些值之一。
  [in] | value | 指定查看器首选项项类型的新值。

返回
  无。

## ◆ SetViewArea()

FSDK::DocViewerPrefs::SetViewArea | ( | box_type |  | ) |

设置表示在屏幕上查看文档时要显示的页面区域的 页面边界。

参数

  [in] | box_type | 页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这应该是这些值之一。

返回
  无。

## ◆ SetViewClip()

FSDK::DocViewerPrefs::SetViewClip | ( | box_type |  | ) |

设置在屏幕上查看文档时页面内容要裁剪到的 页面边界。

参数

  [in] | box_type | 页面框类型。请参考从 FSDK.PDFPage.e_MediaBox 开始的值, 这应该是这些值之一。

返回
  无。

## 类成员变量说明

## ◆ e_HideToolbar

FSDK::DocViewerPrefs::e_HideToolbar
| static

文档打开时各种 GUI 元素应如何表现的枚举。

此枚举的值应单独使用。

指定当文档处于活动状态时是否隐藏查看器应用程序的工具栏的标志。

## ◆ e_PrintScaleNone

FSDK::DocViewerPrefs::e_PrintScaleNone
| static

页面缩放选项的枚举。

此枚举的值应单独使用。

这表示打印对话框应不反映页面缩放。