Foxit PDF SDK
fsdk.Portfolio Class Reference

Public Member Functions

def GetInitialFileSpecKeyName ()
 Get the key name of an attachment (as file specification) which should be the initial document. More...
 
def GetInitialViewMode ()
 Get initial view mode. More...
 
def GetPortfolioPDFDoc ()
 Get related portfolio PDF document object. More...
 
def GetRootNode ()
 Get root node which is always a folder node. More...
 
def GetSchemaFields ()
 Get schema fields. More...
 
def GetSortingFieldKeyName ()
 Get the key name of a schema field which is used for sorting. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def IsSortedInAscending ()
 Check whether nodes should be sorted in ascending order or not. More...
 
def SetInitialFileSpecKeyName (name)
 Set the key name of an attachment (as file specification) which should be the initial document. More...
 
def SetInitialViewMode (mode)
 Set initial view mode. More...
 
def SetSchemaFields (field_array)
 Set schema fields. More...
 
def SetSortingFieldKeyName (name)
 Set the key name of a schema field for sorting. More...
 
def SetSortingOrder (use_ascending_order)
 Set the boolean to decide whether nodes should be sorted in ascending order or not. More...
 

Detailed Description

PDF portfolio is a combination of files with different formats. PDF portfolio itself is a PDF document, and then files with different formats can be embedded into this kind of PDF document.
Class Portfolio can be used to create a new blank PDF portfolio or access an existed portfolio PDF document, and then to get/set portfolio properties and to access root node in order to enumerate all nodes or add/remove node.

Member Function Documentation

◆ GetInitialFileSpecKeyName()

def fsdk.Portfolio.GetInitialFileSpecKeyName ( )

Get the key name of an attachment (as file specification) which should be the initial document.

Class Attachments can be used to retrieve the file specification object by key name.

Returns
Key name of an attachment(as file specification). If an empty string is returned, that means the related portfolio PDF document should be the initial document.

◆ GetInitialViewMode()

def fsdk.Portfolio.GetInitialViewMode ( )

Get initial view mode.

Returns
Initial view mode. Please refer to values starting from fsdk.PortfolioE_InitialViewUnknownMode and it would be one of these values.

◆ GetPortfolioPDFDoc()

def fsdk.Portfolio.GetPortfolioPDFDoc ( )

Get related portfolio PDF document object.

Returns
Related portfolio PDF document object.

◆ GetRootNode()

def fsdk.Portfolio.GetRootNode ( )

Get root node which is always a folder node.

PDF portfolio organizes files into a hierarchical structure – a tree with a single root folder (also known as root node) as the common ancestor for all other folders and files.

Returns
A portfolio node object that represents the root node.

◆ GetSchemaFields()

def fsdk.Portfolio.GetSchemaFields ( )

Get schema fields.

Schema fields are used to decide which properties of file node or folder node are to be shown in application.

Returns
Schema fields. Order of these fields are decided by their index order in returned array.

◆ GetSortingFieldKeyName()

def fsdk.Portfolio.GetSortingFieldKeyName ( )

Get the key name of a schema field which is used for sorting.

Returns
Key name of a schema field which is used for sorting.

◆ IsEmpty()

def fsdk.Portfolio.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.

◆ IsSortedInAscending()

def fsdk.Portfolio.IsSortedInAscending ( )

Check whether nodes should be sorted in ascending order or not.

Returns
true means nodes should be sorted in ascending order with specified field, while false means nodes should sorted in descending order with specified field.

◆ SetInitialFileSpecKeyName()

def fsdk.Portfolio.SetInitialFileSpecKeyName (   name)

Set the key name of an attachment (as file specification) which should be the initial document.

Function fsdk.PortfolioFileNode.GetKeyName can be used to get the key name of a file specification associated with a file node. Or use class Attachments to retrieve a key name of a file specification.

Parameters
[in]nameKey name of an attachment(as file specification). If an empty string is returned, that means the related portfolio PDF document should be the initial document.
Returns
None.

◆ SetInitialViewMode()

def fsdk.Portfolio.SetInitialViewMode (   mode)

Set initial view mode.

Parameters
[in]modeInitial view mode. Please refer to values starting from fsdk.PortfolioE_InitialViewDetailMode and it should be one of these values except fsdk.PortfolioE_InitialViewUnknownMode .
Returns
None.

◆ SetSchemaFields()

def fsdk.Portfolio.SetSchemaFields (   field_array)

Set schema fields.

Schema fields are used to decide which properties of file node or folder node are to be shown in application.
When this function succeeds, all the old schema fields will be removed and input ones will be used instead.

Parameters
[in]field_arrayNew schema fields array. Order of these fields are decided by their index order in this array.
Returns
None.

◆ SetSortingFieldKeyName()

def fsdk.Portfolio.SetSortingFieldKeyName (   name)

Set the key name of a schema field for sorting.

Parameters
[in]nameKey name of a schema field for sorting.
Returns
None.

◆ SetSortingOrder()

def fsdk.Portfolio.SetSortingOrder (   use_ascending_order)

Set the boolean to decide whether nodes should be sorted in ascending order or not.

Parameters
[in]use_ascending_orderA boolean to decide the sorted order: true means nodes should be sorted in ascending order with specified field, while false means nodes should sorted in descending order with specified field.
Returns
None.