Foxit PDF SDK
Public Types | Public Member Functions | List of all members
foxit.addon.xfa.AppProviderCallback Class Reference

Inherits SystemIDisposable.

Public Types

enum  AppInfo {
  AppInfo.e_AppInfoVersion = 0x0, AppInfo.e_AppInfoLanguage = 0x01, AppInfo.e_AppInfoPlatform = 0x02, AppInfo.e_AppInfoVariation = 0x03,
  AppInfo.e_AppInfoName = 0x04, AppInfo.e_AppInfoType = 0x05
}
 Enumeration for XFA application information type. More...
 
enum  BeepType {
  BeepType.e_BeepTypeError = 0, BeepType.e_BeepTypeWarning = 1, BeepType.e_BeepTypeQuestion = 2, BeepType.e_BeepTypeStatus = 3,
  BeepType.e_BeepTypeDefault = 4
}
 Enumeration for XFA beep type. More...
 
enum  MsgBoxButtonID { MsgBoxButtonID.e_MsgBtnIDOK = 1, MsgBoxButtonID.e_MsgBtnIDCancel = 2, MsgBoxButtonID.e_MsgBtnIDNo = 3, MsgBoxButtonID.e_MsgBtnIDYes = 4 }
 Enumeration for button ID of XFA message box. More...
 
enum  MsgBoxButtonType { MsgBoxButtonType.e_MsgBtnTypeOK = 0, MsgBoxButtonType.e_MsgBtnTypeOKCancel = 1, MsgBoxButtonType.e_MsgBtnTypeYesNo = 2, MsgBoxButtonType.e_MsgBtnTypeYesNoCancel = 3 }
 Enumeration for button type of XFA message box. More...
 
enum  MsgBoxIconType { MsgBoxIconType.e_MsgBoxIconError = 0, MsgBoxIconType.e_MsgBoxIconWarning = 1, MsgBoxIconType.e_MsgBoxIconQuestion = 2, MsgBoxIconType.e_MsgBoxIconStatus = 3 }
 Enumeration for icon type of XFA message box. More...
 
enum  StringID {
  StringID.e_StringIDValidateFailed = 1, StringID.e_StringIDCalcOverride = 2, StringID.e_StringIDModifyField = 3, StringID.e_StringIDNotModifyField = 4,
  StringID.e_StringIDAppName = 5, StringID.e_StringIDImageFilter = 6, StringID.e_StringIDUnknownCaught = 7, StringID.e_StringIDUnableToSet = 8,
  StringID.e_StringIDValueExcalmatory = 9, StringID.e_StringIDInvalidEnumValue = 10, StringID.e_StringIDUnsupportMethod = 11, StringID.e_StringIDUnsupportProperty = 12,
  StringID.e_StringIDInvalidPropertySetOperation = 13, StringID.e_StringIDNotDefaultValue = 14, StringID.e_StringIDUnableSetLanguage = 15, StringID.e_StringIDUnableSetNumPages = 16,
  StringID.e_StringIDUnableSetPlatformValue = 17, StringID.e_StringIDUnableSetValidationsEnabledValue = 18, StringID.e_StringIDUnableSetValidationsValue = 19, StringID.e_StringIDUnableSetVersion = 20,
  StringID.e_StringIDUnableSetReady = 21, StringID.e_StringIDNumberOfOccur = 22, StringID.e_StringIDUnableSetClassName = 23, StringID.e_StringIDUnableSetLengthValue = 24,
  StringID.e_StringIDUnsupportChar = 25, StringID.e_StringIDBadSuffix = 26, StringID.e_StringIDExpectedIdent = 27, StringID.e_StringIDExpectedString = 28,
  StringID.e_StringIDInvalidateChar = 29, StringID.e_StringIDRedefinition = 30, StringID.e_StringIDInvalidToken = 31, StringID.e_StringIDInvalidExpression = 32,
  StringID.e_StringIDUndefineIdentifier = 33, StringID.e_StringIDInvalidateLeftValue = 34, StringID.e_StringIDCompilerError = 35, StringID.e_StringIDCannotModifyValue = 36,
  StringID.e_StringIDParametersError = 37, StringID.e_StringIDExpectedEndIf = 38, StringID.e_StringIDUnexpectedExpression = 39, StringID.e_StringIDConditionIsNull = 40,
  StringID.e_StringIDIllegalBreak = 41, StringID.e_StringIDIllegalContinue = 42, StringID.e_StringIDExpectedOperator = 43, StringID.e_StringIDDivideZero = 44,
  StringID.e_StringIDCannotCovertToObject = 45, StringID.e_StringIDNotFoundContainer = 46, StringID.e_StringIDNotFoundProperty = 47, StringID.e_StringIDNotFoundMethod = 48,
  StringID.e_StringIDNotFoundConst = 49, StringID.e_StringIDNotAssignObject = 50, StringID.e_StringIDInvalidateInstruction = 51, StringID.e_StringIDExpectedNumber = 52,
  StringID.e_StringIDValidateOutOfArray = 53, StringID.e_StringIDCannotAssign = 54, StringID.e_StringIDNotFoundFunction = 55, StringID.e_StringIDIsNotArray = 56,
  StringID.e_StringIDOutOfArrayRange = 57, StringID.e_StringIDNotSupportArrayCalculate = 58, StringID.e_StringIDArgumentNotArray = 59, StringID.e_StringIDArgumentExpectContainer = 60,
  StringID.e_StringIDAccessProertyInNotObject = 61, StringID.e_StringIDFunctionBuildIn = 62, StringID.e_StringIDErrorMessage = 63, StringID.e_StringIDIndexValueOutOfBounds = 64,
  StringID.e_StringIDIncorrectNumberOfMethod = 65, StringID.e_StringIDArgumentMismatch = 66, StringID.e_StringIDInvalidEnumerate = 67, StringID.e_StringIDInvalidAppend = 68,
  StringID.e_StringIDSOMExpectedList = 69, StringID.e_StringIDNotHaveProperty = 70, StringID.e_StringIDInvalidNodeType = 71, StringID.e_StringIDViolateBoundary = 72,
  StringID.e_StringIDServerDeny = 73, StringID.e_StringIDWeekDaySun = 74, StringID.e_StringIDWeekDayMon = 75, StringID.e_StringIDWeekDayTue = 76,
  StringID.e_StringIDWeekDayWed = 77, StringID.e_StringIDWeekDayThu = 78, StringID.e_StringIDWeekDayFri = 79, StringID.e_StringIDWeekDaySat = 80,
  StringID.e_StringIDMonthJan = 81, StringID.e_StringIDMonthFeb = 82, StringID.e_StringIDMonthMarch = 83, StringID.e_StringIDMonthApril = 84,
  StringID.e_StringIDMonthMay = 85, StringID.e_StringIDMonthJune = 86, StringID.e_StringIDMonthJuly = 87, StringID.e_StringIDMonthAug = 88,
  StringID.e_StringIDMonthSep = 89, StringID.e_StringIDMonthOct = 90, StringID.e_StringIDMonthNov = 91, StringID.e_StringIDMonthDec = 92,
  StringID.e_StringIDToday = 93, StringID.e_StringIDValidateLimit = 94, StringID.e_StringIDValidateNullWarning = 95, StringID.e_StringIDValidateNullError = 96,
  StringID.e_StringIDValidateWarning = 97, StringID.e_StringIDValidateError = 98, StringID.e_StringIDValidateNumberError = 99, StringID.e_StringIDScriptFailedError = 100,
  StringID.e_StringIDScriptInvalidValue = 101, StringID.e_StringIDSubmitValidateNullError = 102, StringID.e_StringIDInvalidBarcodeValue = 103, StringID.e_StringIDScriptArgumentMismatch = 104
}
 Enumeration for string ID used to specify a case. More...
 

Public Member Functions

virtual void Beep (AppProviderCallback.BeepType type)
 A callback function used to beep for specified beep type. More...
 
virtual FileReaderCallback DownLoadUrl (string url)
 A callback function used to download from specified URL. More...
 
virtual string GetAppInfo (AppProviderCallback.AppInfo app_info)
 A callback function used to get application information for a specified information type. More...
 
virtual string LoadString (AppProviderCallback.StringID string_id)
 A callback function used to load a string in local language for a specified case. More...
 
virtual AppProviderCallback.MsgBoxButtonID MsgBox (string message, string title, AppProviderCallback.MsgBoxIconType icon_type, AppProviderCallback.MsgBoxButtonType button_type)
 A callback function used to set message box. More...
 
virtual string PostRequestURL (string url, string data, string content_type, string encode, string header)
 A callback function used to post data to the given URL. More...
 
virtual bool PutRequestURL (string url, string data, string encode)
 A callback function used to put data to the given URL. More...
 
virtual void Release ()
 A callback function used to release current callback object itself. More...
 
virtual string Response (string question, string title, string default_answer, bool is_mask)
 A callback function used to response. More...
 
virtual WStringArray ShowFileDialog (string string_title, string string_filter, bool is_openfile_dialog)
 A callback function used to show file dialog. More...
 

Detailed Description

This class represents a callback object as an XFA application provider. All the functions in this class are used as callback functions. Pure virtual functions should be implemented by user.

Member Enumeration Documentation

◆ AppInfo

enum foxit.addon.xfa.AppProviderCallback.AppInfo
strong

Enumeration for XFA application information type.

Values of this enumeration should be used alone.

Enumerator
e_AppInfoVersion 

Application information: version.

e_AppInfoLanguage 

Application information: language.

e_AppInfoPlatform 

Application information: platform.

e_AppInfoVariation 

Application information: variation.

e_AppInfoName 

Application information: name.

e_AppInfoType 

Application information: type.

◆ BeepType

enum foxit.addon.xfa.AppProviderCallback.BeepType
strong

Enumeration for XFA beep type.

Values of this enumeration should be used alone.

Enumerator
e_BeepTypeError 

Beep type: error.

e_BeepTypeWarning 

Beep type: warning.

e_BeepTypeQuestion 

Beep type: question.

e_BeepTypeStatus 

Beep type: status.

e_BeepTypeDefault 

Beep type: default.

◆ MsgBoxButtonID

enum foxit.addon.xfa.AppProviderCallback.MsgBoxButtonID
strong

Enumeration for button ID of XFA message box.

Values of this enumeration should be used alone.

Enumerator
e_MsgBtnIDOK 

Message box button ID: OK.

e_MsgBtnIDCancel 

Message box button ID: Cancel.

e_MsgBtnIDNo 

Message box button ID: No.

e_MsgBtnIDYes 

Message box button ID: Yes.

◆ MsgBoxButtonType

enum foxit.addon.xfa.AppProviderCallback.MsgBoxButtonType
strong

Enumeration for button type of XFA message box.

Values of this enumeration should be used alone.

Enumerator
e_MsgBtnTypeOK 

Message box button: OK.

e_MsgBtnTypeOKCancel 

Message box button: OK and Cancel.

e_MsgBtnTypeYesNo 

Message box button: Yes and No.

e_MsgBtnTypeYesNoCancel 

Message box button: Yes, No and Cancel.

◆ MsgBoxIconType

enum foxit.addon.xfa.AppProviderCallback.MsgBoxIconType
strong

Enumeration for icon type of XFA message box.

Values of this enumeration should be used alone.

Enumerator
e_MsgBoxIconError 

Message box icon: Error.

e_MsgBoxIconWarning 

Message box icon: Warning.

e_MsgBoxIconQuestion 

Message box icon: Question.

e_MsgBoxIconStatus 

Message box icon: Status.

◆ StringID

enum foxit.addon.xfa.AppProviderCallback.StringID
strong

Enumeration for string ID used to specify a case.

Values of this enumeration should be used alone.

Enumerator
e_StringIDValidateFailed 

Sample message: "Validate failed".

e_StringIDCalcOverride 

Sample message: "Calculate Override".

e_StringIDModifyField 

String ID for case: If to modify field. Sample message: "Do you want to modify this field?".

e_StringIDNotModifyField 

String ID for case: Not allow to modify field. Sample message: "You are not allowed to modify this field.".

e_StringIDAppName 

String ID for case: Application's name. Sample message: "Foxit Phantom".

e_StringIDImageFilter 

String ID for case: Filter for image files. Sample message: "Image Files(*.bmp;*.jpg;*.png;*.gif;*.tif)|*.bmp;*.jpg;*.png;*.gif;*.tif|All Files(*.*)|*.*||".

e_StringIDUnknownCaught 

Sample message: "Unknown error is caught!".

e_StringIDUnableToSet 

Sample message: "Unable to set".

e_StringIDValueExcalmatory 

Sample message: "Value!".

e_StringIDInvalidEnumValue 

String ID for case: Some enumerate value is invalid. Sample message: "Invalid enumerate value:".

e_StringIDUnsupportMethod 

Sample message: "Unsupported method \%s.".

e_StringIDUnsupportProperty 

Sample message: "Unsupported property \%s.".

e_StringIDInvalidPropertySetOperation 

String ID for case: Some setting operation to property is invalid. Sample message: "Invalid property setting operation:".

e_StringIDNotDefaultValue 

Sample message: "Not have a default property".

e_StringIDUnableSetLanguage 

Sample message: "Unable to set the value for property 'language'".

e_StringIDUnableSetNumPages 

Sample message: "Unable to set the value for property 'numPages'".

e_StringIDUnableSetPlatformValue 

Sample message: "Unable to set the value for property 'platform'".

e_StringIDUnableSetValidationsEnabledValue 

Sample message: "Unable to set the value for property 'validationsEnabled'".

e_StringIDUnableSetValidationsValue 

Sample message: "Unable to set the value for property 'variation'".

e_StringIDUnableSetVersion 

Sample message: "Unable to set the value for property 'version'".

e_StringIDUnableSetReady 

Sample message: "Unable to set the value for property 'ready'".

e_StringIDNumberOfOccur 

Sample message: "The element [\%s] has violated its allowable number of occurrences".

e_StringIDUnableSetClassName 

Sample message: "Unable to set the value for property 'className'".

e_StringIDUnableSetLengthValue 

Sample message: "Unable to set the value for property 'length'".

e_StringIDUnsupportChar 

Sample message: "Unsupported character '\%c'".

e_StringIDBadSuffix 

Sample message: "Bad suffix on number".

e_StringIDExpectedIdent 

Sample message: "Expected identifier instead of '\%s'".

e_StringIDExpectedString 

Sample message: "Expected '\%s' instead of '\%s'".

e_StringIDInvalidateChar 

Sample message: "Invalidate character '\%c'".

e_StringIDRedefinition 

Sample message: "'\%s' redefinition".

e_StringIDInvalidToken 

Sample message: "Invalidate token '\%s'".

e_StringIDInvalidExpression 

Sample message: "Invalidate expression '\%s'".

e_StringIDUndefineIdentifier 

Sample message: "Undefined identifier '\%s'".

e_StringIDInvalidateLeftValue 

Sample message: "Invalidate left-value '\%s'".

e_StringIDCompilerError 

Sample message: "Compiler error".

e_StringIDCannotModifyValue 

Sample message: "Cannot modify the '\%s' value".

e_StringIDParametersError 

Sample message: "Function '\%s' does not have \%d parameters".

e_StringIDExpectedEndIf 

Sample message: "Expected 'endif' instead of '\%s'".

e_StringIDUnexpectedExpression 

Sample message: "Unexpected expression '\%s'".

e_StringIDConditionIsNull 

Sample message: "Condition is null".

e_StringIDIllegalBreak 

Sample message: "Illegal break".

e_StringIDIllegalContinue 

Sample message: "Illegal continue".

e_StringIDExpectedOperator 

Sample message: "Expected operator '\%s' instead of '\%s'".

e_StringIDDivideZero 

Sample message: "Divide by zero".

e_StringIDCannotCovertToObject 

Sample message: "\%s.\%s cannot covert to object".

e_StringIDNotFoundContainer 

Sample message: "Cannot find container '\%s'".

e_StringIDNotFoundProperty 

Sample message: "Cannot find property '\%s'".

e_StringIDNotFoundMethod 

Sample message: "Cannot find method '\%s'".

e_StringIDNotFoundConst 

Sample message: "Cannot find const '\%s'".

e_StringIDNotAssignObject 

Sample message: "Cannot directly assign the value to object".

e_StringIDInvalidateInstruction 

Sample message: "Invalidate instruction".

e_StringIDExpectedNumber 

Sample message: "Expected number instead of '\%s'".

e_StringIDValidateOutOfArray 

Sample message: "Validate access index '\%s' out of array".

e_StringIDCannotAssign 

Sample message: "Cannot assign to '\%s'".

e_StringIDNotFoundFunction 

Sample message: "Cannot find function '\%s'".

e_StringIDIsNotArray 

Sample message: "'\%s' is not an array".

e_StringIDOutOfArrayRange 

Sample message: "Out of the range of '\%s' array".

e_StringIDNotSupportArrayCalculate 

Sample message: "'\%s' operator cannot support array calculation".

e_StringIDArgumentNotArray 

Sample message: "'\%s' function's \%d argument cannot be array".

e_StringIDArgumentExpectContainer 

Sample message: "'\%s' argument is expected to be a container".

e_StringIDAccessProertyInNotObject 

Sample message: "An attempt was made to reference property '\%s' of a non-object in SOM expression \%s".

e_StringIDFunctionBuildIn 

Sample message: "Function 's' is built-in.

e_StringIDErrorMessage 

Sample message: "\%s : \%s".

e_StringIDIndexValueOutOfBounds 

Sample message: "Index value is out of bounds".

e_StringIDIncorrectNumberOfMethod 

Sample message: "Incorrect number of parameters are used when calling method '\%s'".

e_StringIDArgumentMismatch 

Sample message: "Argument mismatch in property or function argument".

e_StringIDInvalidEnumerate 

Sample message: "Invalid enumerated value: \%s".

e_StringIDInvalidAppend 

Sample message: "Invalid append operation: \%s cannot have a child element of \%s".

e_StringIDSOMExpectedList 

Sample message: "SOM expression returned list when single result was expected".

e_StringIDNotHaveProperty 

Sample message: "'\%s' doesn't have property '\%s'".

e_StringIDInvalidNodeType 

Sample message: "Invalid node type: '\%s'".

e_StringIDViolateBoundary 

Sample message: "The element [\%s] has violated its allowable number of occurrences".

e_StringIDServerDeny 

String ID for case: Server denies. Sample message: "Server does not permit".

e_StringIDWeekDaySun 

String ID for case: Use string in local language for "Sunday".

e_StringIDWeekDayMon 

String ID for case: Use string in local language for "Monday".

e_StringIDWeekDayTue 

String ID for case: Use string in local language for "Tuesday".

e_StringIDWeekDayWed 

String ID for case: Use string in local language for "Wednesday".

e_StringIDWeekDayThu 

String ID for case: Use string in local language for "Thursday".

e_StringIDWeekDayFri 

String ID for case: Use string in local language for "Friday".

e_StringIDWeekDaySat 

String ID for case: Use string in local language for "Saturday".

e_StringIDMonthJan 

String ID for case: Use string in local language for "January".

e_StringIDMonthFeb 

String ID for case: Use string in local language for "February".

e_StringIDMonthMarch 

String ID for case: Use string in local language for "March".

e_StringIDMonthApril 

String ID for case: Use string in local language for "April".

e_StringIDMonthMay 

String ID for case: Use string in local language for "May".

e_StringIDMonthJune 

String ID for case: Use string in local language for "June".

e_StringIDMonthJuly 

String ID for case: Use string in local language for "July".

e_StringIDMonthAug 

String ID for case: Use string in local language for "August".

e_StringIDMonthSep 

String ID for case: Use string in local language for "September".

e_StringIDMonthOct 

String ID for case: Use string in local language for "October".

e_StringIDMonthNov 

String ID for case: Use string in local language for "November".

e_StringIDMonthDec 

String ID for case: Use string in local language for "December".

e_StringIDToday 

String ID for case: Use string in local language for "Today".

e_StringIDValidateLimit 

Sample message: "Message limit exceeded. Remaining \%d validation errors not reported.".

e_StringIDValidateNullWarning 

Sample message: "\%s cannot be left blank. To ignore validations for \%s, click Ignore.".

e_StringIDValidateNullError 

Sample message: "\%s cannot be left blank.".

e_StringIDValidateWarning 

Sample message: "The value you entered for \%s is invalid. To ignore validations for \%s, click Ignore.".

e_StringIDValidateError 

Sample message: "The value you entered for \%s is invalid.".

e_StringIDValidateNumberError 

Sample message: "Illegal value:cannot assign '\%s' to \%s.".

e_StringIDScriptFailedError 

Sample message: "Script failed(language is \%s;context is \%s) script=\%s".

e_StringIDScriptInvalidValue 

Sample message: "Error:Invalid enumerated value:\%s".

e_StringIDSubmitValidateNullError 

Sample message: "At least one required field was empty. Please fill in the required fields(highlighted) before continuing.".

e_StringIDInvalidBarcodeValue 

Sample message: "Invalid Barcode Value: \%s is an invalid value for barcodes of type \%s.".

e_StringIDScriptArgumentMismatch 

Sample message: "Error:Argument mismatch in property or function argument.".

Member Function Documentation

◆ Beep()

void foxit.addon.xfa.AppProviderCallback.Beep ( AppProviderCallback.BeepType  type)
inlinevirtual

A callback function used to beep for specified beep type.

Parameters
[in]typeThe beep type. Please refer to values starting from foxit.addon.xfa.AppProviderCallback.BeepType.e_BeepTypeError and this would be one of these values.
Returns
None.

◆ DownLoadUrl()

FileReaderCallback foxit.addon.xfa.AppProviderCallback.DownLoadUrl ( string  url)
inlinevirtual

A callback function used to download from specified URL.

Parameters
[in]urlA URL to be downloaded.
Returns
A foxit.common.fxcrt.FileReaderCallback object which can be used to read the downloading result.

◆ GetAppInfo()

string foxit.addon.xfa.AppProviderCallback.GetAppInfo ( AppProviderCallback.AppInfo  app_info)
inlinevirtual

A callback function used to get application information for a specified information type.

Parameters
[in]app_infoThe type of application information, whose information is to retrieved. Please refer to values starting from foxit.addon.xfa.AppProviderCallback.AppInfo.e_AppInfoType and this would be one of these values.
Returns
A string of application information.

◆ LoadString()

string foxit.addon.xfa.AppProviderCallback.LoadString ( AppProviderCallback.StringID  string_id)
inlinevirtual

A callback function used to load a string in local language for a specified case.

This function is very useful for user to use local language for message of specified cases. User can re-write or translate the sample message (which is defined in the comment of values starting from foxit.addon.xfa.AppProviderCallback.StringID.e_StringIDValidateFailed ) into local language for the specified case, and return the result string to Foxit PDF SDK. Specially, Foxit PDF SDK will add some necessary information/data to the format part in the sample message, in order to make the message more useful. User is recommended to keep these format part in the re-written or translated result string; otherwise, these information/data will not be lost and will not be added to the message offered by user.

Parameters
[in]string_idA string ID to specify a case. Please refer to values starting from foxit.addon.xfa.AppProviderCallback.StringID.e_StringIDValidateFailed and this would be one of these values.
Returns
A string used for the specified case.

◆ MsgBox()

AppProviderCallback.MsgBoxButtonID foxit.addon.xfa.AppProviderCallback.MsgBox ( string  message,
string  title,
AppProviderCallback.MsgBoxIconType  icon_type,
AppProviderCallback.MsgBoxButtonType  button_type 
)
inlinevirtual

A callback function used to set message box.

Parameters
[in]messageA message string.
[in]titleThe title of message box.
[in]icon_typeThe icon type for message box. Please refer to values starting from foxit.addon.xfa.AppProviderCallback.MsgBoxIconType.e_MsgBoxIconError and this would be one of these values.
[in]button_typeThe button type for message box. Please refer to values starting from foxit.addon.xfa.AppProviderCallback.MsgBoxButtonType.e_MsgBtnTypeOK and this would be one of these values.
Returns
The button ID for message box. Please refer to values starting from foxit.addon.xfa.AppProviderCallback.MsgBoxButtonID.e_MsgBtnIDOK and this should be one of these values.

◆ PostRequestURL()

string foxit.addon.xfa.AppProviderCallback.PostRequestURL ( string  url,
string  data,
string  content_type,
string  encode,
string  header 
)
inlinevirtual

A callback function used to post data to the given URL.

Parameters
[in]urlA URL, to which the data will be posted.
[in]dataThe data to be posted.
[in]content_typeA string that represents the content type of data. This string could be "text/html", "text/xml", "text/plain", "multipart/form-data", "application/x-www-form-urlencoded", "application/octet-stream", or any valid MIME type.
[in]encodeA string that represents the encoding of data. This string could be "UTF-8", "UTF-16", "ISO8859-1", or any recognized [IANA]character encoding.
[in]headerA string that represents any additional HTTP headers to be included in the post.
Returns
The response string.

◆ PutRequestURL()

bool foxit.addon.xfa.AppProviderCallback.PutRequestURL ( string  url,
string  data,
string  encode 
)
inlinevirtual

A callback function used to put data to the given URL.

Parameters
[in]urlA URL, to which the data will be put.
[in]dataThe data to be put.
[in]encodeA string that represents the encoding of data. This string could be "UTF-8", "UTF-16", ISO8859-1", or any recognized [IANA]character encoding.
Returns
true means success, while false means failure.

◆ Release()

void foxit.addon.xfa.AppProviderCallback.Release ( )
inlinevirtual

A callback function used to release current callback object itself.

Returns
None.

◆ Response()

string foxit.addon.xfa.AppProviderCallback.Response ( string  question,
string  title,
string  default_answer,
bool  is_mask 
)
inlinevirtual

A callback function used to response.

Parameters
[in]questionA string that represents the question.
[in]titleA string that represents the title.
[in]default_answerA string that represents the default answer. It could be an empty string which means no default answer.
[in]is_masktrue means the answer should be masked by '*', while false means the answer does not need to be masked by '*'.
Returns
A string that represents the response answer.

◆ ShowFileDialog()

WStringArray foxit.addon.xfa.AppProviderCallback.ShowFileDialog ( string  string_title,
string  string_filter,
bool  is_openfile_dialog 
)
inlinevirtual

A callback function used to show file dialog.

Parameters
[in]string_titleA string that represents the dialog title.
[in]string_filterA string that represents the dialog file filter.
[in]is_openfile_dialogtrue means the dialog is an open-file-dialog, while false means the dialog is a save-as-dialog.
Returns
An array of file paths.