Foxit PDF SDK

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

## Public 成员函数
| GetElement (key)
| 获取具有指定键的条目的值元素。 更多...
| GetKey (position)
| 获取由位置指定的条目的键。 更多...
| GetValue (position)
| 获取由位置指定的条目的值元素。 更多...
| HasKey (key)
| 检查当前字典中是否存在具有指定键的条目。 更多...
| MoveNext (position)
| 移动到第一个或下一个条目的位置。 更多...
| RemoveAt (key)
| 移除由键指定的条目。 更多...
| SetAt (key, pdf_object)
| 将直接PDF对象（其对象编号总是等于0）作为值元素设置到由键指定的条目。 更多...
| SetAtBoolean (key, value)
| 将布尔元素设置到由键指定的条目。 更多...
| SetAtDateTime (key, value)
| 将Datetime对象作为值元素设置到由键指定的条目。 更多...
| SetAtFloat (key, value)
| 将浮点数元素设置到由键指定的条目。 更多...
| SetAtInteger (key, value)
| 将整数元素设置到由键指定的条目。 更多...
| SetAtMatrix (key, value)
| 将矩阵对象作为值元素设置到由键指定的条目。 更多...
| SetAtName (key, value)
| 将字符串（作为PDF名称对象）作为值元素设置到由键指定的条目。 更多...
| SetAtRect (key, value)
| 将矩形对象作为值元素设置到由键指定的条目。 更多...
| SetAtReference (key, pdf_object, document)
| 将间接PDF对象（其对象编号总是大于0）的引用对象作为值元素设置到由键指定的条目。 更多...
| SetAtString (key, value)
| 将字符串作为值元素设置到由键指定的条目。 更多...
Public 成员函数 继承自 FSDK::PDFObject
| CloneObject ()
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
| DeepCloneObject ()
| 克隆当前PDF对象并获取克隆的PDF对象。 更多...
| GetArray ()
| 获取当前PDF对象的PDF数组对象。 更多...
| GetBoolean ()
| 获取当前PDF对象的布尔值。 更多...
| GetDateTime ()
| 获取当前PDF对象的日期时间值。 更多...
| GetDict ()
| 获取当前PDF对象的PDF字典对象。 更多...
| GetDirectObject ()
| 获取当前PDF对象的直接对象。 更多...
| GetFloat ()
| 获取当前PDF对象的浮点值。 更多...
| GetInteger ()
| 获取当前PDF对象的整数值。 更多...
| GetMatrix ()
| 获取当前PDF对象的矩阵值。 更多...
| GetName ()
| 获取当前PDF对象的名称值。 更多...
| GetObjNum ()
| 获取当前PDF对象的间接对象编号。 更多...
| GetRect ()
| 获取当前PDF对象的矩形值。 更多...
| GetStream ()
| 获取当前PDF对象的PDF流对象。 更多...
| GetString ()
| 获取当前PDF对象的字符串值。 更多...
| GetType ()
| 获取当前PDF对象的类型。 更多...
| GetWideString ()
| 获取当前PDF对象的宽字符串值。 更多...
| IsIdentical (pdf_obj)
| 检查输入的PDF对象是否与当前PDF对象相同。 更多...
| Release ()
| 释放新创建的PDF对象或克隆的PDF对象， 该对象与 PDF文档或其他PDF对象无关，且将不再使用。 更多...

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

## 额外继承的成员函数
静态 Public 属性 继承自 FSDK::PDFObject
static | e_Array
| PDF数组对象。
static | e_Boolean
| PDF布尔对象。
static | e_Dictionary
| PDF字典对象。
static | e_InvalidType
| PDF对象类型的枚举。 更多...
static | e_Name
| PDF名称对象。
static | e_Null
| PDF空对象。
static | e_Number
| PDF数字对象。
static | e_Reference
| PDF引用对象。
static | e_Stream
| PDF流对象。
static | e_String
| PDF字符串对象。

## 详细描述

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

参见
  FSDK.PDFObject

## 成员函数说明

## ◆ Create()

static FSDK::PDFDictionary::Create | ( |  | ) |
| static

创建新的字典对象。

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

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

## ◆ GetElement()

FSDK::PDFDictionary::GetElement | ( | key |  | ) |

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

参数

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

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

## ◆ GetKey()

FSDK::PDFDictionary::GetKey | ( | position |  | ) |

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

参数

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

返回
  指定条目的键。

## ◆ GetValue()

FSDK::PDFDictionary::GetValue | ( | position |  | ) |

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

参数

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

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

## ◆ HasKey()

FSDK::PDFDictionary::HasKey | ( | key |  | ) |

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

参数

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

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

## ◆ MoveNext()

FSDK::PDFDictionary::MoveNext | ( | position |  | ) |

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

参数

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

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

## ◆ RemoveAt()

FSDK::PDFDictionary::RemoveAt | ( | key |  | ) |

移除由键指定的条目。

参数

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

返回
  None.

## ◆ SetAt()

FSDK::PDFDictionary::SetAt | ( | key | ,
|  | pdf_object |
| ) |  |

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

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

参数

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

返回
  None.

## ◆ SetAtBoolean()

FSDK::PDFDictionary::SetAtBoolean | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

## ◆ SetAtDateTime()

FSDK::PDFDictionary::SetAtDateTime | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

## ◆ SetAtFloat()

FSDK::PDFDictionary::SetAtFloat | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

## ◆ SetAtInteger()

FSDK::PDFDictionary::SetAtInteger | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

## ◆ SetAtMatrix()

FSDK::PDFDictionary::SetAtMatrix | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

## ◆ SetAtName()

FSDK::PDFDictionary::SetAtName | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

## ◆ SetAtRect()

FSDK::PDFDictionary::SetAtRect | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

## ◆ SetAtReference()

FSDK::PDFDictionary::SetAtReference | ( | key | ,
|  | pdf_object | ,
|  | document |
| ) |  |

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

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

参数

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

返回
  None.

## ◆ SetAtString()

FSDK::PDFDictionary::SetAtString | ( | key | ,
|  | value |
| ) |  |

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

参数

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

返回
  None.

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