:: com :: sun :: star :: sdb ::
|
service ErrorMessageDialog |
- Description
- provides a dialog for displaying database related exceptions.
If applications use any of the functionality provided in the modules
sdbc
,
sdbcx
and
sdb
,
they will - sooner or later - encounter
::com::sun::star::sdbc::SQLException
's.
These exceptions can be chained, so the information wrapped in one single
::com::sun::star::sdbc::SQLException
can be rather complex (e.g., every instance where such an exception is passing before it is finally caught, could
append a
SQLContext
to explain what it was doing), and they should be
presented to the user in a consistent way.
This can be reached by using this service.
- See also
- com.sun.star.sdb.InteractionHandler
|
Properties' Summary |
string
Title |
the title of the (dialog) window
|
::com::sun::star::awt::XWindow
ParentWindow |
parent window to use for the dialog
|
any
SQLException |
is the exception displayed by the dialog
|
string
HelpURL |
[ OPTIONAL ]
specifies the URL to the help topic to associate with the dialog.
|
Exported Interfaces - Details |
::com::sun::star::beans::XPropertySet
- Description
- allows access to the properties of the object
|
|
::com::sun::star::ui::dialogs::XExecutableDialog
- Description
- allows starting execution of the dialog
|
|
::com::sun::star::lang::XInitialization
- Description
- allows initializing the dialog
You do not need to call the initialize method directly, instead you may use the createInstanceWithArguments
method of your
::com::sun::star::lang::XMultiServiceFactory
.
You specify a parameter by passing one (or more)
::com::sun::star::beans::PropertyValue
object(s) to the initialize method, where the Name field contains a string describing which aspect
you want to affect, and the Value field containing a value.
Imagine the initialization values, as if you use
XPropertySet::setPropertyValue()
of the
::com::sun::star::beans::XPropertySet
interface ...
allowed parameters are
- Title
String describing the initial title of the dialog. If not specified, a default title is used.
- ParentWindow
::com::sun::star::awt::XWindow
describing the parent window to use for the dialog.
- SQLException
::com::sun::star::sdbc::SQLException
describing the error which is beeing displayed.
When initializing this value, you may use any derivative of
::com::sun::star::sdbc::SQLException
.
|
|
Properties' Details |
Title
string Title;
- Description
- the title of the (dialog) window
|
|
ParentWindow
::com::sun::star::awt::XWindow ParentWindow;
- Description
- parent window to use for the dialog
This property can't be set while the dialog is being displayed.
|
|
SQLException
any SQLException;
- Description
- is the exception displayed by the dialog
This should contain a
::com::sun::star::sdbc::SQLException
instance, or an instance
of any class derived from this exception.
This property can't be set while the dialog is being displayed.
|
|
HelpURL
string HelpURL;
- Usage Restrictions
- optional
- Description
- specifies the URL to the help topic to associate with the dialog.
If This URL is not empty, then the dialog will get a "Help" button, which
directs the user to the given help topic.
|
|
Top of Page
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.