Foxit PDF SDK
FSPDFDictionary类 参考
类 FSPDFDictionary 继承关系图:
FSPDFObject

构造函数

(FSPDFObject *) - getElement:
 获取具有指定键的条目的值元素。
更多...
 
(NSString *) - getKey:
 获取由位置指定的条目的键。
更多...
 
(FSPDFObject *) - getValue:
 获取由位置指定的条目的值元素。
更多...
 
(BOOL) - hasKey:
 检查当前字典中是否存在具有指定键的条目。
更多...
 
(long) - moveNext:
 移动到第一个或下一个条目的位置。
更多...
 
(void) - removeAt:
 移除由键指定的条目。
更多...
 
(void) - setAt:pdf_object:
 将直接PDF对象(其对象编号总是等于0)作为值元素设置到由键指定的条目。
更多...
 
(void) - setAtBoolean:value:
 将布尔元素设置到由键指定的条目。
更多...
 
(void) - setAtDateTime:value:
 将Datetime对象作为值元素设置到由键指定的条目。
更多...
 
(void) - setAtFloat:value:
 将浮点数元素设置到由键指定的条目。
更多...
 
(void) - setAtInteger:value:
 将整数元素设置到由键指定的条目。
更多...
 
(void) - setAtMatrix:value:
 将矩阵对象作为值元素设置到由键指定的条目。
更多...
 
(void) - setAtName:value:
 将字符串(作为PDF名称对象)作为值元素设置到由键指定的条目。
更多...
 
(void) - setAtRect:value:
 将矩形对象作为值元素设置到由键指定的条目。
更多...
 
(void) - setAtReference:pdf_object:document:
 将间接PDF对象(其对象编号总是大于0)的引用对象作为值元素设置到由键指定的条目。
更多...
 
(void) - setAtString:value:
 将字符串作为值元素设置到由键指定的条目。
更多...
 
- 构造函数 继承自 FSPDFObject
(FSPDFObject *) - cloneObject
 克隆当前PDF对象并获取克隆的PDF对象。
更多...
 
(FSPDFObject *) - deepCloneObject
 克隆当前PDF对象并获取克隆的PDF对象。
更多...
 
(void) - destroy
 释放新创建的PDF对象或克隆PDF对象, 该对象与PDF文档或其他PDF对象无关且不会再使用。
更多...
 
(FSPDFArray *) - getArray
 获取当前PDF对象的PDF数组对象。
更多...
 
(BOOL) - getBoolean
 获取当前PDF对象的布尔值。
更多...
 
(FSDateTime *) - getDateTime
 获取当前PDF对象的日期时间值。
更多...
 
(FSPDFDictionary *) - getDict
 获取当前PDF对象的PDF字典对象。
更多...
 
(FSPDFObject *) - getDirectObject
 获取当前PDF对象的直接对象。
更多...
 
(float) - getFloat
 获取当前PDF对象的浮点数值。
更多...
 
(int) - getInteger
 获取当前PDF对象的整数值。
更多...
 
(FSMatrix2D *) - getMatrix
 获取当前PDF对象的矩阵值。
更多...
 
(NSString *) - getName
 获取当前PDF对象的名称值。
更多...
 
(unsigned int) - getObjNum
 获取当前PDF对象的间接对象编号。
更多...
 
(FSRectF *) - getRect
 获取当前PDF对象的矩形值。
更多...
 
(FSPDFStream *) - getStream
 获取当前PDF对象的PDF流对象。
更多...
 
(NSData *) - getString
 获取当前PDF对象的字符串值。
更多...
 
(FSPDFObjectType) - getType
 获取当前PDF对象的类型。
更多...
 
(NSString *) - getWideString
 获取当前PDF对象的宽字符串值。
更多...
 
(BOOL) - isIdentical:
 检查输入的PDF对象是否与当前PDF对象相同。
更多...
 

类方法

(FSPDFDictionary *) + create
 创建新的字典对象。
更多...
 
- 类方法 继承自 FSPDFObject
(FSPDFObject *) + createFromBoolean:
 从布尔值创建PDF对象。
更多...
 
(FSPDFObject *) + createFromDateTime:
 从日期时间创建PDF对象。
更多...
 
(FSPDFObject *) + createFromFloat:
 从浮点数创建PDF对象。
更多...
 
(FSPDFObject *) + createFromInteger:
 Create a PDF object from a integer number.
更多...
 
(FSPDFObject *) + createFromName:
 从表示名称的字符串创建PDF对象。
更多...
 
(FSPDFObject *) + createFromNameW:
 从表示名称的字符串创建PDF对象。
更多...
 
(FSPDFObject *) + createFromString:
 从字符串创建PDF对象。
更多...
 
(FSPDFObject *) + createFromStringWithLength:length:
 从字符串创建PDF对象。
更多...
 
(FSPDFObject *) + createReference:object_number:
 为间接对象创建引用。
更多...
 

详细描述

PDF字典对象是一个关联表,包含成对的对象,称为字典的条目。 每个条目的第一个元素是键,它必须是一个PDF名称对象。第二个元素是值, 它可以是任何种类的PDF对象,包括另一个字典。在同一个字典中, 不应有两个条目具有相同的键。有关更多详细信息,请参阅<PDF Reference 1.7>中的第3.2.6节“字典对象”。
类 FSPDFDictionary 派生自 FSPDFObject ,并提供函数来创建新的PDF字典对象以及 获取/设置PDF字典对象中的条目。

参见
FSPDFObject

函数文档

◆ create()

+ (FSPDFDictionary *) create

创建新的字典对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用, 请调用函数 FSPDFObject::destroy 来释放该对象。

返回
一个新的 FSPDFDictionary 对象。 如果有任何错误,此函数将返回nil。

◆ getElement:()

- (FSPDFObject *) getElement: (NSString *)  key

获取具有指定键的条目的值元素。

参数
[in]key条目的键。它不应为空字符串。
返回
一个 FSPDFObject 对象,接收具有指定键的值。 如果未找到,此函数将返回nil。

◆ getKey:()

- (NSString *) getKey: (long)  position

获取由位置指定的条目的键。

参数
[in]position指定条目位置的POSITION。它不应为nil或0。
返回
指定条目的键。

◆ getValue:()

- (FSPDFObject *) getValue: (long)  position

获取由位置指定的条目的值元素。

参数
[in]position指定条目位置的POSITION。它不应为nil或0。
返回
一个 FSPDFObject ,接收指定条目的值元素。 如果有任何错误,此函数将返回nil。

◆ hasKey:()

- (BOOL) hasKey: (NSString *)  key

检查当前字典中是否存在具有指定键的条目。

参数
[in]key要检查的键。它不应为空字符串。
返回
YES表示指定的键存在于当前字典中,而NO表示不存在。

◆ moveNext:()

- (long) moveNext: (long)  position

移动到第一个或下一个条目的位置。

参数
[in]position一个POSITION,指示字典中当前条目的位置。 如果为nil或0,将返回字典中第一个条目的位置。
返回
一个POSITION,表示字典中下一个条目的位置。 nil或0表示当前条目是字典中的最后一个。

◆ removeAt:()

- (void) removeAt: (NSString *)  key

移除由键指定的条目。

参数
[in]key要移除的条目的键。它不应为空字符串。
返回
无。

◆ setAt:pdf_object:()

- (void) setAt: (NSString *)  key
pdf_object: (FSPDFObject*)  pdf_object 

将直接PDF对象(其对象编号总是等于0)作为值元素设置到由键指定的条目。

如果用户想要将间接PDF对象(其对象编号总是大于0)设置到条目, 请参考函数 FSPDFDictionary::setAtReference:pdf_object:document: 。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]pdf_object一个 FSPDFObject 对象,它是一个直接PDF对象(其对象编号总是等于0),将被设置到条目。 它不应为nil。
返回
无。

◆ setAtBoolean:value:()

- (void) setAtBoolean: (NSString *)  key
value: (BOOL)  value 

将布尔元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将被设置到条目的布尔元素。
返回
无。

◆ setAtDateTime:value:()

- (void) setAtDateTime: (NSString *)  key
value: (FSDateTime*)  value 

将Datetime对象作为值元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将被设置到条目的日期时间信息。
返回
无。

◆ setAtFloat:value:()

- (void) setAtFloat: (NSString *)  key
value: (float)  value 

将浮点数元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将被设置到条目的浮点数值。
返回
无。

◆ setAtInteger:value:()

- (void) setAtInteger: (NSString *)  key
value: (int)  value 

将整数元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将被设置到条目的整数值。
返回
无。

◆ setAtMatrix:value:()

- (void) setAtMatrix: (NSString *)  key
value: (FSMatrix2D*)  value 

将矩阵对象作为值元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将被设置到条目的矩阵。
返回
无。

◆ setAtName:value:()

- (void) setAtName: (NSString *)  key
value: (NSString *)  value 

将字符串(作为PDF名称对象)作为值元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将作为PDF名称对象设置到条目的字符串。它不应为空字符串。
返回
无。

◆ setAtRect:value:()

- (void) setAtRect: (NSString *)  key
value: (FSRectF*)  value 

将矩形对象作为值元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将被设置到条目的矩形。
返回
无。

◆ setAtReference:pdf_object:document:()

- (void) setAtReference: (NSString *)  key
pdf_object: (FSPDFObject*)  pdf_object
document: (FSPDFDoc*)  document 

将间接PDF对象(其对象编号总是大于0)的引用对象作为值元素设置到由键指定的条目。

如果用户想要将直接PDF对象(其对象编号总是等于0)设置到条目, 请参考函数 FSPDFDictionary::setAt:pdf_object: 。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]pdf_object一个 FSPDFObject 对象,它是一个间接PDF对象(其对象编号总是大于0), 将通过引用此间接对象的引用对象设置到条目。它不应为nil。
[in]document一个有效的PDF文档对象,当前PDF字典对象属于该文档, 且参数pdf_object是或将是其中的间接对象。
返回
无。

◆ setAtString:value:()

- (void) setAtString: (NSString *)  key
value: (NSString *)  value 

将字符串作为值元素设置到由键指定的条目。

参数
[in]key条目的键,其值元素将被设置。它不应为空字符串。
[in]value将作为PDF字符串对象设置到条目的宽字符串。
返回
无。
注解
如果要获取字符串值,请调用函数 FSPDFObject::getWideString 。