Foxit PDF SDK
foxit.pdf.PortfolioNode Class Reference
Inheritance diagram for foxit.pdf.PortfolioNode:
foxit.common.Base foxit.pdf.PortfolioFileNode foxit.pdf.PortfolioFolderNode

Public Types

enum  Type { Type.e_TypeUnknown = 0, Type.e_TypeFolder = 1, Type.e_TypeFile = 2 }
 Enumeration for portfolio node type.
More...
 

Public Member Functions

 PortfolioNode (PortfolioNode other)
 Constructor, with another portfolio node object.
More...
 
PortfolioNode.Type GetNodeType ()
 Get node type.
More...
 
bool IsEmpty ()
 Check whether current object is empty or not.
More...
 

Detailed Description

Class PortfolioNode is the base class for all types of portfolio nodes.

Member Enumeration Documentation

◆ Type

Enumeration for portfolio node type.

Values of this enumeration should be used alone.

Enumerator
e_TypeUnknown 

Unknown portfolio node type.

e_TypeFolder 

Portfolio node type: folder.

e_TypeFile 

Portfolio node type: file.

Constructor & Destructor Documentation

◆ PortfolioNode()

foxit.pdf.PortfolioNode.PortfolioNode ( PortfolioNode  other)
inline

Constructor, with another portfolio node object.

Parameters
[in]otherAnother PDF portfolio folder object.

Member Function Documentation

◆ GetNodeType()

PortfolioNode.Type foxit.pdf.PortfolioNode.GetNodeType ( )
inline

Get node type.

Returns
Node type. Please refer to values starting from foxit.pdf.PortfolioNode.Type.e_TypeFolder and this would be one of these values.

◆ IsEmpty()

bool foxit.pdf.PortfolioNode.IsEmpty ( )
inline

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.