Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::IconProviderCallback类 参考

## Public 成员函数
| CanChangeColor (annot_type, icon_name)
| 用于检查当前图标提供程序是否支持为指定类型更改颜色的回调函数。 更多...
| GetDisplayHeight (annot_type, icon_name)
| 用于获取指定图标显示高度的回调函数，以设备大小（通常为像素）为单位。 更多...
| GetDisplayWidth (annot_type, icon_name)
| 用于获取指定图标显示宽度的回调函数，以设备大小（通常为像素）为单位。 更多...
| GetIcon (annot_type, icon_name, color, annot_dict)
| 用于获取指定类型的图标作为PDF页面内容的回调函数。 更多...
| GetProviderID ()
| 用于获取提供程序ID的回调函数。 更多...
| GetProviderVersion ()
| 用于获取提供程序版本的回调函数。 更多...
| GetShadingColor (annot_type, icon_name, referenced_color, shading_index, out_shading_color)
| 用于获取当前图标提供程序是否支持指定类型的渐变颜色的回调函数。 目前，仅支持具有两个颜色值的类型2渐变设置。 更多...
| HasIcon (annot_type, icon_name)
| 用于检查当前图标提供程序是否支持指定类型的图标的回调函数。 更多...
| Release ()
| 用于释放当前回调对象本身的回调函数。 更多...

## 详细描述

此类表示作为自定义注释图标提供程序的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现， 用户也可以选择在必要时实现某些或所有重置虚函数。 图标提供程序只能用于注释、文件附件、图章注释。
图标提供程序的ID和版本被视为图标提供程序的名称，因此请通过回调函数 FSDK.IconProviderCallback.GetProviderID 和 FSDK.IconProviderCallback.GetProviderVersion 为不同的图标提供程序提供不同的"ID + 版本"。

## 成员函数说明

## ◆ CanChangeColor()

FSDK::IconProviderCallback::CanChangeColor | ( | annot_type | ,
|  | icon_name |
| ) |  |

用于检查当前图标提供程序是否支持为指定类型更改颜色的回调函数。

参数

  [in] | annot_type | 注释类型。它应该是 FSDK.Annot.e_Note、 FSDK.Annot.e_FileAttachment 和 FSDK.Annot.e_Stamp 之一。
  [in] | icon_name | 注释的图标名称。

返回
  true表示当前图标提供程序支持为指定的图标类型更改颜色， 而false表示不支持。

## ◆ GetDisplayHeight()

FSDK::IconProviderCallback::GetDisplayHeight | ( | annot_type | ,
|  | icon_name |
| ) |  |

用于获取指定图标显示高度的回调函数，以设备大小（通常为像素）为单位。

参数

  [in] | annot_type | 注释类型。它应该是 FSDK.Annot.e_Note、 FSDK.Annot.e_FileAttachment 和 FSDK.Annot.e_Stamp 之一。
  [in] | icon_name | 注释的图标名称。

返回
  显示的高度。

## ◆ GetDisplayWidth()

FSDK::IconProviderCallback::GetDisplayWidth | ( | annot_type | ,
|  | icon_name |
| ) |  |

用于获取指定图标显示宽度的回调函数，以设备大小（通常为像素）为单位。

参数

  [in] | annot_type | 注释类型。它应该是 FSDK.Annot.e_Note、 FSDK.Annot.e_FileAttachment 和 FSDK.Annot.e_Stamp 之一。
  [in] | icon_name | 注释的图标名称。

返回
  显示的宽度。

## ◆ GetIcon()

FSDK::IconProviderCallback::GetIcon | ( | annot_type | ,
|  | icon_name | ,
|  | color | ,
|  | annot_dict |
| ) |  |

用于获取指定类型的图标作为PDF页面内容的回调函数。

参数

  [in] | annot_type | 注释类型。它应该是 FSDK.Annot.e_Note、 FSDK.Annot.e_FileAttachment 和 FSDK.Annot.e_Stamp 之一。
  [in] | icon_name | 注释的图标名称。
  [in] | color | 注释的图标颜色。格式：0xAARRGGBB。
  [in] | annot_dict | 注释字典。

返回
  其内容将用作图标的PDF页面对象。

## ◆ GetProviderID()

FSDK::IconProviderCallback::GetProviderID | ( |  | ) |

用于获取提供程序ID的回调函数。

图标提供程序的ID和版本被视为图标提供程序的名称，因此请为不同的 图标提供程序提供不同的"ID + 版本"。

返回
  提供程序ID。

## ◆ GetProviderVersion()

FSDK::IconProviderCallback::GetProviderVersion | ( |  | ) |

用于获取提供程序版本的回调函数。

图标提供程序的ID和版本被视为图标提供程序的名称，因此请为不同的 图标提供程序提供不同的"ID + 版本"。

返回
  版本字符串。

## ◆ GetShadingColor()

FSDK::IconProviderCallback::GetShadingColor | ( | annot_type | ,
|  | icon_name | ,
|  | referenced_color | ,
|  | shading_index | ,
|  | out_shading_color |
| ) |  |

用于获取当前图标提供程序是否支持指定类型的渐变颜色的回调函数。 目前，仅支持具有两个颜色值的类型2渐变设置。

参数

  [in] | annot_type | 注释类型。它应该是 FSDK.Annot.e_Note、 FSDK.Annot.e_FileAttachment 和 FSDK.Annot.e_Stamp 之一。
  [in] | icon_name | 注释的图标名称。
  [in] | referenced_color | 参考颜色。格式：0xRRGGBB。
  [in] | shading_index | 渐变的索引颜色，从0开始。 如果渐变颜色多于一个，此函数将被多次调用。
  [out] | out_shading_color | 接收两个渐变颜色值的输出参数。

返回
  true 表示成功，而 false 表示失败。

## ◆ HasIcon()

FSDK::IconProviderCallback::HasIcon | ( | annot_type | ,
|  | icon_name |
| ) |  |

用于检查当前图标提供程序是否支持指定类型的图标的回调函数。

参数

  [in] | annot_type | 注释类型。它应该是 FSDK.Annot.e_Note、 FSDK.Annot.e_FileAttachment 和 FSDK.Annot.e_Stamp 之一。
  [in] | icon_name | 注释的图标名称。

返回
  true表示当前图标提供程序支持指定的图标，而false表示不支持。

## ◆ Release()

FSDK::IconProviderCallback::Release | ( |  | ) |

用于释放当前回调对象本身的回调函数。

返回
  无。