Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
FoxitPDFSDKPython2.PDFDictionary类 参考
类 FoxitPDFSDKPython2.PDFDictionary 继承关系图:

## 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)
| 将字符串作为值元素设置到由键指定的条目。 更多...
Public 成员函数 继承自 FoxitPDFSDKPython2.PDFObject
def | CloneObject ()
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
def | DeepCloneObject ()
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
def | GetArray ()
| 获取当前PDF对象的PDF数组对象。 更多...
def | GetBoolean ()
| 获取当前PDF对象的布尔值。 更多...
def | GetDateTime ()
| 获取当前PDF对象的日期时间值。 更多...
def | GetDict ()
| 获取当前PDF对象的PDF字典对象。 更多...
def | GetDirectObject ()
| 获取当前PDF对象的直接对象。 更多...
def | GetFloat ()
| 获取当前PDF对象的浮点数值。 更多...
def | GetInteger ()
| 获取当前PDF对象的整数值。 更多...
def | GetMatrix ()
| 获取当前PDF对象的矩阵值。 更多...
def | GetName ()
| 获取当前PDF对象的名称值。 更多...
def | GetObjNum ()
| 获取当前PDF对象的间接对象编号。 更多...
def | GetRect ()
| 获取当前PDF对象的矩形值。 更多...
def | GetStream ()
| 获取当前PDF对象的PDF流对象。 更多...
def | GetString ()
| 获取当前PDF对象的字符串值。 更多...
def | GetType ()
| 获取当前PDF对象的类型。 更多...
def | GetWideString ()
| 获取当前PDF对象的宽字符串值。 更多...
def | IsIdentical (pdf_obj)
| 检查输入的PDF对象是否与当前PDF对象相同。 更多...
def | Release ()
| 释放新创建的PDF对象或克隆PDF对象， 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...

## 静态 Public 成员函数
def | Create ()
| 创建新的字典对象。 更多...
静态 Public 成员函数 继承自 FoxitPDFSDKPython2.PDFObject
def | CreateFromBoolean (boolean_value)
| 从布尔值创建PDF对象。 更多...
def | CreateFromDateTime (date_time)
| 从日期时间创建PDF对象。 更多...
def | CreateFromFloat (float_value)
| 从浮点数创建PDF对象。 更多...
def | CreateFromInteger (integer_value)
| Create a PDF object from a integer number. 更多...
def | CreateFromName (name)
| 从表示名称的字符串创建PDF对象。 更多...
def | CreateFromNameW (name)
| 从表示名称的字符串创建PDF对象。 更多...
def | CreateFromString (string_value)
| 从字符串创建PDF对象。 更多...
def | CreateFromString (string_value, length)
| 从字符串创建PDF对象。 更多...
def | CreateReference (document, object_number)
| 为间接对象创建引用。 更多...

## 额外继承的成员函数
静态 Public 属性 继承自 FoxitPDFSDKPython2.PDFObject
| e_Array = _fsdk.PDFObject_e_Array
| PDF数组对象。
| e_Boolean = _fsdk.PDFObject_e_Boolean
| PDF布尔对象。
| e_Dictionary = _fsdk.PDFObject_e_Dictionary
| PDF字典对象。
| e_InvalidType = _fsdk.PDFObject_e_InvalidType
| 无效的PDF对象类型。
| e_Name = _fsdk.PDFObject_e_Name
| PDF名称对象。
| e_Null = _fsdk.PDFObject_e_Null
| PDF空对象。
| e_Number = _fsdk.PDFObject_e_Number
| PDF数字对象。
| e_Reference = _fsdk.PDFObject_e_Reference
| PDF引用对象。
| e_Stream = _fsdk.PDFObject_e_Stream
| PDF流对象。
| e_String = _fsdk.PDFObject_e_String
| PDF字符串对象。

## 详细描述

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

参见
  PDFObject

## 成员函数说明

## ◆ Create()

FoxitPDFSDKPython2.PDFDictionary.Create | ( |  | ) |
| static

创建新的字典对象。

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

返回
  一个新的PDFDictionary 对象。 如果有任何错误，此函数将返回null。

## ◆ GetElement()

def FoxitPDFSDKPython2.PDFDictionary.GetElement | ( |  | key | ) |

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

参数

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

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

## ◆ GetKey()

def FoxitPDFSDKPython2.PDFDictionary.GetKey | ( |  | position | ) |

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

参数

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

返回
  指定条目的键。

## ◆ GetValue()

def FoxitPDFSDKPython2.PDFDictionary.GetValue | ( |  | position | ) |

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

参数

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

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

## ◆ HasKey()

def FoxitPDFSDKPython2.PDFDictionary.HasKey | ( |  | key | ) |

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

参数

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

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

## ◆ MoveNext()

def FoxitPDFSDKPython2.PDFDictionary.MoveNext | ( |  | position | ) |

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

参数

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

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

## ◆ RemoveAt()

def FoxitPDFSDKPython2.PDFDictionary.RemoveAt | ( |  | key | ) |

移除由键指定的条目。

参数

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

返回
  无。

## ◆ SetAt()

def FoxitPDFSDKPython2.PDFDictionary.SetAt | ( |  | key,
|  |  | pdf_object
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetAtBoolean()

def FoxitPDFSDKPython2.PDFDictionary.SetAtBoolean | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

## ◆ SetAtDateTime()

def FoxitPDFSDKPython2.PDFDictionary.SetAtDateTime | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

## ◆ SetAtFloat()

def FoxitPDFSDKPython2.PDFDictionary.SetAtFloat | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

## ◆ SetAtInteger()

def FoxitPDFSDKPython2.PDFDictionary.SetAtInteger | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

## ◆ SetAtMatrix()

def FoxitPDFSDKPython2.PDFDictionary.SetAtMatrix | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

## ◆ SetAtName()

def FoxitPDFSDKPython2.PDFDictionary.SetAtName | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

## ◆ SetAtRect()

def FoxitPDFSDKPython2.PDFDictionary.SetAtRect | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

## ◆ SetAtReference()

def FoxitPDFSDKPython2.PDFDictionary.SetAtReference | ( |  | key,
|  |  | pdf_object,
|  |  | document
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetAtString()

def FoxitPDFSDKPython2.PDFDictionary.SetAtString | ( |  | key,
|  |  | value
| ) |  |

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

参数

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

返回
  无。

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