---------------------------------------------------
Class : cSigCJTaskDialog
Superclass : cSigCjComTaskDialog
Package : cSigCJTaskDialog.pkg
Mixins :
Description : The TaskDialog Control creates, displays, and operates a task dialog. A task dialog is similar to,
While much more flexible than, a basic message box. The task dialog contains application-defined messages,
title, verification check box, command links and push buttons, plus any combination of predefined icons
and push buttons.
Properties : pbShowWindowsExitButton (boolean)
psCollapsedControlText (string)
pbShowButtonOk (boolean)
pbShowButtonYes (boolean)
pbShowButtonNo (boolean)
pbShowButtonCancel (boolean)
pbShowButtonRetry (boolean)
pbShowButtonClose (boolean)
psContentText (string)
piDefaultButton (integer)
piDefaultRadioOption (integer)
piWidth (integer)
pbEnableCallbackTimer (boolean)
pbEnableCommandLinks (boolean)
pbEnableHyperLinks (boolean)
psExpandedControlText (string)
psExpandedInformationText (string)
pbExpandFooterArea (boolean)
piFooterIcon (integer)
psFooterIconImage (string)
psFooterText (string)
piMainIcon (integer)
psMainIconImage (string)
psMainInstructionText (string)
pbMessageBoxStyle (boolean)
phParentHwnd (handle)
piProgressBarPos (integer)
peProgressBarStyle (integer)
pbRelativePosition (boolean)
pbRtLLayout (boolean)
pbShowCommandLinkIcons (boolean)
pbUseComCtl32 (boolean)
psVerificationText (string)
pbVerifyCheckState (boolean)
psTitle (string)
Events : OnButtonClicked
OnHyperlinkClicked
OnRadioSelected
OnVerificationClicked
OnExpandButtonClicked
OnTimer
OnConstructed
OnCreate
Methods : ShowDialog
Set TaskDialogOptionButton
Set TaskDialogOptionRadio
Set pbButtonEnabledState
Set pbRadioOptionEnabledState
Reset
Set ProgressBarRange
StartProgressBarMarquee
Notes :
To Do :
---------------------------------------------------
Construct_Object()
- End_Construct_Object()
- Set(String sImage)
{ MethodType=Method Visibility=Private }
Procedure SetTaskDialogProperty Handle hmPrivateProperty Handle hmCOMProperty Variant vValue
Set hmPrivateProperty to vValue
If (IsComObjectCreated(Self)) Begin
Set hmCOMProperty to vValue
End
End_Procedure
- IntegeriImageID
- IntegerhWnd
- StringpsMainIconImage()
- Set(String sImage)
- IntegeriImageID
- IntegerhWnd
- StringpsFooterIconImage()
- Set(Boolean bState)
- BooleanpbShowWindowsExitButton()
- Set(String sText)
- StringpsCollapsedControlText()
- Set(Integer iButtons)
- IntegerpeCommonButtons()
- Set(Boolean bState)
- BooleanpbShowButtonOk()
- Set(Boolean bState)
- BooleanpbShowButtonYes()
- Set(Boolean bState)
- BooleanpbShowButtonNo()
- Set(Boolean bState)
- BooleanpbShowButtonCancel()
- Set(Boolean bState)
- BooleanpbShowButtonRetry()
- Set(Boolean bState)
- BooleanpbShowButtonClose()
- SetCommonButtons()
- Set(String sText)
- StringpsContentText()
- Set(Integer iButton)
{ EnumList="eBtn_OK, eBtn_Yes, eBtn_No, eBtn_Cancel, eBtn_Retry, eBtn_Close" }
- IntegerpiDefaultButton()
- Set(Integer iButton)
- IntegerpiDefaultRadioOption()
- Set(Integer iWidth)
- IntegerpiWidth()
- Set(Boolean bState)
- BooleanpbEnableCallbackTimer()
- Set(Boolean bState)
- BooleanpbEnableCommandLinks()
- Set(Boolean bState)
- BooleanpbEnableHyperLinks()
- Set(Boolean bState)
- BooleanpbExpandInfoTextByDefault()
- Set(String sText)
- StringpsExpandedControlText()
- Set(String sText)
- StringpsExpandedInformationText()
- Set(Boolean bState)
- BooleanpbExpandFooterArea()
- Set(Integer iID)
- BooleanpiFooterIcon()
- Set(Integer iHandle)
- BooleanpiFooterIconHandle()
- Set(String sText)
- StringpsFooterText()
- Set(Integer iID)
- BooleanpiMainIcon()
- Set(Integer iHandle)
- BooleanpiMainIconHandle()
- Set(String sText)
- StringpsMainInstructionText()
- Set(Boolean bState)
- BooleanpbMessageBoxStyle()
- Set(Handle hParent)
- BooleanphParentHwnd()
- Set(Integer iPos)
- IntegerpiProgressBarPos()
- Set(Integer eStyle)
- IntegerpeProgressBarStyle()
- Set(Boolean bState)
- BooleanpbRelativePosition()
- Set(Boolean bState)
- BooleanpbRtLLayout()
- Set(Boolean bState)
- BooleanpbShowCommandLinkIcons()
- Set(Boolean bState)
- BooleanpbUseComCtl32()
- Set(String sText)
- StringpsVerificationText()
- Set(Boolean bState)
- BooleanpbVerifyCheckState()
- Set(String sTitle)
- StringpsTitle()
- IntegerShowDialog()
---------------------------------------------------
Procedure : ShowDialog
Scope : Public Method
Paramaters : None
Returns : Integer
Purpose : Displays the task dialog and return the selected button (id) when done
Notes :
---------------------------------------------------
- Set(String sButtonText Integer iButtonID)
---------------------------------------------------
Procedure : Set TaskDialogOptionButton
Scope : Public Method
Paramaters : sButtonText (string), iButtonID (integer)
Returns :
Purpose : Adds a user defined button to the task dialog's command area.
Example: Set TaskDialogOptionButton "Run" to 100
Set TaskDialogOptionButton "Don't Run" to 101
Notes : The iButtonID indicates the value to be returned when this button is selected and the
OnButtonClicked Event fires
---------------------------------------------------
- BooleanbIsCreated
- Set(String sRadioText Integer iButtonID)
---------------------------------------------------
Procedure : Set TaskDialogOptionRadio
Scope : Public Method
Paramaters : sRadioText (string), iButtonID (integer)
Returns :
Purpose : Adds a user defined button to the task dialog's command area.
Example: Set TaskDialogOptionRadio "Allow" to 100
Set TaskDialogOptionRadio "Don't Allow" to 101
Notes : The iButtonID indicates the value to be returned when this button is selected and the
OnRadioSelected Event fires
---------------------------------------------------
- BooleanbIsCreated
- Set(Integer iButtonID Boolean bState)
---------------------------------------------------
Procedure : Set pbButtonEnabledState
Scope : Public Method
Paramaters : Integer iButtonID Boolean bState
Returns :
Purpose : Sets the enabled_state for the specified button
Notes :
---------------------------------------------------
- BooleanbIsCreated
- Set(Integer iRadioID Boolean bState)
---------------------------------------------------
Procedure : Set pbRadioOptionEnabledState
Scope : Public Method
Paramaters : Integer iRadioID Boolean bState
Returns :
Purpose : Sets the enabled_state for the specified radio option
Notes :
---------------------------------------------------
- BooleanbIsCreated
- ClickButton(Integer iButtonID)
---------------------------------------------------
Procedure : ClickButton
Scope : Public Method
Paramaters : Integer iButtonID
Returns :
Purpose : Simulate the action of a button click in the task dialog
Notes :
---------------------------------------------------
- BooleanbIsCreated
- Reset()
---------------------------------------------------
Procedure : Reset
Scope : Public Method
Paramaters :
Returns :
Purpose : Resets the configuration attributes for the task dialog to the default state
Notes :
---------------------------------------------------
- BooleanbIsCreated
- Set(Integer iMin Integer iMax)
---------------------------------------------------
Procedure : ProgressBarRange
Scope : Public Method
Paramaters : Integer iMin Integer iMax
Returns :
Purpose : Sets the minimum and maximum values for the progress bar
Notes : By default the min is zero and the max is 100
---------------------------------------------------
- BooleanbIsCreated
- StartProgressBarMarquee(Boolean bStart Integer imilliseconds)
---------------------------------------------------
Procedure : StartProgressBarMarquee
Scope : Public Method
Paramaters : Boolean bStart Integer imilliseconds
Returns :
Purpose : Specifies whether the progress bar should be displayed in marquee mode or not with the ability to
determine marquee speed as well
Notes : peProgressBarStyle must first be set to eTaskProgressBar_Marquee and StartProgressBarMarquee
must be called in the OnConstructed event before it can be turned on or off.
After StartProgressBarMarquee is called in the OnConstructed event you can freely Use StartProgressBarMarquee
anytime to start and stop the marquee.
---------------------------------------------------
- BooleanbIsCreated
- OnCreate()
- OnButtonClicked(Integer iButton_ID Boolean ByRef bCloseDialog)
---------------------------------------------------
Procedure : OnButtonClicked
Scope : Public Event
Paramaters : Integer iButton_ID Boolean ByRef bCloseDialog
Returns :
Purpose : Occurs when a user selects a button or command link in the task dialog
Notes :
---------------------------------------------------
- OnHyperlinkClicked(String llURL)
---------------------------------------------------
Procedure : OnHyperlinkClicked
Scope : Public Event
Paramaters : String llURL
Returns :
Purpose : Occurs when a user clicks on a hyperlink in the Task Dialog's content
Notes :
---------------------------------------------------
- OnRadioSelected(Integer iRadio_ID)
---------------------------------------------------
Procedure : OnRadioSelected
Scope : Public Event
Paramaters : Integer iRadio_ID
Returns :
Purpose : Occurs when a user selects a radio button in the task dialog.
Notes :
---------------------------------------------------
- OnVerificationClicked(Boolean bChecked)
---------------------------------------------------
Procedure : OnVerificationClicked
Scope : Public Event
Paramaters : Boolean bChecked
Returns :
Purpose : Occurs when the user clicks on the task dialog's verification check box
Notes :
---------------------------------------------------
- OnExpandButtonClicked(Boolean bExpanded)
---------------------------------------------------
Procedure : OnExpandButtonClicked
Scope : Public Event
Paramaters : Boolean bExpanded
Returns :
Purpose : Occurs when the user clicks on the expand in the Task Dialog.
Notes :
---------------------------------------------------
- OnTimer(Integer iMilliSeconds Boolean ByRef bResetCounter)
---------------------------------------------------
Procedure : OnTimer
Scope : Integer iMilliSeconds Boolean ByRef bResetCounter
Paramaters : Boolean bStart Integer imilliseconds
Returns :
Purpose : This event is sent by the Task Dialog approximately every
200 milliseconds when the pbEnableCallbackTimer Property has been Set (to True).
Notes :
---------------------------------------------------
- OnConstructed()
---------------------------------------------------
Procedure : OnConstructed
Scope : Public Event
Paramaters :
Returns :
Purpose : Occurs once the task dialog has been created and before it is displayed.
Notes :
---------------------------------------------------
- OnComButtonClicked(Integer llId Variant llCloseDialog)
- OnComHyperlinkClicked(String llURL)
- OnComRadioButtonClicked(Integer llId)
- OnComVerificationClicked(Boolean llChecked)
- OnComExpandButtonClicked(Boolean llExpanded)
- OnComTimer(Integer llMilliSeconds Variant llReset)
- OnComConstructed()
- HandleInitialise()
Standard User interface functions
- IntegerhoDialog
- Base_Box(Handle hoDialog String sMessage String sTitle)
- sigCJInfo_Box(String sMessage String sTitle)
- IntegeriRetval
- IntegerhoDialog
- sigCJWarning_Box(String sMessage String sTitle)
- IntegeriRetval
- IntegerhoDialog
- sigCJStop_Box(String sMessage String sTitle)
- IntegeriRetval
- IntegerhoDialog
- IntegersigCJYesNo_Box(String sMessage String sTitle Integer eBtn)
- IntegeriRetval
- IntegerhoDialog
- IntegersigCJYesNoCancel_Box(String sMessage String sTitle Integer eBtn)
- IntegeriRetval
- IntegerhoDialog