类 FSDocViewerPrefs 继承关系图:

构造函数
(FSPDFDictionary *)	- getDict
	从当前对象获取PDF字典。更多...

(BOOL)	- getUIDisplayStatus:
	获取指定查看器首选项类型的UI显示状态。更多...

(id)	- initWithDocument:pdf_dict:
	带参数的构造函数。更多...

(id)	- initWithOther:
	拷贝构造函数。更多...

(BOOL)	- isEmpty
	检查当前对象是否为空。更多...

(void)	- setUIDisplayStatus:value:
	设置指定查看器首选项类型的UI显示状态。更多...

属性
FSPDFDocDisplayMode	nonFullScreenPageMode
	获取指定文档在退出全屏模式时如何显示文档的显示模式，当文档的显示模式为全屏时。更多...

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

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

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

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

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

BOOL	readingDirection
	获取文本的主要阅读方向。更多...

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

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

详细描述

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

参见: FSPDFDoc

函数文档

◆ getDict()

- (FSPDFDictionary *) getDict

从当前对象获取PDF字典。

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

◆ getUIDisplayStatus:()

- (BOOL) getUIDisplayStatus: (FSDocViewerPrefsViewerPref) pref

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

参数

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

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

◆ initWithDocument:pdf_dict:()

- (id) initWithDocument:	(FSPDFDoc*)	document
pdf_dict:	(FSPDFDictionary*)	pdf_dict

带参数的构造函数。

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

参数

[in]	document	有效的PDF文档对象。
[in]	pdf_dict	表示PDF文档查看器首选项信息的PDF字典。如果此参数不是nil，此PDF字典应已存在于指定的PDF文档中。如果此参数为nil，则表示访问指定PDF文档中的查看器首选项信息。请参考"详细信息"部分了解更多详情。默认值：nil。

◆ initWithOther:()

- (id) initWithOther: (FSDocViewerPrefs*) other

拷贝构造函数。

参数

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

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

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

返回: YES表示当前对象为空，NO表示不为空。

◆ setUIDisplayStatus:value:()

- (void) setUIDisplayStatus:	(FSDocViewerPrefsViewerPref)	pref
value:	(BOOL)	value

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

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

参数

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

返回: 无。

属性说明

◆ nonFullScreenPageMode

- (FSPDFDocDisplayMode) nonFullScreenPageMode

readwritenonatomicassign

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

此显示模式仅在文档的显示模式为全屏时有用。可以使用函数 FSPDFDoc::displayMode 检查文档的显示模式。

◆ printRange

- (FSRange *) printRange

readwritenonatomicweak

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

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

◆ readingDirection

- (BOOL) readingDirection

readwritenonatomicassign

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

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