Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FoxitPDFSDKPython3.DocViewerPrefs类 参考
类 FoxitPDFSDKPython3.DocViewerPrefs 继承关系图:

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

## 静态 Public 属性
| e_CenterWindow = _fsdk.DocViewerPrefs_e_CenterWindow
| 指定是否将文档窗口位置居中显示在屏幕中央的标志。
| e_DisplayDocTitle = _fsdk.DocViewerPrefs_e_DisplayDocTitle
| 指定窗口标题栏是否应显示从文档信息字典的"Title"条目中获取的 文档标题的标志。如果为false，标题栏应显示包含文档的PDF文件名。
| e_FitWindow = _fsdk.DocViewerPrefs_e_FitWindow
| 指定是否调整文档窗口大小以适应第一个显示页面尺寸的标志。
| e_HideMenubar = _fsdk.DocViewerPrefs_e_HideMenubar
| 指定文档处于活动状态时是否隐藏查看器应用程序菜单栏的标志。
| e_HideToolbar = _fsdk.DocViewerPrefs_e_HideToolbar
| 指定文档处于活动状态时是否隐藏查看器应用程序工具栏的标志。
| e_HideWindowUI = _fsdk.DocViewerPrefs_e_HideWindowUI
| 指定是否隐藏文档窗口中的用户界面元素（如滚动条和导航控件）的标志， 只显示文档内容。
| e_PrintScaleAppDefault = _fsdk.DocViewerPrefs_e_PrintScaleAppDefault
| 这表示应用程序应该使用当前的打印缩放。
| e_PrintScaleNone = _fsdk.DocViewerPrefs_e_PrintScaleNone
| 这表示打印对话框应该反映无页面缩放。

## 详细描述

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

参见
  PDFDoc

## 构造及析构函数说明

## ◆ DocViewerPrefs()

def FoxitPDFSDKPython3.DocViewerPrefs.DocViewerPrefs | ( |  | other | ) |

拷贝构造函数。

参数

  [in] | other | 另一个文档查看器首选项对象。

## 成员函数说明

## ◆ GetDict()

def FoxitPDFSDKPython3.DocViewerPrefs.GetDict | ( |  | ) |

从当前对象获取PDF字典。

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

## ◆ GetNonFullScreenPageMode()

def FoxitPDFSDKPython3.DocViewerPrefs.GetNonFullScreenPageMode | ( |  | ) |

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

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

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

## ◆ GetPrintArea()

def FoxitPDFSDKPython3.DocViewerPrefs.GetPrintArea | ( |  | ) |

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

返回
  页面框类型。请参考从 FoxitPDFSDKPython3.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

## ◆ GetPrintClip()

def FoxitPDFSDKPython3.DocViewerPrefs.GetPrintClip | ( |  | ) |

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

返回
  页面框类型。请参考从 FoxitPDFSDKPython3.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

## ◆ GetPrintCopies()

def FoxitPDFSDKPython3.DocViewerPrefs.GetPrintCopies | ( |  | ) |

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

返回
  副本数量。

## ◆ GetPrintRange()

def FoxitPDFSDKPython3.DocViewerPrefs.GetPrintRange | ( |  | ) |

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

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

返回
  页面范围。

## ◆ GetPrintScale()

def FoxitPDFSDKPython3.DocViewerPrefs.GetPrintScale | ( |  | ) |

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

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

## ◆ GetReadingDirection()

def FoxitPDFSDKPython3.DocViewerPrefs.GetReadingDirection | ( |  | ) |

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

阅读方向信息对文档内容或页码编号没有直接影响， 但可用于确定页面并排显示或多页打印（即在单页上打印多个PDF页面）时 页面的相对位置。

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

## ◆ GetUIDisplayStatus()

def FoxitPDFSDKPython3.DocViewerPrefs.GetUIDisplayStatus | ( |  | pref | ) |

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

参数

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

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

## ◆ GetViewArea()

def FoxitPDFSDKPython3.DocViewerPrefs.GetViewArea | ( |  | ) |

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

返回
  页面框类型。请参考从 FoxitPDFSDKPython3.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

## ◆ GetViewClip()

def FoxitPDFSDKPython3.DocViewerPrefs.GetViewClip | ( |  | ) |

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

返回
  页面框类型。请参考从 FoxitPDFSDKPython3.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

## ◆ IsEmpty()

def FoxitPDFSDKPython3.DocViewerPrefs.IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

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

## ◆ SetNonFullScreenPageMode()

def FoxitPDFSDKPython3.DocViewerPrefs.SetNonFullScreenPageMode | ( |  | display_mode | ) |

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

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

参数

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

返回
  无。

## ◆ SetPrintArea()

def FoxitPDFSDKPython3.DocViewerPrefs.SetPrintArea | ( |  | box_type | ) |

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

参数

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

返回
  无。

## ◆ SetPrintClip()

def FoxitPDFSDKPython3.DocViewerPrefs.SetPrintClip | ( |  | box_type | ) |

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

参数

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

返回
  无。

## ◆ SetPrintCopies()

def FoxitPDFSDKPython3.DocViewerPrefs.SetPrintCopies | ( |  | print_copies | ) |

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

参数

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

返回
  无。

## ◆ SetPrintRange()

def FoxitPDFSDKPython3.DocViewerPrefs.SetPrintRange | ( |  | page_range | ) |

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

参数

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

返回
  无。

## ◆ SetPrintScale()

def FoxitPDFSDKPython3.DocViewerPrefs.SetPrintScale | ( |  | print_scale | ) |

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

参数

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

返回
  无。

## ◆ SetReadingDirection()

def FoxitPDFSDKPython3.DocViewerPrefs.SetReadingDirection | ( |  | is_left_to_right | ) |

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

阅读方向信息对文档内容或页码编号没有直接影响， 但可用于确定页面并排显示或多页打印（即在单页上打印多个PDF页面）时 页面的相对位置。

参数

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

返回
  无。

## ◆ SetUIDisplayStatus()

def FoxitPDFSDKPython3.DocViewerPrefs.SetUIDisplayStatus | ( |  | pref,
|  |  | value
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetViewArea()

def FoxitPDFSDKPython3.DocViewerPrefs.SetViewArea | ( |  | box_type | ) |

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

参数

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

返回
  无。

## ◆ SetViewClip()

def FoxitPDFSDKPython3.DocViewerPrefs.SetViewClip | ( |  | box_type | ) |

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

参数

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

返回
  无。