Public 成员函数
def	GetElement (key)
	获取具有指定键的条目的值元素。更多...

def	GetKey (position)
	获取由位置指定的条目的键。更多...

def	GetValue (position)
	获取由位置指定的条目的值元素。更多...

def	HasKey (key)
	检查当前字典中是否存在具有指定键的条目。更多...

def	MoveNext (position)
	移动到第一个或下一个条目的位置。更多...

def	RemoveAt (key)
	移除由键指定的条目。更多...

def	SetAt (key, pdf_object)
	将直接PDF对象（其对象编号总是等于0）作为值元素设置到由键指定的条目。更多...

def	SetAtBoolean (key, value)
	将布尔元素设置到由键指定的条目。更多...

def	SetAtDateTime (key, value)
	将Datetime对象作为值元素设置到由键指定的条目。更多...

def	SetAtFloat (key, value)
	将浮点数元素设置到由键指定的条目。更多...

def	SetAtInteger (key, value)
	将整数元素设置到由键指定的条目。更多...

def	SetAtMatrix (key, value)
	将矩阵对象作为值元素设置到由键指定的条目。更多...

def	SetAtName (key, value)
	将字符串（作为PDF名称对象）作为值元素设置到由键指定的条目。更多...

def	SetAtRect (key, value)
	将矩形对象作为值元素设置到由键指定的条目。更多...

def	SetAtReference (key, pdf_object, document)
	将间接PDF对象（其对象编号总是大于0）的引用对象作为值元素设置到由键指定的条目。更多...

def	SetAtString (key, value)
	将字符串作为值元素设置到由键指定的条目。更多...

详细描述

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

参见: PDFObject

成员函数说明

◆ GetElement()

def fsdk.PDFDictionary.GetElement ( key )

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

参数

[in] key 条目的键。它不应为空字符串。

返回: 一个PDFObject 对象，接收具有指定键的值。如果未找到，此函数将返回null。

◆ GetKey()

def fsdk.PDFDictionary.GetKey ( position )

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

参数

[in] position 指定条目位置的POSITION。它不应为null或0。

返回: 指定条目的键。

◆ GetValue()

def fsdk.PDFDictionary.GetValue ( position )

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

参数

[in] position 指定条目位置的POSITION。它不应为null或0。

返回: 一个PDFObject ，接收指定条目的值元素。如果有任何错误，此函数将返回null。

◆ HasKey()

def fsdk.PDFDictionary.HasKey ( key )

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

参数

[in] key 要检查的键。它不应为空字符串。

返回: true表示指定的键存在于当前字典中，而false表示不存在。

◆ MoveNext()

def fsdk.PDFDictionary.MoveNext ( position )

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

参数

[in] position 一个POSITION，指示字典中当前条目的位置。如果为null或0，将返回字典中第一个条目的位置。

返回: 一个POSITION，表示字典中下一个条目的位置。 null或0表示当前条目是字典中的最后一个。

◆ RemoveAt()

def fsdk.PDFDictionary.RemoveAt ( key )

移除由键指定的条目。

参数

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

返回: 无。

◆ SetAt()

def fsdk.PDFDictionary.SetAt	(	key,
		pdf_object
	)

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

如果用户想要将间接PDF对象（其对象编号总是大于0）设置到条目，请参考函数fsdk.PDFDictionary.SetAtReference 。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	pdf_object	一个PDFObject 对象，它是一个直接PDF对象（其对象编号总是等于0），将被设置到条目。它不应为null。

返回: 无。

◆ SetAtBoolean()

def fsdk.PDFDictionary.SetAtBoolean	(	key,
		value
	)

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

参数

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

返回: 无。

◆ SetAtDateTime()

def fsdk.PDFDictionary.SetAtDateTime	(	key,
		value
	)

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

参数

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

返回: 无。

◆ SetAtFloat()

def fsdk.PDFDictionary.SetAtFloat	(	key,
		value
	)

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

参数

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

返回: 无。

◆ SetAtInteger()

def fsdk.PDFDictionary.SetAtInteger	(	key,
		value
	)

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

参数

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

返回: 无。

◆ SetAtMatrix()

def fsdk.PDFDictionary.SetAtMatrix	(	key,
		value
	)

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

参数

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

返回: 无。

◆ SetAtName()

def fsdk.PDFDictionary.SetAtName	(	key,
		value
	)

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

参数

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

返回: 无。

◆ SetAtRect()

def fsdk.PDFDictionary.SetAtRect	(	key,
		value
	)

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

参数

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

返回: 无。

◆ SetAtReference()

def fsdk.PDFDictionary.SetAtReference	(	key,
		pdf_object,
		document
	)

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

如果用户想要将直接PDF对象（其对象编号总是等于0）设置到条目，请参考函数fsdk.PDFDictionary.SetAt 。

参数

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

返回: 无。

◆ SetAtString()

def fsdk.PDFDictionary.SetAtString	(	key,
		value
	)

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

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将作为PDF字符串对象设置到条目的宽字符串。

返回: 无。

注解: 如果要获取字符串值，请调用函数fsdk.PDFObject.GetWideString 。

Public 成员函数

详细描述

成员函数说明

◆ GetElement()

◆ GetKey()

◆ GetValue()

◆ HasKey()

◆ MoveNext()

◆ RemoveAt()

◆ SetAt()

◆ SetAtBoolean()

◆ SetAtDateTime()

◆ SetAtFloat()

◆ SetAtInteger()

◆ SetAtMatrix()

◆ SetAtName()

◆ SetAtRect()

◆ SetAtReference()

◆ SetAtString()