Class: cSigCJTaskDialog

Module location: cSigCJTaskDialog.pkg line 140 (view source)

--------------------------------------------------- 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 : ---------------------------------------------------

Class Hierarchy:

DFCOMACTIVEXCONTROLcComActiveXControlcSigCjComTaskDialogcSigCJTaskDialog

Mixins:

cSigCJMethods_Mixin,

Class Definition

Properties

IntegerpiProcessCounter
BooleanPrivate.pbCancelButton
BooleanPrivate.pbCloseButton
BooleanPrivate.pbEnableCallbackTimer
BooleanPrivate.pbEnableCommandLinks
BooleanPrivate.pbEnableHyperLinks
BooleanPrivate.pbExpandFooterArea
BooleanPrivate.pbExpandInfoTextByDefault
BooleanPrivate.pbMessageBoxStyle
BooleanPrivate.pbNoButton
BooleanPrivate.pbOKButton
BooleanPrivate.pbRelativePosition
BooleanPrivate.pbRetryButton
BooleanPrivate.pbRtLLayout
BooleanPrivate.pbShowCommandLinkIcons
BooleanPrivate.pbShowWindowsExitButton
BooleanPrivate.pbUseComCtl32
BooleanPrivate.pbVerifyCheckState
BooleanPrivate.pbYesButton
IntegerPrivate.peCommonButtons
IntegerPrivate.peProgressBarStyle
HandlePrivate.phParentHwnd
IntegerPrivate.piDefaultButton
IntegerPrivate.piDefaultRadioOption
IntegerPrivate.piFooterIcon
IntegerPrivate.piFooterIconHandle
IntegerPrivate.piMainIcon
IntegerPrivate.piMainIconHandle
IntegerPrivate.piProgressBarPos
IntegerPrivate.piWidth
StringPrivate.psCollapsedControlText
StringPrivate.psContentText
StringPrivate.psExpandedControlText
StringPrivate.psExpandedInformationText
StringPrivate.psFooterIconImage
StringPrivate.psFooterText
StringPrivate.psMainIconImage
StringPrivate.psMainInstructionText
StringPrivate.psTitle
StringPrivate.psVerificationText
Warning setting this to true on a vista or 2008 server will stop the modal state

Functions and Procedures

Base_Box(Handle hoDialog String sMessage String sTitle)
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 : ---------------------------------------------------
Construct_Object()
Inherited from cSigCjComTaskDialog
End_Construct_Object()
HandleInitialise()
Standard User interface functions
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 : ---------------------------------------------------
OnComButtonClicked(Integer llId Variant llCloseDialog)
Inherited from cSigCjCom_DTaskDialogEvents
OnComConstructed()
Inherited from cSigCjCom_DTaskDialogEvents
OnComExpandButtonClicked(Boolean llExpanded)
Inherited from cSigCjCom_DTaskDialogEvents
OnComHyperlinkClicked(String llURL)
Inherited from cSigCjCom_DTaskDialogEvents
OnComRadioButtonClicked(Integer llId)
Inherited from cSigCjCom_DTaskDialogEvents
OnComTimer(Integer llMilliSeconds Variant llReset)
Inherited from cSigCjCom_DTaskDialogEvents
OnComVerificationClicked(Boolean llChecked)
Inherited from cSigCjCom_DTaskDialogEvents
OnConstructed()
--------------------------------------------------- Procedure : OnConstructed Scope : Public Event Paramaters : Returns : Purpose : Occurs once the task dialog has been created and before it is displayed. Notes : ---------------------------------------------------
OnCreate()
Inherited from cComActiveXControl
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 : ---------------------------------------------------
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 : ---------------------------------------------------
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 : ---------------------------------------------------
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 : ---------------------------------------------------
BooleanpbEnableCallbackTimer()
BooleanpbEnableCommandLinks()
BooleanpbEnableHyperLinks()
BooleanpbExpandFooterArea()
BooleanpbExpandInfoTextByDefault()
BooleanpbMessageBoxStyle()
BooleanpbRelativePosition()
BooleanpbRtLLayout()
BooleanpbShowButtonCancel()
BooleanpbShowButtonClose()
BooleanpbShowButtonNo()
BooleanpbShowButtonOk()
BooleanpbShowButtonRetry()
BooleanpbShowButtonYes()
BooleanpbShowCommandLinkIcons()
BooleanpbShowWindowsExitButton()
BooleanpbUseComCtl32()
BooleanpbVerifyCheckState()
IntegerpeCommonButtons()
IntegerpeProgressBarStyle()
BooleanphParentHwnd()
IntegerpiDefaultButton()
IntegerpiDefaultRadioOption()
BooleanpiFooterIcon()
BooleanpiFooterIconHandle()
BooleanpiMainIcon()
BooleanpiMainIconHandle()
IntegerpiProgressBarPos()
IntegerpiWidth()
StringpsCollapsedControlText()
StringpsContentText()
StringpsExpandedControlText()
StringpsExpandedInformationText()
StringpsFooterIconImage()
StringpsFooterText()
StringpsMainIconImage()
StringpsMainInstructionText()
StringpsTitle()
StringpsVerificationText()
Reset()
--------------------------------------------------- Procedure : Reset Scope : Public Method Paramaters : Returns : Purpose : Resets the configuration attributes for the task dialog to the default state Notes : ---------------------------------------------------
Set(String sImage)
Inherited from cSigCJMethods_Mixin
{ 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
Set(String sImage)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(String sText)
Inherited from cSigCJMethods_Mixin
Set(Integer iButtons)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(String sText)
Inherited from cSigCJMethods_Mixin
Set(Integer iButton)
Inherited from cSigCJMethods_Mixin
{ EnumList="eBtn_OK, eBtn_Yes, eBtn_No, eBtn_Cancel, eBtn_Retry, eBtn_Close" }
Set(Integer iButton)
Inherited from cSigCJMethods_Mixin
Set(Integer iWidth)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(String sText)
Inherited from cSigCJMethods_Mixin
Set(String sText)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Integer iID)
Inherited from cSigCJMethods_Mixin
Set(Integer iHandle)
Inherited from cSigCJMethods_Mixin
Set(String sText)
Inherited from cSigCJMethods_Mixin
Set(Integer iID)
Inherited from cSigCJMethods_Mixin
Set(Integer iHandle)
Inherited from cSigCJMethods_Mixin
Set(String sText)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Handle hParent)
Inherited from cSigCJMethods_Mixin
Set(Integer iPos)
Inherited from cSigCJMethods_Mixin
Set(Integer eStyle)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(String sText)
Inherited from cSigCJMethods_Mixin
Set(Boolean bState)
Inherited from cSigCJMethods_Mixin
Set(String sTitle)
Inherited from cSigCJMethods_Mixin
Set(String sButtonText Integer iButtonID)
Inherited from cSigCJMethods_Mixin
--------------------------------------------------- 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 ---------------------------------------------------
Set(String sRadioText Integer iButtonID)
Inherited from cSigCJMethods_Mixin
--------------------------------------------------- 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 ---------------------------------------------------
Set(Integer iButtonID Boolean bState)
Inherited from cSigCJMethods_Mixin
--------------------------------------------------- Procedure : Set pbButtonEnabledState Scope : Public Method Paramaters : Integer iButtonID Boolean bState Returns : Purpose : Sets the enabled_state for the specified button Notes : ---------------------------------------------------
Set(Integer iRadioID Boolean bState)
Inherited from cSigCJMethods_Mixin
--------------------------------------------------- Procedure : Set pbRadioOptionEnabledState Scope : Public Method Paramaters : Integer iRadioID Boolean bState Returns : Purpose : Sets the enabled_state for the specified radio option Notes : ---------------------------------------------------
Set(Integer iMin Integer iMax)
Inherited from cSigCJMethods_Mixin
--------------------------------------------------- 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 ---------------------------------------------------
SetCommonButtons()
IntegerShowDialog()
--------------------------------------------------- Procedure : ShowDialog Scope : Public Method Paramaters : None Returns : Integer Purpose : Displays the task dialog and return the selected button (id) when done Notes : ---------------------------------------------------
sigCJInfo_Box(String sMessage String sTitle)
sigCJStop_Box(String sMessage String sTitle)
sigCJWarning_Box(String sMessage String sTitle)
IntegersigCJYesNo_Box(String sMessage String sTitle Integer eBtn)
IntegersigCJYesNoCancel_Box(String sMessage String sTitle Integer eBtn)
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. ---------------------------------------------------

References (1):

ModuleContaining SymbolLine
oSigCJTaskDialog.pkgoSigCJTaskDialog38