Foxit PDF SDK
FoxitPDFSDKPython2.EmbeddedGotoTarget Class Reference
Inheritance diagram for FoxitPDFSDKPython2.EmbeddedGotoTarget:
FoxitPDFSDKPython2.Base

Public Member Functions

def EmbeddedGotoTarget (document)
 Constructor, with PDF document. More...
 
def GetAttachedFileName ()
 Get the embedded file name, which is used in "EmbeddedFile" name tree of current target file. More...
 
def GetDict ()
 Get PDF dictionary of current object. More...
 
def GetFileAttachmentAnnotIndex ()
 Get the annotation index which specifies a file attachment annotation in a specified page. More...
 
def GetPageIndex ()
 Get the page index which specifies the page that contains the target file attachment annotation. More...
 
def GetRelationship ()
 Get relationship between current target object and the object that current target object belongs to. More...
 
def GetTarget ()
 Get the target which specifies additional path information to the target document. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def SetAttachedFileName (embed_file_name)
 Set the embedded file name, which is used in "EmbeddedFile" name tree of current target file. More...
 
def SetFileAttachmentAnnotIndex (annot_index)
 Set the annotation index which specifies a file attachment annotation in a specified page. More...
 
def SetPageIndex (page_index)
 Set the page index which specifies the page that contains the target file attachment annotation. More...
 
def SetRelationship (relationship)
 Set relationship between current target object and the object that current target object belongs to. More...
 
def 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
EmbeddedGotoAction

Constructor & Destructor Documentation

◆ EmbeddedGotoTarget()

def FoxitPDFSDKPython2.EmbeddedGotoTarget.EmbeddedGotoTarget (   document)

Constructor, with PDF document.

Constructor, with another embedded goto target object.

Constructor, with PDF dictionary.

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

Parameters
[in]documentA valid PDF document object.
[in]documentA valid PDF document object.
[in]target_objectA PDF dictionary that represents the embedded goto target data.
[in]actionAnother embedded goto target object.

Member Function Documentation

◆ GetAttachedFileName()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.EmbeddedGotoTarget.GetDict ( )

Get PDF dictionary of current object.

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

◆ GetFileAttachmentAnnotIndex()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.EmbeddedGotoTarget.IsEmpty for the returned embedded goto target object is true, that means current target object represents the final target file.

◆ IsEmpty()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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_nameName for embedded file.
Returns
None.

◆ SetFileAttachmentAnnotIndex()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.EmbeddedGotoTarget.SetPageIndex can be used to set the page index specifying the page that contains the target file attachment annotation.

Parameters
[in]annot_indexAnnotation 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()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.EmbeddedGotoTarget.SetFileAttachmentAnnotIndex can be used to set the annotation index of the target file attachment annotation.

Parameters
[in]page_indexPage 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()

def FoxitPDFSDKPython2.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]relationshipIt should be one of following strings:"P", "C".
Returns
None.

◆ SetTarget()

def FoxitPDFSDKPython2.EmbeddedGotoTarget.SetTarget (   target)

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

Parameters
[in]targetAn embedded goto target object. If the return value of function FoxitPDFSDKPython2.EmbeddedGotoTarget.IsEmpty for the returned embedded goto target object is true, that means current target object represents the final target file.
Returns
None.