Foxit PDF SDK
fsdk.WrapperData Class Reference

Public Member Functions

def GetApp_id ()
 Get application identity to indicate applications to open this wrapper data. More...
 
def GetDescription ()
 Get description for wrapper file to show applications or confront users prompt information. More...
 
def GetUri ()
 Get the URI for consumers to get more information. More...
 
def GetVersion ()
 Get wrapper version. More...
 
def Set (version, type, app_id, uri, description)
 Set value.
More...
 
def SetApp_id (value)
 Set application identity to indicate applications to open this wrapper data. More...
 
def SetDescription (value)
 Set description for wrapper file to show applications or confront users prompt information. More...
 
def SetUri (value)
 Set the URI for consumers to get more information. More...
 
def SetVersion (value)
 Set wrapper version. More...
 

Detailed Description

This class represents wrapper data, which is used for a wrapped PDF document.

Member Function Documentation

◆ GetApp_id()

fsdk.WrapperData.GetApp_id ( )

Get application identity to indicate applications to open this wrapper data.

Returns
Application identity to indicate applications to open this wrapper data.

◆ GetDescription()

fsdk.WrapperData.GetDescription ( )

Get description for wrapper file to show applications or confront users prompt information.

Returns
Description for wrapper file to show applications or confront users prompt information.

◆ GetUri()

fsdk.WrapperData.GetUri ( )

Get the URI for consumers to get more information.

Returns
The URI for consumers to get more information.

◆ GetVersion()

fsdk.WrapperData.GetVersion ( )

Get wrapper version.

Returns
Wrapper version.

◆ Set()

def fsdk.WrapperData.Set (   version,
  type,
  app_id,
  uri,
  description 
)

Set value.

Parameters
[in]versionWrapper version.
[in]typeWrapper type to indicate a type of the current wrapper file.
[in]app_idApplication identity to indicate applications to open this wrapper data.
[in]uriURI for consumers to get more information.
[in]descriptionDescription for wrapper file to show applications or confront users prompt information.
Returns
None.

◆ SetApp_id()

fsdk.WrapperData.SetApp_id (   value)

Set application identity to indicate applications to open this wrapper data.

Parameters
[in]valueApplication identity to indicate applications to open this wrapper data.
Returns
None.

◆ SetDescription()

fsdk.WrapperData.SetDescription (   value)

Set description for wrapper file to show applications or confront users prompt information.

Parameters
[in]valueDescription for wrapper file to show applications or confront users prompt information.
Returns
None.

◆ SetUri()

fsdk.WrapperData.SetUri (   value)

Set the URI for consumers to get more information.

Parameters
[in]valueThe URI for consumers to get more information.
Returns
None.

◆ SetVersion()

fsdk.WrapperData.SetVersion (   value)

Set wrapper version.

Parameters
[in]valueWrapper version.
Returns
None.