Foxit PDF SDK
fsdk.WidgetMenu Class Reference

Public Member Functions

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.

Member Function Documentation

◆ Bold()

def fsdk.WidgetMenu.Bold ( )

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

Returns
true means success, while false means failure.

◆ CanCopy()

def fsdk.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 fsdk.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 fsdk.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 fsdk.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 fsdk.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 fsdk.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 fsdk.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 fsdk.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 fsdk.WidgetMenu.ClearStyle ( )

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

Returns
true means success, while false means failure.

◆ Copy()

def fsdk.WidgetMenu.Copy ( )

Copy the text of related XFA widget.

Returns
The copied text.

◆ Cut()

def fsdk.WidgetMenu.Cut ( )

Cut the text of related XFA widget.

Returns
The cut text.

◆ Delete()

def fsdk.WidgetMenu.Delete ( )

Delete all the text of related XFA widget.

Returns
true means success, while false means failure.

◆ DeSelect()

def fsdk.WidgetMenu.DeSelect ( )

Cancel the selection of the text in related XFA widget.

Returns
true means success, while false means failure.

◆ IsEmpty()

def fsdk.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 fsdk.WidgetMenu.Italic ( )

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

Returns
true means success, while false means failure.

◆ Paste()

def fsdk.WidgetMenu.Paste (   text)

Paste the text to related XFA widget.

Parameters
[in]textA text string to be pasted.
Returns
true means success, while false means failure.

◆ Redo()

def fsdk.WidgetMenu.Redo ( )

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

Returns
true means success, while false means failure.

◆ SelectAll()

def fsdk.WidgetMenu.SelectAll ( )

Select all the text of related XFA widget.

Returns
true means success, while false means failure.

◆ Subscript()

def fsdk.WidgetMenu.Subscript ( )

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

Returns
true means success, while false means failure.

◆ Superscript()

def fsdk.WidgetMenu.Superscript ( )

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

Returns
true means success, while false means failure.

◆ Underline()

def fsdk.WidgetMenu.Underline ( )

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

Returns
true means success, while false means failure.

◆ Undo()

def fsdk.WidgetMenu.Undo ( )

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

Returns
true means success, while false means failure.