Name 

Description 

 

AdjustButtonBarHeight 

Determines the height of the button bar section of a dialog. 

 

AdjustSheetTopPosition 

Override this method to modify the calculated top position for the dialog sheet. 

 

CalculateAutoSize 

Calculates the size of the dialog. 

 

CalculateSheetPosition 

Method that calculates the position of the dialog if the DialogStyle property is set to dsSheet. 

 

CalculateWidth 

Calculates the minimum width required by the dialog when certain sections are active for a dialog. 

 

CanUpdateProgress 

Method that checks to see if the dialog is allowed to process Progress Bar update messages. 

 

CheckMinimumHeight 

Method that allows descendant classes to override the minimum height check. 

 

CleanUpDialog 

Virtual method that destroys any created controls on the dialog before being closed. 

 

CreateButtonBarButtons 

Method that creates the required button bar buttons to support the dialogs radio button section. 

 

CreateCommonButton 

Method that creates the common button specified by the ACommonBtn parameter. 

 

CreateContent 

Method that creates the control required to draw the content section of a dialog. 

 

CreateControls 

Method that calls all section control creator methods to create the controls used to display the dialog. 

 

CreateCustomButtons 

Method that creates the required custom button controls to support the dialogs radio button section. 

 

CreateEditControls 

This method has no implementation in TJSCustomDialog descendants, but is used in TJSCustomEditDialog descendants. 

 

CreateExpandoButton 

Method that creates the required control to allow a dialog to be expanded and collapsed. 

 

CreateFooter 

Method that creates the control required to draw the footer section of a dialog. 

 

CreateHeader 

This method currently has no implementation but may be introduced later. 

 

CreateHelpLinkLabel 

Method that creates the control required to draw the help link section of a dialog. 

 

CreateInstruction 

Method that creates the control required to draw the instruction section of a dialog. 

 

CreateMoreInFooter 

Method that creates the rich edit based control required for the footer section of a dialog. 

 

CreateMoreLines 

Method that creates the control responsible for drawing the expanded content in the dialog. 

 

CreateProgressBar 

Method that creates the progress bar control used when a dialog needs to show progress information. 

 

CreateRadioButtons 

Method that creates the required radio button controls to support the dialogs radio button section. 

 

CreateVerificationCheckBox 

Method that creates the required check box control to support the dialogs verification section. 

 

DoButtonClick 

Method called when a button on a dialog has been clicked. 

 

DoCleanUpDialog 

Method that triggers the OnCleanUpDialog event and calls the CleanUpDialog method. 

 

DoCollapse 

Method that triggers the OnCollapse event. 

 

DoControlClick 

Method that triggers the OnControlClick event. 

 

DoCreated 

Method that triggers the OnCreated event. 

 

DoDestroyed 

Method that triggers the OnDestroyed event. 

 

DoDialogClick 

Method that triggers the OnDialogClick event. 

 

DoDialogClose 

Method that triggers the OnDialogClose event after calling the UpdateDialogResult method. 

 

DoDialogCloseQuery 

Default event handler for the OnCloseQuery event for the dialog. 

 

DoDialogConstructed 

Method that calls the OnDialogConstructed event if one is assigned. The event parameter is the actual form created. 

 

DoDialogShow 

Triggers the OnDialogShow event if one has been assigned. 

 

DoExpand 

Method that triggers the OnExpand event. 

 

DoGetControlClass 

Method that calls the InitialiseControlClass method to get the default control class for a specific TControlType. 

 

DoGetCustomSound 

Method that triggers the OnGetCustomSound event. 

 

DoGetMoreFileName 

Method that triggers the OnGetMoreFileName event. 

 

DoGetMoreStream 

Method that triggers the OnGetMoreFileName event. 

 

DoGetRadioButtonChecked 

Method that returns the checked state for a particular radio button control. 

 

DoGetVerificationResult 

Method that returns the state of the Verification check box on the dialog. 

 

DoHelpButtonClick 

Method called when a Help button on a dialog has been clicked. 

 

DoHelpLinkClick 

Method that triggers the OnHelpLinkClick event. 

 

DoInitControl 

Method that calls the InitialiseControl method to initialise the default control instance for a specific TControlType. 

 

DoKeyPressHandler 

Method that triggers the OnKeyPress event. 

 

DoProgress 

Method that triggers the OnProgress event. 

 

DoShowDialogModal 

Method that is responsible for making the dialog visible and modal. 

 

DoShowDialogNonModal 

Method that is responsible for making the dialog visible and non-modal. 

 

DoTimerEvent 

Method that triggers the OnTimer event. 

 

DoUpdateProgressBar 

Method that triggers the OnUpdateProgressBar event. 

 

DoUpdateProgressBarState 

Method that triggers the OnUpdateProgressBarState event. 

 

DoVerificationClick 

Method that triggers the OnVerificationClick event. 

 

ExpandDialog 

Method that either expands or collapses the dialog and calls the appropriate event for the AExpand value. 

 

GetActiveControl 

Method that determines which control should have focus when the dialog is displayed. 

 

GetCaptionHeight 

Returns the height of the title bar for the form specified 

 

GetContentWidth 

Calculates the minimum width required to paint the content section. 

 

GetFooterHeight 

Method that returns the required height for the footer section of a dialog. 

 

GetFooterImageWidth 

Method that returns the width of the image to be displayed in the footer of the dialog. 

 

GetHeaderImageWidth 

Method that returns the width of the image to be displayed in the header of the dialog. 

 

GetInstructionHeight 

Calculates the height required to paint the instruction within the instruction section. 

 

GetInstructionWidth 

Calculates the minimum width required to paint the instruction section. 

 

GetMoreFooterHeight 

Method that returns the required height for the expanded footer section of a dialog. 

 

GetRect 

Method that returns the bounding rect for a particular section of the dialog. 

 

GetSystemSound 

Specifies the system sound to play for the dialog specified. 

 

HeightAdjustment 

Method that allows descendant classes to change the calculated height of a dialog. 

 

HorzPadding 

Returns the number of pixels the content section has. 

 

InitialiseControl 

Method use to initialise a specific TControlType. 

 

InitialiseControlClass 

Method returns the default control class type for a specific TControlType. 

 

InitialiseMargins 

Initialises the margin values used to control the dialogs layout. 

 

InvalidateButtons 

Method that repaints all buttons on the dialog. 

 

Paint 

Method that calls all of the relevant section paint methods to paint the dialog. 

 

PaintButtonBar 

Method that paints the Button Bar section of the dialog. 

 

PaintFooter 

Method that paints the footer section of the dialog. 

 

PaintFooterSeparator 

Method that paints the footer separator of a dialog that has a visible footer section. 

 

PaintGlyph 

Method that paints the glyph associated with the image. 

 

PaintHeader 

Method that paints the header section of the dialog. 

 

PaintMainInstruction 

Method that paints the glyph and background associated with the Instruction section. 

 

PaintMoreLines 

Method that paints additional text within the content section of the dialog. 

 

PlaySystemSounds 

Method that specifies if system sounds are to be played when the dialog is displayed. 

 

PositionButtonBarButtons 

Method that positions the button bar buttons. 

 

PositionContent 

Method that positions the content control on the dialog. 

 

PositionCustomButtons 

Method that positions the custom buttons. 

 

PositionExpandoButton 

Method that positions the expando control on the dialog. 

 

PositionFooter 

Method that positions the footer control on the dialog. 

 

PositionHelpLinkLabel 

Method that positions the help link control on the dialog. 

 

PositionInstruction 

Method that positions the instruction control on the dialog. 

 

PositionMoreLines 

Method that positions the additional content displayed when the dialog is expanded. 

 

PositionMoreRichEdit 

Method that positions the rich edit control when displayed in the footer section of a dialog. 

 

PositionProgressBar 

Method that positions the progress bar control on the dialog. 

 

PositionRadioButtons 

Method that positions the radio buttons. 

 

PositionVerificationCheckBox 

Method that positions the verification check box. 

 

RecreateControls 

Method that recreates temporary controls as used by the dialog. 

 

ReinitialiseControls 

Method that reinitialises specific control types. 

 

ResetProgressBar 

Method that resets a marquee style progress bar when displayed on a dialog. 

 

SetTaskIcon 

Method that loads the appropriate system image for a particular TTaskDialogIcon value. 

 

ShowCommandLinkHotKeys 

Method that makes sure that Command Link button hotkeys are visible. 

 

UpdateDialogResult 

Method that updates the internal record that holds the various result values for the dialog. 

 

WidthAdjustment 

Method that allows descendant classes to change the calculated width of a dialog. 

 

Name 

Description 

 

Assign 

Copies the content of another TJSDialog to this object. 

 

Close 

Call the Close method to close the dialog.
Specify the dialog result by using the AModalResult parameter. 

 

ContentLineWidth 

Returns the number of pixels the string passed in needs to be displayed in the dialog content. 

 

DefaultRadioButton 

Set the default radio button for when the dialog is displayed. The aIndex parameter is the index of the radio button as it appears. The first radio button is at index 0. 

 

EnableButton 

Set the Enabled property of a custom button control. 

 

EnableRadioButton 

Set the Enabled property of a radio button control. 

 

Execute 

This is the overview for the Execute method overload. 

 

ExecutePreview 

The ExecutePreview method should only be used by the Component Editor, the DialogOptions and Position properties are modified before the dialog is displayed in the IDE. 

 

GetControl 

Returns the instance of the control that corresponds to the control type requested in the AControlType parameter. If you use a control type that contains multiple controls, such as ctRadioButton or ctCommandLink than pass in the Value for the required control in the AValue parameter. 

 

IsChecked 

Returns the checked state for the radiobutton value 

 

PerformAction 

Use to click a custom button 

 

PositionControls 

Positions controls to make sure that the sections on the dialog are correct. 

 

RequiredWidth 

Returns the number of pixels the string passed in needs to be displayed with the specific default dialog font. 

 

SetChecked 

Set the radio button whose value is passed in as the aValue parameter to the checked state set in the aChecked parameter. 

 

SetProgressState 

Set the state of the progress bar. Depending on your operating system the progress bar color may change. 

 

SetUnchecked 

Set the radio button whose value is passed in as the aValue parameter to False. Passing in -1 for the aValue parameter, unchecks all radio buttons. 

 

Show 

Show the dialog after Execute has been called. 

 

Update 

Method that can be used to force the dialog to repaint. 

 

UpdateCustomButtonDetails 

Use to change the custom buttons Caption, Hint and Info values. 

 

UpdateProgress 

This is the overview for the UpdateProgress method overload.