Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Destination类 参考

## Public 成员函数
| GetBottom ()
| 获取底部位置值。 更多...
| GetDestArray ()
| 获取目标 PDF 数组。 更多...
| GetLeft ()
| 获取左侧位置值。 更多...
| GetPageIndex (document)
| 获取目标页面的索引。 更多...
| GetRight ()
| 获取右侧位置值。 更多...
| GetTop ()
| 获取顶部位置值。 更多...
| GetZoomFactor ()
| 获取缩放系数。 更多...
| GetZoomMode ()
| 获取缩放模式。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| IsLeftNull ()
| 检查左侧值是否为空对象。 更多...
| IsTopNull ()
| 检查顶部值是否为空对象。 更多...

## 静态 Public 成员函数
static | CreateFitBBox (document, page_index)
| 为缩放模式 FSDK.Destination.e_ZoomFitBBox 创建目标对象。 更多...
static | CreateFitBHorz (document, page_index, top)
| 为缩放模式 FSDK.Destination.e_ZoomFitBHorz 创建目标对象。 更多...
static | CreateFitBVert (document, page_index, left)
| 为缩放模式 FSDK.Destination.e_ZoomFitBVert 创建目标对象。 更多...
static | CreateFitHorz (document, page_index, top)
| 为缩放模式 FSDK.Destination.e_ZoomFitHorz 创建目标对象。 更多...
static | CreateFitPage (document, page_index)
| 为缩放模式 FSDK.Destination.e_ZoomFitPage 创建目标对象。 更多...
static | CreateFitRect (document, page_index, left, bottom, right, top)
| 为缩放模式 FSDK.Destination.e_ZoomFitRect 创建目标对象。 更多...
static | CreateFitVert (document, page_index, left)
| 为缩放模式 FSDK.Destination.e_ZoomFitVert 创建目标对象。 更多...
static | CreateFromPDFArray (document, opdf_array)
| 从现有目标数组创建目标对象。 更多...
static | CreateXYZ (document, page_index, left, top, zoom_factor)
| 为缩放模式 FSDK.Destination.e_ZoomXYZ 创建目标对象。 更多...

## 静态 Public 属性
static | e_ZoomFitBBox
| 显示页面时在显示区域内完全适合页面的边界框。 更多...
static | e_ZoomFitBHorz
| 显示页面时在显示区域内适合页面边界框的整个宽度。 更多...
static | e_ZoomFitBVert
| 显示页面时在显示区域内适合页面边界框的整个高度。 更多...
static | e_ZoomFitHorz
| 显示页面时在显示区域内适合页面的整个宽度。 更多...
static | e_ZoomFitPage
| 显示页面时在显示区域内适合整个页面。 更多...
static | e_ZoomFitRect
| 显示页面时在显示区域内完全适合指定矩形中的页面内容。 更多...
static | e_ZoomFitVert
| 显示页面时在显示区域内适合页面的整个高度。 更多...
static | e_ZoomXYZ
| 缩放模式的枚举。 更多...

## 详细描述

目标（Destination）定义了 PDF 文档的特定视图，包括以下项目：

- 要显示的文档页面。
- 该页面上文档窗口的位置。
- 显示页面时使用的放大（缩放）系数。

目标可能与书签或某些类型的操作相关联。在每种情况下，目标指定 当打开书签项或链接注释或执行操作时要呈现的文档视图。
此类提供了为不同缩放模式创建目标对象以及获取目标数据的函数。

参见
  FSDK.Bookmark
  FSDK.GotoAction
  FSDK.RemoteGotoAction
  FSDK.EmbeddedGotoAction

## 成员函数说明

## ◆ CreateFitBBox()

static FSDK::Destination::CreateFitBBox | ( | document | ,
|  | page_index |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomFitBBox 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。

返回
  新的目标对象。

## ◆ CreateFitBHorz()

static FSDK::Destination::CreateFitBHorz | ( | document | ,
|  | page_index | ,
|  | top |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomFitBHorz 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。
  [in] | top | 顶部边缘的垂直坐标

返回
  新的目标对象。

## ◆ CreateFitBVert()

static FSDK::Destination::CreateFitBVert | ( | document | ,
|  | page_index | ,
|  | left |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomFitBVert 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。
  [in] | left | 左边缘的水平坐标。

返回
  新的目标对象。

## ◆ CreateFitHorz()

static FSDK::Destination::CreateFitHorz | ( | document | ,
|  | page_index | ,
|  | top |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomFitHorz 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。
  [in] | top | 顶部边缘的垂直坐标。

返回
  新的目标对象。

## ◆ CreateFitPage()

static FSDK::Destination::CreateFitPage | ( | document | ,
|  | page_index |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomFitPage 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。

返回
  新的目标对象。

## ◆ CreateFitRect()

static FSDK::Destination::CreateFitRect | ( | document | ,
|  | page_index | ,
|  | left | ,
|  | bottom | ,
|  | right | ,
|  | top |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomFitRect 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。
  [in] | left | 矩形的左侧坐标。
  [in] | bottom | 矩形的底部坐标。
  [in] | right | 矩形的右侧坐标。
  [in] | top | 矩形的顶部坐标。

返回
  新的目标对象。

## ◆ CreateFitVert()

static FSDK::Destination::CreateFitVert | ( | document | ,
|  | page_index | ,
|  | left |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomFitVert 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。
  [in] | left | 左边缘的水平坐标。

返回
  新的目标对象。

## ◆ CreateFromPDFArray()

static FSDK::Destination::CreateFromPDFArray | ( | document | ,
|  | opdf_array |
| ) |  |
| static

从现有目标数组创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | pdf_array | 目标 PDF 数组。此 PDF 数组可以从类型为 FSDK.PDFNameTree.e_Dests 的 FSDK.PDFNameTree 中检索。

返回
  新的目标对象。

## ◆ CreateXYZ()

static FSDK::Destination::CreateXYZ | ( | document | ,
|  | page_index | ,
|  | left | ,
|  | top | ,
|  | zoom_factor |
| ) |  |
| static

为缩放模式 FSDK.Destination.e_ZoomXYZ 创建目标对象。

参数

  [in] | document | 有效的 PDF 文档对象。
  [in] | page_index | PDF 文档中目标页面的索引。
  [in] | left | 作为页面左上位置的位置的水平坐标值。
  [in] | top | 作为页面左上位置的位置的垂直坐标值。
  [in] | zoom_factor | 缩放系数值。

返回
  新的目标对象。

## ◆ GetBottom()

FSDK::Destination::GetBottom | ( |  | ) |

获取底部位置值。

仅当缩放模式为 FSDK.Destination.e_ZoomFitRect 时才有用。 对于其他缩放模式，此函数将为 0.0f。

返回
  底部位置值。

## ◆ GetDestArray()

FSDK::Destination::GetDestArray | ( |  | ) |

获取目标 PDF 数组。

返回
  目标 PDF 数组。如果出现任何错误，此函数将返回 null。

## ◆ GetLeft()

FSDK::Destination::GetLeft | ( |  | ) |

获取左侧位置值。

仅当缩放模式为 FSDK.Destination.e_ZoomXYZ、FSDK.Destination.e_ZoomFitVert、 FSDK.Destination.e_ZoomFitRect 或 FSDK.Destination.e_ZoomFitBVert 时才有用。 特别是对于 FSDK.Destination.e_ZoomXYZ、FSDK.Destination.e_ZoomFitVert 和 FSDK.Destination.e_ZoomFitBVert，左侧值可能是空对象， 这意味着只需使用应用程序的当前左侧值作为目标的左侧值。 对于这种情况，此函数将返回 0.0f。为了检查左侧值是否仅为 0 或 空对象，建议用户调用函数 FSDK.Destination.IsLeftNull。
对于其他缩放模式，此函数将返回 0.0f。

返回
  左侧位置值。

## ◆ GetPageIndex()

FSDK::Destination::GetPageIndex | ( | document |  | ) |

获取目标页面的索引。

参数

  [in] | document | 有效的 PDF 文档对象。

返回
  页面索引，从 0 开始。如果出现任何错误，此函数将返回 -1。

## ◆ GetRight()

FSDK::Destination::GetRight | ( |  | ) |

获取右侧位置值。

仅当缩放模式为 FSDK.Destination.e_ZoomFitRect 时才有用。 对于其他缩放模式，此函数将为 0.0f。

返回
  右侧位置值。

## ◆ GetTop()

FSDK::Destination::GetTop | ( |  | ) |

获取顶部位置值。

仅当缩放模式为 FSDK.Destination.e_ZoomXYZ、FSDK.Destination.e_ZoomFitHorz、 FSDK.Destination.e_ZoomFitBHorz 或 FSDK.Destination.e_ZoomFitRect 时才有用。 特别是对于 FSDK.Destination.e_ZoomXYZ、FSDK.Destination.e_ZoomFitHorz 和 FSDK.Destination.e_ZoomFitBHorz，顶部值可能是空对象，这意味着只需 使用应用程序的当前顶部值作为目标的顶部值。对于这种情况， 此函数将返回 0.0f。为了检查左侧值是否仅为 0 或空对象， 建议用户调用函数 FSDK.Destination.IsTopNull。
对于其他缩放模式，此函数将返回 0.0f。

返回
  顶部位置值。

## ◆ GetZoomFactor()

FSDK::Destination::GetZoomFactor | ( |  | ) |

获取缩放系数。

仅当缩放模式为 FSDK.Destination.e_ZoomXYZ 时才有用。 对于 FSDK.Destination.e_ZoomXYZ，如果缩放系数为 0， 这意味着只需使用应用程序的当前缩放系数作为目标缩放系数。
对于其他缩放模式，此函数将为 0.0f。

返回
  缩放系数。

## ◆ GetZoomMode()

FSDK::Destination::GetZoomMode | ( |  | ) |

获取缩放模式。

返回
  缩放模式值。请参考从 FSDK.Destination.e_ZoomXYZ 开始的值， 这将是这些值之一。如果没有缩放模式或缩放模式未知，此函数将返回 0。

## ◆ IsEmpty()

FSDK::Destination::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，而 false 表示不是。

## ◆ IsLeftNull()

FSDK::Destination::IsLeftNull | ( |  | ) |

检查左侧值是否为空对象。

仅当缩放模式为 FSDK.Destination.e_ZoomXYZ、FSDK.Destination.e_ZoomFitVert 或 FSDK.Destination.e_ZoomFitBVert 时才有用。 此函数可用于检查左侧值是否为空对象。 对于其他缩放模式，此函数将返回 false。

返回
  true 表示左侧值是空对象，而 false 表示左侧值不是空对象， 并且可以通过函数 FSDK.Destination.GetLeft 检索左侧值。

## ◆ IsTopNull()

FSDK::Destination::IsTopNull | ( |  | ) |

检查顶部值是否为空对象。

仅当缩放模式为 FSDK.Destination.e_ZoomXYZ、FSDK.Destination.e_ZoomFitHorz、 或 FSDK.Destination.e_ZoomFitBHorz 时才有用。 此函数可用于检查顶部值是否为空对象。 对于其他缩放模式，此函数将返回 false。

返回
  true 表示顶部值是空对象，而 false 表示顶部值不是空对象， 并且可以通过函数 FSDK.Destination.GetTop 检索顶部值。

## 类成员变量说明

## ◆ e_ZoomFitBBox

FSDK::Destination::e_ZoomFitBBox
| static

显示页面时在显示区域内完全适合页面的边界框。

如果使用此模式，则表示页面内容应放大到刚好可以 在水平和垂直方向上都能在显示区域内完全适合其边界框。 如果所需的水平和垂直放大系数不同， 使用两者中较小的一个，在另一个维度中将边界框居中于显示区域中。

## ◆ e_ZoomFitBHorz

FSDK::Destination::e_ZoomFitBHorz
| static

显示页面时在显示区域内适合页面边界框的整个宽度。

如果使用此模式，则表示页面内容应放大到 刚好可以在显示区域内适合页面边界框的整个宽度。

## ◆ e_ZoomFitBVert

FSDK::Destination::e_ZoomFitBVert
| static

显示页面时在显示区域内适合页面边界框的整个高度。

如果使用此模式，则表示页面内容应放大到 刚好可以在显示区域内适合页面边界框的整个高度。

## ◆ e_ZoomFitHorz

FSDK::Destination::e_ZoomFitHorz
| static

显示页面时在显示区域内适合页面的整个宽度。

如果使用此模式，则表示页面内容应放大到 刚好可以在显示区域内适合页面的整个宽度。

## ◆ e_ZoomFitPage

FSDK::Destination::e_ZoomFitPage
| static

显示页面时在显示区域内适合整个页面。

如果使用此模式，则表示页面内容应放大到刚好可以 在水平和垂直方向上都能在显示区域内适合整个页面。 如果所需的水平和垂直放大系数不同， 使用两者中较小的一个，在另一个维度中将页面居中于窗口中。

## ◆ e_ZoomFitRect

FSDK::Destination::e_ZoomFitRect
| static

显示页面时在显示区域内完全适合指定矩形中的页面内容。

如果使用此模式，则表示页面内容应放大到刚好可以 在水平和垂直方向上都能在显示区域内完全适合指定矩形中的页面内容。 如果所需的水平和垂直放大系数不同，使用两者中较小的一个， 在另一个维度中将矩形居中于显示区域中。

## ◆ e_ZoomFitVert

FSDK::Destination::e_ZoomFitVert
| static

显示页面时在显示区域内适合页面的整个高度。

如果使用此模式，则表示页面内容应放大到 刚好可以在显示区域内适合页面的整个高度。

## ◆ e_ZoomXYZ

FSDK::Destination::e_ZoomXYZ
| static

缩放模式的枚举。

此枚举的值应单独使用。

使用指定的位置和指定的缩放系数显示页面。

如果使用此模式，则表示页面的指定位置在渲染页面时将被视为左上位置， 并且此位置应位于显示区域的左上角。 页面内容应按指定的缩放系数放大。