TCommonDialog class

In unit Dialogs

The base type from which other dialogs are derived.

Declaration

pascal

TCommonDialog = class(TLCLComponent)

Inheritance

Descends from it: TColorDialog TCustomPrintDialog TCustomPrinterSetupDialog TExtCommonDialog TFileDialog TFindDialog TFontDialog

Description

TCommonDialog is the base type from which all other dialogs are derived.

Use Create to make an instance of the dialog, and the Execute method to show it to the user. Use the Close method to release it and free the used resources.

Properties

`AttachTo`	protected	Form which created the dialog class instance.
`Handle`	public	Contains the handle for the dialog form.
`UserChoice`	public	Contains the modal result value selected by the user.
`Width`	public	The width of the dialog.
`Height`	public	The height of the dialog.
`HelpContext`	published	Help context identifier for the help message displayed for the dialog.
`Title`	published	The Title or Caption displayed for the dialog.

Methods

`WSRegisterClass`	protected	Registers this component class with the current WidgetSet.
`DoExecute`	protected	The function that actually takes care of executing the dialog.
`DefaultTitle`	protected	DefaultTitle returns the default title for a dialog.
`GetHeight`	protected	Gets the value for the Height property.
`GetWidth`	protected	Gets the value for the Width property.
`SetHeight`	protected	Sets the value for the Height property.
`SetWidth`	protected	Sets the value for the Width property.
`ResetShowCloseFlags`	protected	Resets the values in internal state flags for the dialog.
`Create`	public	Constructor for the class instance.
`Execute`	public	Displays the dialog and captures the result.
`Close`	public	Closes the dialog and frees its resources.
`DoShow`	public	Performs actions needed when the dialog is displayed.
`DoCanClose`	public	Performs actions needed to determine if the dialog can be closed.
`DoClose`	public	Performs actions needed when the dialog is closed.
`HandleAllocated`	public	Returns True if a widgetset Handle has been allocated for the dialog.

Events

`OnDialogResult`	protected	Event handler signalled when a result is available for the dialog.
`OnClose`	published	Event handler signalled when the dialog is closed.
`OnCanClose`	published	Event handler signalled to determine if the dialog can be closed.
`OnShow`	published	Event handler signalled when the dialog is displayed.

Fields

FCompStyle public Internal member used to store component style flags.

Inherited

From TLCLComponent (8)

DecLCLRefCount Destroy GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance RemoveAllHandlersOfObject WidgetSetClass

From TComponent (74)

_AddRef _Release BeforeDestruction CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DefineProperties DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetChildren GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetParentComponent GetTypeInfo GetTypeInfoCount HasParent iicrGetComponent InsertComponent Invoke IsImplementorOf Loaded Loading Name Notification ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReadState ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetName SetParentComponent SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (5)

Assign AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (36)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.