FSDK.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 FSDK.WidgetMenu represents the menu of an XFA widget.

Member Function Documentation

Bold()

FSDK.WidgetMenu.Bold ( )

inline

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

Returns

true means success, while false means failure.

CanCopy()

FSDK.WidgetMenu.CanCopy ( )

inline

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

FSDK.WidgetMenu.CanCut ( )

inline

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

FSDK.WidgetMenu.CanDelete ( )

inline

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

FSDK.WidgetMenu.CanDeSelect ( )

inline

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

FSDK.WidgetMenu.CanPaste ( )

inline

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

FSDK.WidgetMenu.CanRedo ( )

inline

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

FSDK.WidgetMenu.CanSelectAll ( )

inline

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

FSDK.WidgetMenu.CanUndo ( )

inline

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

FSDK.WidgetMenu.ClearStyle ( )

inline

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

Returns

true means success, while false means failure.

constructor()

FSDK.WidgetMenu.constructor (   xfa_widget )

inline

Constructor, from XFA widget object.

Parameters

[in]

xfa_widget

A valid XFA widget object.

Copy()

FSDK.WidgetMenu.Copy ( )

inline

Copy the text of related XFA widget.

Returns

The copied text.

Cut()

FSDK.WidgetMenu.Cut ( )

inline

Cut the text of related XFA widget.

Returns

The cut text.

DeleteMenu()

FSDK.WidgetMenu.DeleteMenu ( )

inline

Delete all the text of related XFA widget.

Returns

true means success, while false means failure.

DeSelect()

FSDK.WidgetMenu.DeSelect ( )

inline

Cancel the selection of the text in related XFA widget.

Returns

true means success, while false means failure.

IsEmpty()

FSDK.WidgetMenu.IsEmpty ( )

inline

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

FSDK.WidgetMenu.Italic ( )

inline

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

Returns

true means success, while false means failure.

Paste()

FSDK.WidgetMenu.Paste (   text )

inline

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

FSDK.WidgetMenu.Redo ( )

inline

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

Returns

true means success, while false means failure.

SelectAll()

FSDK.WidgetMenu.SelectAll ( )

inline

Select all the text of related XFA widget.

Returns

true means success, while false means failure.

Subscript()

FSDK.WidgetMenu.Subscript ( )

inline

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

Returns

true means success, while false means failure.

Superscript()

FSDK.WidgetMenu.Superscript ( )

inline

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

Returns

true means success, while false means failure.

Underline()

FSDK.WidgetMenu.Underline ( )

inline

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

Returns

true means success, while false means failure.

Undo()

FSDK.WidgetMenu.Undo ( )

inline

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

Returns

true means success, while false means failure.