Foxit PDF SDK

Public Member Functions | List of all members
FSDK.EmbeddedGotoTarget Class Reference

## Public Member Functions
| constructor (document)
| Constructor, with PDF document. More...
| constructor (document, target_object)
| Constructor, with PDF dictionary. More...
| GetAttachedFileName ()
| Get the embedded file name, which is used in "EmbeddedFile" name tree of current target file. More...
| GetDict ()
| Get PDF dictionary of current object. More...
| GetFileAttachmentAnnotIndex ()
| Get the annotation index which specifies a file attachment annotation in a specified page. More...
| GetPageIndex ()
| Get the page index which specifies the page that contains the target file attachment annotation. More...
| GetRelationship ()
| Get relationship between current target object and the object that current target object belongs to. More...
| GetTarget ()
| Get the target which specifies additional path information to the target document. More...
| IsEmpty ()
| Check whether current object is empty or not. More...
| SetAttachedFileName (embed_file_name)
| Set the embedded file name, which is used in "EmbeddedFile" name tree of current target file. More...
| SetFileAttachmentAnnotIndex (annot_index)
| Set the annotation index which specifies a file attachment annotation in a specified page. More...
| SetPageIndex (page_index)
| Set the page index which specifies the page that contains the target file attachment annotation. More...
| SetRelationship (relationship)
| Set relationship between current target object and the object that current target object belongs to. More...
| SetTarget (target)
| Set the target which specifies additional path information to the target document. More...

## Detailed Description

The target of an embedded go-to action is the document in which the destination lives.

See also
  FSDK.EmbeddedGotoAction

## Member Function Documentation

## ◆ constructor() [1/2]

FSDK.EmbeddedGotoTarget.constructor | ( | document |  | ) |

Constructor, with PDF document.

This constructor is to construct a new embedded goto target object (without any data).

Parameters

  [in] | document | A valid PDF document object.

## ◆ constructor() [2/2]

FSDK.EmbeddedGotoTarget.constructor | ( | document | ,
|  | target_object |
| ) |  |

Constructor, with PDF dictionary.

Parameters

  [in] | document | A valid PDF document object.
  [in] | target_object | A PDF dictionary that represents the embedded goto target data.

## ◆ GetAttachedFileName()

FSDK.EmbeddedGotoTarget.GetAttachedFileName | ( |  | ) |

Get the embedded file name, which is used in "EmbeddedFile" name tree of current target file.

This is useful only when relationship is "C". If this property is a valid string, that means the target file is an embedded file defined in "EmbeddedFiles" name tree.

Returns
  Embedded file name.

## ◆ GetDict()

FSDK.EmbeddedGotoTarget.GetDict | ( |  | ) |

Get PDF dictionary of current object.

Returns
  The PDF dictionary.If there is any error, this function will return null.

## ◆ GetFileAttachmentAnnotIndex()

FSDK.EmbeddedGotoTarget.GetFileAttachmentAnnotIndex | ( |  | ) |

Get the annotation index which specifies a file attachment annotation in a specified page.

This is useful only when relationship is "C". If this property exists, that means the target file is related to a file attachment annotation, and this property just specifies the file attachment annotation in the specified page. Function FSDK.EmbeddedGotoTarget.GetPageIndex can be used to get the page index specifying the page that contains the target file attachment annotation.

Returns
  Annotation index which specifies a file attachment annotation. Valid value would starts from 0. -1 means no such property.

## ◆ GetPageIndex()

FSDK.EmbeddedGotoTarget.GetPageIndex | ( |  | ) |

Get the page index which specifies the page that contains the target file attachment annotation.

This is useful only when relationship is "C". If this property exists, that means the target file is related to a file attachment annotation. And this property just specifies the page which contains the file attachment annotation. Function FSDK.EmbeddedGotoTarget.GetFileAttachmentAnnotIndex can be used to get the annotation index of the target file attachment annotation.

Returns
  Page index. Valid value would starts from 0. -1 means no such property

## ◆ GetRelationship()

FSDK.EmbeddedGotoTarget.GetRelationship | ( |  | ) |

Get relationship between current target object and the object that current target object belongs to.

The relationship is the relationship between current target object and the object that current target object belongs to. Currently, the relationship could be one of following:

- "P": current target object is the parent of the object that current target object belongs to.
- "C": current target object is the child of the object that current target object belongs to.

Returns
  Relationship string.

## ◆ GetTarget()

FSDK.EmbeddedGotoTarget.GetTarget | ( |  | ) |

Get the target which specifies additional path information to the target document.

Returns
  An embedded goto target object. If the return value of function FSDK.EmbeddedGotoTarget.IsEmpty for the returned embedded goto target object is true, that means current target object represents the final target file.

## ◆ IsEmpty()

FSDK.EmbeddedGotoTarget.IsEmpty | ( |  | ) |

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
  true means current object is empty, while false means not.

## ◆ SetAttachedFileName()

FSDK.EmbeddedGotoTarget.SetAttachedFileName | ( | embed_file_name |  | ) |

Set the embedded file name, which is used in "EmbeddedFile" name tree of current target file.

This is useful only when relationship is "C". If this property exists, that means the target file is an embedded file defined in "EmbeddedFiles" name tree.

Parameters

  [in] | embed_file_name | Name for embedded file.

Returns
  None.

## ◆ SetFileAttachmentAnnotIndex()

FSDK.EmbeddedGotoTarget.SetFileAttachmentAnnotIndex | ( | annot_index |  | ) |

Set the annotation index which specifies a file attachment annotation in a specified page.

This is useful only when relationship is "C". If this property exists, that means the target file is related to a file attachment annotation, and this property just specifies the file attachment annotation in the specified page. Function FSDK.EmbeddedGotoTarget.SetPageIndex can be used to set the page index specifying the page that contains the target file attachment annotation.

Parameters

  [in] | annot_index | Annotation index to specify the file attachment annotation. Valid range: from 0 to (count-1). count means the annotation count in that specified page.

Returns
  None.

## ◆ SetPageIndex()

FSDK.EmbeddedGotoTarget.SetPageIndex | ( | page_index |  | ) |

Set the page index which specifies the page that contains the target file attachment annotation.

This is useful only when relationship is "C". If this property exists, that means the target file is related to a file attachment annotation, and this property just specifies the page which contains the file attachment annotation. Function FSDK.EmbeddedGotoTarget.SetFileAttachmentAnnotIndex can be used to set the annotation index of the target file attachment annotation.

Parameters

  [in] | page_index | Page index to specify a page which contains the target file attachment annotation. Valid range: from 0 to (count-1). count means the page count of current target PDF file.

Returns
  None.

## ◆ SetRelationship()

FSDK.EmbeddedGotoTarget.SetRelationship | ( | relationship |  | ) |

Set relationship between current target object and the object that current target object belongs to.

The relationship is the relationship between current target object and the object that current target object belongs to. Currently, the relationship could be one of following:

- "P": current target object is the parent of the object that current target object belongs to.
- "C": current target object is the child of the object that current target object belongs to.

Parameters

  [in] | relationship | It should be one of following strings:"P", "C".

Returns
  None.

## ◆ SetTarget()

FSDK.EmbeddedGotoTarget.SetTarget | ( | target |  | ) |

Set the target which specifies additional path information to the target document.

Parameters

  [in] | target | An embedded goto target object. If the return value of function FSDK.EmbeddedGotoTarget.IsEmpty for the returned embedded goto target object is true, that means current target object represents the final target file.

Returns
  None.