Foxit PDF SDK

Public Member Functions | List of all members
FoxitPDFSDKPython3.WidgetMenu Class Reference
Inheritance diagram for FoxitPDFSDKPython3.WidgetMenu:

## Public Member Functions
def | WidgetMenu (other)
| Constructor, with another widget menu object. More...
def | Bold ()
| (Only useful for rich text) Make the rich text bold. More...
def | CanCopy ()
| Check if the text of related XFA widget can be copied. More...
def | CanCut ()
| Check if the text of related XFA widget can be cut. More...
def | CanDelete ()
| Check if the text of related XFA widget can be deleted. More...
def | CanDeSelect ()
| Check if the selection of the text in related XFA widget can be canceled. More...
def | CanPaste ()
| Check if the text of related XFA widget can be pasted. More...
def | CanRedo ()
| Check if the operation of related XFA widget can be redone. More...
def | CanSelectAll ()
| Check if the text of related XFA widget can be selected all. More...
def | CanUndo ()
| Check if the operation of related XFA widget can be undone. More...
def | ClearStyle ()
| (Only useful for rich text) Clear the style of the rich text. More...
def | Copy ()
| Copy the text of related XFA widget. More...
def | Cut ()
| Cut the text of related XFA widget. More...
def | Delete ()
| Delete all the text of related XFA widget. More...
def | DeSelect ()
| Cancel the selection of the text in related XFA widget. More...
def | IsEmpty ()
| Check whether current object is empty or not. More...
def | Italic ()
| (Only useful for rich text) Make the rich text italic. More...
def | Paste (text)
| Paste the text to related XFA widget. More...
def | Redo ()
| Redo the operation of related XFA widget. (No effect for rich text) More...
def | SelectAll ()
| Select all the text of related XFA widget. More...
def | Subscript ()
| (Only useful for rich text) Make the rich text as subscript. More...
def | Superscript ()
| (Only useful for rich text) Make the rich text as superscript. More...
def | Underline ()
| (Only useful for rich text) Underline the rich text. More...
def | Undo ()
| Undo the operation of related XFA widget. (No effect for rich text) More...

## Detailed Description

Class WidgetMenu represents the menu of an XFA widget.

## Constructor & Destructor Documentation

## ◆ WidgetMenu()

def FoxitPDFSDKPython3.WidgetMenu.WidgetMenu | ( |  | other | ) |

Constructor, with another widget menu object.

Parameters

  [in] | other | Another widget menu object.

## Member Function Documentation

## ◆ Bold()

def FoxitPDFSDKPython3.WidgetMenu.Bold | ( |  | ) |

(Only useful for rich text) Make the rich text bold.

Returns
  true means success, while false means failure.

## ◆ CanCopy()

def FoxitPDFSDKPython3.WidgetMenu.CanCopy | ( |  | ) |

Check if the text of related XFA widget can be copied.

Returns
  true means the text can be copied, while false means the text cannot be copied.

## ◆ CanCut()

def FoxitPDFSDKPython3.WidgetMenu.CanCut | ( |  | ) |

Check if the text of related XFA widget can be cut.

Returns
  true means the text can be cut, while false means the text cannot be cut.

## ◆ CanDelete()

def FoxitPDFSDKPython3.WidgetMenu.CanDelete | ( |  | ) |

Check if the text of related XFA widget can be deleted.

Returns
  true means the text can be deleted, while false means the text cannot be deleted.

## ◆ CanDeSelect()

def FoxitPDFSDKPython3.WidgetMenu.CanDeSelect | ( |  | ) |

Check if the selection of the text in related XFA widget can be canceled.

Returns
  true means the selection can be canceled, while false means the selection cannot be canceled.

## ◆ CanPaste()

def FoxitPDFSDKPython3.WidgetMenu.CanPaste | ( |  | ) |

Check if the text of related XFA widget can be pasted.

Returns
  true means the text can be pasted, while false means the text cannot be pasted.

## ◆ CanRedo()

def FoxitPDFSDKPython3.WidgetMenu.CanRedo | ( |  | ) |

Check if the operation of related XFA widget can be redone.

Returns
  true means the operation can be redone, while false means the operation cannot be redone.

## ◆ CanSelectAll()

def FoxitPDFSDKPython3.WidgetMenu.CanSelectAll | ( |  | ) |

Check if the text of related XFA widget can be selected all.

Returns
  true means the text can be selected all, while false means the text cannot be selected all.

## ◆ CanUndo()

def FoxitPDFSDKPython3.WidgetMenu.CanUndo | ( |  | ) |

Check if the operation of related XFA widget can be undone.

Returns
  true means the operation can be undone, while false means the operation cannot be undone.

## ◆ ClearStyle()

def FoxitPDFSDKPython3.WidgetMenu.ClearStyle | ( |  | ) |

(Only useful for rich text) Clear the style of the rich text.

Returns
  true means success, while false means failure.

## ◆ Copy()

def FoxitPDFSDKPython3.WidgetMenu.Copy | ( |  | ) |

Copy the text of related XFA widget.

Returns
  The copied text.

## ◆ Cut()

def FoxitPDFSDKPython3.WidgetMenu.Cut | ( |  | ) |

Cut the text of related XFA widget.

Returns
  The cut text.

## ◆ Delete()

def FoxitPDFSDKPython3.WidgetMenu.Delete | ( |  | ) |

Delete all the text of related XFA widget.

Returns
  true means success, while false means failure.

## ◆ DeSelect()

def FoxitPDFSDKPython3.WidgetMenu.DeSelect | ( |  | ) |

Cancel the selection of the text in related XFA widget.

Returns
  true means success, while false means failure.

## ◆ IsEmpty()

def FoxitPDFSDKPython3.WidgetMenu.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.

## ◆ Italic()

def FoxitPDFSDKPython3.WidgetMenu.Italic | ( |  | ) |

(Only useful for rich text) Make the rich text italic.

Returns
  true means success, while false means failure.

## ◆ Paste()

def FoxitPDFSDKPython3.WidgetMenu.Paste | ( |  | text | ) |

Paste the text to related XFA widget.

Parameters

  [in] | text | A text string to be pasted.

Returns
  true means success, while false means failure.

## ◆ Redo()

def FoxitPDFSDKPython3.WidgetMenu.Redo | ( |  | ) |

Redo the operation of related XFA widget. (No effect for rich text)

Returns
  true means success, while false means failure.

## ◆ SelectAll()

def FoxitPDFSDKPython3.WidgetMenu.SelectAll | ( |  | ) |

Select all the text of related XFA widget.

Returns
  true means success, while false means failure.

## ◆ Subscript()

def FoxitPDFSDKPython3.WidgetMenu.Subscript | ( |  | ) |

(Only useful for rich text) Make the rich text as subscript.

Returns
  true means success, while false means failure.

## ◆ Superscript()

def FoxitPDFSDKPython3.WidgetMenu.Superscript | ( |  | ) |

(Only useful for rich text) Make the rich text as superscript.

Returns
  true means success, while false means failure.

## ◆ Underline()

def FoxitPDFSDKPython3.WidgetMenu.Underline | ( |  | ) |

(Only useful for rich text) Underline the rich text.

Returns
  true means success, while false means failure.

## ◆ Undo()

def FoxitPDFSDKPython3.WidgetMenu.Undo | ( |  | ) |

Undo the operation of related XFA widget. (No effect for rich text)

Returns
  true means success, while false means failure.