/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* This interface is available when a database document has been loaded into
a frame, at the controller of this frame. Note that reading this atttribute is equivalent to querying the component
for the Note that the connection returned here is really the working connection
of the application. Clients should not misuse it, in particular, closing
the connection can yield unexpected results and should definately be
avoided. If you need a separate connection to the data source, use
If the application is already connected, nothing happens. If it is not
connected, the application will try to establish a connection by using
If the connection cannot be established, the respective error message is shown
in the application window. During working with the database, the user might open different sub components:
forms, reports, tables, queries. Those components are tracked by the application,
and provided in this attribute. The components here might either be documents ( During working with the database, the user might open different sub components:
forms, reports, tables, queries. If you need to close all those documents, use
In a first step, the sub components will be suspended
( Once all sub components have been suspended, they will, in a second step,
be closed. Again, closing might be vetoed by other instances, e.g. by a close
listener registered at the component. This method allows programmatic access to the functionality which is present in the UI:
it allows opening a table, query, form, or report for either editing or viewing. This method is a convenience wrapper for API which is also available otherwise. For instance,
for loading forms and reports, you could use the Note there must exist a connection to the database before you can call this method. If an error occurs opening the given object, then this is reported to the user via an error dialog. For the different object types, this means the following
closeSubComponents
, which will gracefully do this.
ForEditing
= ForEditing
=
Tables
A table designer is opened, and allows to edit the structure of the table.
See also
A table data view is opened, and allows to view and edit the data contained in the table.
See also
Queries
A query designer is opened, and allows to edit the statement constituting the query.
See also
A table data view is opened, and allows to view and edit the data contained in the query.
See also
Forms
The form document is opened in design mode, that is, you can modify it.
The form document is opened in read-only mode, allowing you to view and enter the data
which the form is based on, but not the form design.
Reports
The report document is opened in design mode, that is, you can modify it.
The report is executed, and the results will be displayed.
In opposite to
The meaning of the the arguments is defined at the service which is effectively created. See the above table for a list of those services.
*/ ::com::sun::star::lang::XComponent loadComponentWithArguments( [in] long ObjectType, [in] string ObjectName, [in] boolean ForEditing, [in] sequence< ::com::sun::star::beans::PropertyValue > Arguments ) raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::sdbc::SQLException ); /** creates a new sub component of the given type @param ObjectType specifies the type of the object, must be one of theIn opposite to
The meaning of the the arguments is defined at the service which is effectively created. See the above table for a list of those services.
@param ObjectType specifies the type of the object, must be one of theHidden
flag (set to show
command at the
definition object.
*/
::com::sun::star::lang::XComponent createComponentWithArguments(
[in] long ObjectType,
[in] sequence< ::com::sun::star::beans::PropertyValue > Arguments,
[out] ::com::sun::star::lang::XComponent DocumentDefinition )
raises ( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::sdbc::SQLException );
};
//=============================================================================
}; }; }; }; };
//=============================================================================
#endif