JSDialog Namespace

This unit contains the main TJSDialog class implementation.

This unit contains the main implementation of the TJSDialog as well as several global utilities functions useful for when working with the dialog.

Topics

Name	Description
Classes	The following table lists classes in this documentation.
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	The following table lists structs, records, enums in this documentation.
Types	The following table lists types in this documentation.
Variables	The following table lists variables in this documentation.
Constants	The following table lists constants in this documentation.

Classes

	Name	Description
	EDialogSheet	Type of exception raised when TJSDialogSheet specific exceptions occur.
	JSNoHelpFileException	Type of exception raised when no help file has been found for the current application
	TJSAnimate	Class used to hold the options for animating the dialog when it is either expanding or collapsing.
	TJSBaseOptions	Base class for the TJSHeader and TJSFooter classes.
	TJSBorder	Class used to represent the appearance of a border around the contents of the dialog.
	TJSButtonBarOptions	Options for controlling the appearance of the button section that appears at the base of the dialog.
	TJSButtonOptions	Clas that contains the options for customising the appearance of command link buttons.
	TJSCustomButtonItem	Class used to store information about a custom button that is used in the dialog
	TJSCustomButtons	Collection that maintains the list of custom button items.
	TJSCustomDialog	TJSCustomDialog is the base class for objects that represent dialogs.
	TJSCustomTaskDialogForm	The base class for the form used to display the dialogs.
	TJSDialog	This component is registered in the Tool (Component) Palette of the selected IDE and is the main component in JSDialog Pack.
	TJSDialogOwnedPersistent	A TPersistent class that is owned by a TJSCustomDialog.
	TJSExpando	Class that describes the how the dialog will appear when it has been expanded or collapsed.
	TJSFooter	Class used to represent the information that needs to appear on the footer of the dialog.
	TJSHeader	Class used to represent the information that needs to appear in the Header section of the dialog.
	TJSHelpLink	Settings for how the Help Link is displayed in the dialog. To make the Help Link display in the dialog you must specific doHelpLinks in the DialogOptions.
	TJSInstruction	Class that controls the appearance of the Instruction section of the dialog.
	TJSLocation	Class that holds the dialog position values for when the Position property of the TJSDialog component is dpDesigned.
	TJSProgress	Class that holds the settings for when a progress bar is displayed on the dialog. For the progress bar to be visible you must have either doProgressBar or doProgressBarMarquee set in the DialogOptions property.
	TJSRadioButton	Class that helps specify the appearance of radio buttons when they are displayed on a dialog.
	TJSRadioButtonItem	Describes the appearance of any radio buttons on the dialog.
	TJSRadioButtons	Collection that maintains the list of radio button items. Keywords: radio buttons;TJSRadioButtonItem;TJSRadioButtons
	TJSSheetOptions	Specifies options specific to the sheet DialogStyle.
	TJSSizeComparer	Class used to compare a set of two integers against each other. This class is used to check if the dimensions of a custom icon has changed.
	TJSTaskDialogForm	The dialog created, descends from TJSTaskDialogForm.
	TJSTextSection	Class that contains displayable text on the dialog
	TJSTimer	Class that holds timer specific options.
	TJSVerification	Class that holds details about the verification control on the dialog.

Constants

Name	Description
BASE_CUSTOMBUTTON	Specifies the first value of a custom button on a dialog.
BASE_RADIOBUTTON	Specifies the first value of a radio button on a dialog.
clInstruction	Default Color used for the dialog instruction
clVistaSeparator	Color constant defined for the color used in vista to draw the divider line between the content section of the dialog and the common button section.
JSDIALOG_CTRL_CONTENT	Name of the control that represents the content section of the dialog
JSDIALOG_CTRL_CONTENTMEMO	Name of the control that represents the content of the dialog when the maximum displayable lines has been reached
JSDIALOG_CTRL_EXPANDO	Name of the control that represents the expando button on the dialog
JSDIALOG_CTRL_FOOTER	Name of the control that represents the footer section of the dialog
JSDIALOG_CTRL_HELPLINK	Name of the control that represents the help link on the dialog
JSDIALOG_CTRL_INSTRUCTION	Name of the control that represents the instruction section of the dialog
JSDIALOG_CTRL_MORELINES	Name of the control that display expanded content on the dialog
JSDIALOG_CTRL_PROGRESSBAR	Name of the control that displays the progress bar on the dialog
JSDIALOG_CTRL_RADIOGROUP	Name of the control that represents a group of radio buttons on the dialog
JSDIALOG_CTRL_RICHEDIT	Name of the control that display expanded rich content on the dialog
JSDIALOG_CTRL_VERIFICATION	Name of the control that represents the verification checkbox on the dialog
JSDIALOG_FORM	Name of the form that represents the dialog
WM_NONMODAL_FREE	Message sent to the TJSTaskDialogForm instance when the dialog is being closed and it is not a modal dialog
WM_PERFORMSNAPTO	Message sent to the TJSTaskDialogForm instance when the user has the mouse option set where the mouse should move automatically to the default button on a dialog

Functions

	Name	Description
	AFFS	Global function that adjusts the value to resize correctly under a DPI that isn't 96
	GetIcon	GetIcon returns the resourcename for the icon to load from the Windows resource library.
	GetRegisteredFont	Get the currently registered font.
	IsVista	Global function that returns true when running under Windows Vista
	RegisterFont	Register the systems default font for this font type.
	RegisterFont	Register the Font attributes to use for a certain font type. The registered font is used when called the DialogParams method to initialise a TDialogParams instance with default values.
	RegisterFont	Register a font for a specific section of the dialog
	ResetRegisteredFonts	Reset the default fonts back to their original values.

Structs, Records, Enums

	Name	Description
	TControlType	Type of control that the dialog is asking for information on. This allows you to typecast the TControl parameter with assurance that the control matches the type you specified.
	TDialogOption	Options to determine the visual display of the dialog.
	TJSDialogHitTest	Defines the location of a mouse click on a dialog.
	TJSDialogResult	Type used to hold the Dialog results values.
	TJSDialogState	Type for determining whether the dialog is currently being previewed.
	TJSDialogStyle	Applicable dialog styles.
	TJSFontType	Determines what section the font method being called will modify.
	TJSIconSize	Size of icon to draw in the Header of the dialog
	TJSImageAlignment	Specifies the alignment of the Header and Footer images.
	TJSSheetLocation	Defines where a TJSDialogSheet displays.
	TMoreFormat	Specifies the format of the More text.
	TMoreSource	Used to determine the source of the More text.
	TPaintStage	Used to retrieve the location for the item specified.

Types

Name	Description
TButtonClass	Type used in the OnGetButtonClass event when using a custom button component.
TControlClickEvent	Control Click event type.
TDialogClickEvent	Type of event triggered when the dialog area is click on
TDialogCloseEvent	Type of event triggered when the dialog is closed
TDialogOptions	Set of TDialogOption
TGetControlClassEvent	Type of event OnGetControlClass.
TGetCustomSoundEvent	Type of event triggered when a dialog is displayed to play a specific sound.
TGetMoreFileNameEvent	Type of event OnGetMoreFileName
TGetMoreStreamEvent	Type of event for OnGetMoreStream.
TGetRadioButtonChecked	Type of event OnGetRadioButtonChecked.
TGetVerificationResult	Type of event OnGetVerificationResult
THelpButtonClickEvent	Type of event triggered when the cbHelp common button is clicked
THelpContext	Type required for Delphi 5 compatibility.
THelpLinkClickEvent	Type of event for OnHelpLinkClick.
TInitControlEvent	Type of event OnInitControl event
TJSDialogClass	TJSDialogClass defines the metaclass for TJSDialog.
TJSDialogStates	Set type that holds the current internal dialog states.
TJSSpeedRange	Determines the values permitted when setting the Speed property for animation.
TJSStepRange	Determines the values permitted when setting the Step property for animation.
TJSTaskDialogFormClientClickEvent	Type used in the TJSTaskDialogForm's OnClientClick event handler.
TProgressEvent	Type of event to handle when the progress bar changes in doProgressBar is set in the DialogOptions property.
TTimerEvent	Type of event to handle when the timer is fired.
TUpdateProgressBarEvent	Type used in the OnUpdateProgressBar event.
TUpdateProgressBarStateEvent	Type used in the OnUpdateProgressBar event that helps update the progress bar style when using a custom progress bar.
TVerificationClickEvent	Type used in the OnVerificationClick event.

Variables

Name	Description
AlwaysUseDefaultFonts	Always use the system defined fonts for created dialogs.
JSDialogClass	Class to use when creating dialogs with the wrapper functions.
UseOldDialogStyle	Global variable that controls the dialog appearance.

Links

Legend, Topics, Classes, Constants, Functions, Structs, Records, Enums, Types, Variables

What do you think about this topic? Send feedback!