Foxit PDF RDK

Public Member Functions | List of all members
WidgetMenu Class Reference

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

## Member Function Documentation

## ◆ Bold()

WidgetMenu.Bold | ( |  | ) |

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

Returns
  true means success, while false means failure.

## ◆ CanCopy()

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()

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()

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()

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()

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()

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()

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()

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()

WidgetMenu.ClearStyle | ( |  | ) |

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

Returns
  true means success, while false means failure.

## ◆ constructor()

WidgetMenu.constructor | ( | xfa_widget |  | ) |

Constructor, from XFA widget object.

Parameters

  [in] | xfa_widget | A valid XFA widget object.

## ◆ Copy()

WidgetMenu.Copy | ( |  | ) |

Copy the text of related XFA widget.

Returns
  The copied text.

## ◆ Cut()

WidgetMenu.Cut | ( |  | ) |

Cut the text of related XFA widget.

Returns
  The cut text.

## ◆ DeleteMenu()

WidgetMenu.DeleteMenu | ( |  | ) |

Delete all the text of related XFA widget.

Returns
  true means success, while false means failure.

## ◆ DeSelect()

WidgetMenu.DeSelect | ( |  | ) |

Cancel the selection of the text in related XFA widget.

Returns
  true means success, while false means failure.

## ◆ IsEmpty()

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()

WidgetMenu.Italic | ( |  | ) |

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

Returns
  true means success, while false means failure.

## ◆ Paste()

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()

WidgetMenu.Redo | ( |  | ) |

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

Returns
  true means success, while false means failure.

## ◆ SelectAll()

WidgetMenu.SelectAll | ( |  | ) |

Select all the text of related XFA widget.

Returns
  true means success, while false means failure.

## ◆ Subscript()

WidgetMenu.Subscript | ( |  | ) |

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

Returns
  true means success, while false means failure.

## ◆ Superscript()

WidgetMenu.Superscript | ( |  | ) |

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

Returns
  true means success, while false means failure.

## ◆ Underline()

WidgetMenu.Underline | ( |  | ) |

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

Returns
  true means success, while false means failure.

## ◆ Undo()

WidgetMenu.Undo | ( |  | ) |

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

Returns
  true means success, while false means failure.