Foxit PDF SDK
fsdk.MenuItemConfig Class Reference

Public Member Functions

def GetEnable ()
 Get (Only used by
More...
 
def GetExec ()
 Get (Only used by
More...
 
def GetMarked ()
 Get (Only used by
More...
 
def GetName ()
 Get the language-independent name of the menu item. More...
 
def GetParent ()
 Get the name of the parent menu item. More...
 
def GetPos ()
 Get the position within the submenu to locate the new menu item. More...
 
def GetPos_str ()
 Get (Only used by
More...
 
def GetUser ()
 Get the user string (language-dependent name) to display as the menu item name. More...
 
def Set (name, user, parent, pos, pos_str, exec, enable, marked)
 Set values.
More...
 
def SetEnable (value)
 Set (Only used by
More...
 
def SetExec (value)
 Set (Only used by
More...
 
def SetMarked (value)
 Set (Only used by
More...
 
def SetName (value)
 Set the language-independent name of the menu item. More...
 
def SetParent (value)
 Set the name of the parent menu item. More...
 
def SetPos (value)
 Set the position within the submenu to locate the new menu item. More...
 
def SetPos_str (value)
 Set (Only used by
More...
 
def SetUser (value)
 Set the user string (language-dependent name) to display as the menu item name. More...
 

Detailed Description

This class represents menu item config.

Member Function Documentation

◆ GetEnable()

fsdk.MenuItemConfig.GetEnable ( )

Get (Only used by

Returns
(Only used by

◆ GetExec()

fsdk.MenuItemConfig.GetExec ( )

Get (Only used by

Returns
(Only used by

◆ GetMarked()

fsdk.MenuItemConfig.GetMarked ( )

Get (Only used by

Returns
(Only used by

◆ GetName()

fsdk.MenuItemConfig.GetName ( )

Get the language-independent name of the menu item.

Returns
The language-independent name of the menu item.

◆ GetParent()

fsdk.MenuItemConfig.GetParent ( )

Get the name of the parent menu item.

Returns
The name of the parent menu item. Its submenu will have the new menu item added to it.

◆ GetPos()

fsdk.MenuItemConfig.GetPos ( )

Get the position within the submenu to locate the new menu item.

Returns
The position within the submenu to locate the new menu item.

◆ GetPos_str()

fsdk.MenuItemConfig.GetPos_str ( )

Get (Only used by

Returns
(Only used by

◆ GetUser()

fsdk.MenuItemConfig.GetUser ( )

Get the user string (language-dependent name) to display as the menu item name.

Returns
The user string (language-dependent name) to display as the menu item name.

◆ Set()

def fsdk.MenuItemConfig.Set (   name,
  user,
  parent,
  pos,
  pos_str,
  exec,
  enable,
  marked 
)

Set values.

Parameters
[in]nameThe language-independent name of the menu item.
[in]userThe user string (language-dependent name) to display as the menu item name.
[in]parentThe name of the parent menu item. Its submenu will have the new menu item added to it.
[in]posThe position within the submenu to locate the new menu item.
[in]pos_strThe string is a named item in the menu (a language-independent name of a menu item).
[in]execAn expression string to evaluate when the menu item is selected by the user.
[in]enableAn expression string that is evaluated to determine whether to enable the menu item.
[in]markedAn expression string that determines whether the menu item has a check mark next to it.
Returns
None.

◆ SetEnable()

fsdk.MenuItemConfig.SetEnable (   value)

Set (Only used by

Parameters
[in]value(Only used by
Returns
None.

◆ SetExec()

fsdk.MenuItemConfig.SetExec (   value)

Set (Only used by

Parameters
[in]value(Only used by
Returns
None.

◆ SetMarked()

fsdk.MenuItemConfig.SetMarked (   value)

Set (Only used by

Parameters
[in]value(Only used by
Returns
None.

◆ SetName()

fsdk.MenuItemConfig.SetName (   value)

Set the language-independent name of the menu item.

Parameters
[in]valueThe language-independent name of the menu item.
Returns
None.

◆ SetParent()

fsdk.MenuItemConfig.SetParent (   value)

Set the name of the parent menu item.

Parameters
[in]valueThe name of the parent menu item. Its submenu will have the new menu item added to it.
Returns
None.

◆ SetPos()

fsdk.MenuItemConfig.SetPos (   value)

Set the position within the submenu to locate the new menu item.

Parameters
[in]valueThe position within the submenu to locate the new menu item.
Returns
None.

◆ SetPos_str()

fsdk.MenuItemConfig.SetPos_str (   value)

Set (Only used by

Parameters
[in]value(Only used by
Returns
None.

◆ SetUser()

fsdk.MenuItemConfig.SetUser (   value)

Set the user string (language-dependent name) to display as the menu item name.

Parameters
[in]valueThe user string (language-dependent name) to display as the menu item name.
Returns
None.