<html> <head> <title>Interface XCopyTableWizard</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XCopyTableWizard-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">sdb</a> :: <a href="module-ix.html" class="namechain">application</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XCopyTableWizard</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XCopyTableWizard</strong> ┗ ::com::sun::star::ui::<a href="../../ui/dialogs/module-ix.html">dialogs</a>::<a href="../../ui/dialogs/XExecutableDialog.html">XExecutableDialog</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::ui::<a href="../../ui/dialogs/module-ix.html">dialogs</a>::<a href="../../ui/dialogs/XExecutableDialog.html">XExecutableDialog</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Specifies an interface for an executable dialog. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>describes a wizard which can be used to copy table like data from one database to another. </dd> <dd><p>Copying table data between databases can be a complex task. Especially when it comes to matching field types in the source and in the target database, some heuristics, and sometimes support from the user doing the operation, are required.</p> <p>The <code>copy table wizard</code> described by this interfaces cares for those, and other, settings.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.4 </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#addCopyTableListener">addCopyTableListener</a></td> <td class="imsum_right">adds a listener which is to be notified of progress in the copy operation </td> </tr> <tr> <td class="imsum_left"><a href="#removeCopyTableListener">removeCopyTableListener</a></td> <td class="imsum_right">removes a listener </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Operation">Operation</a></td> <td class="imsum_right">specifies the basic operation for the wizard to execute. </td> </tr> <tr> <td class="imsum_left"><a href="#DestinationTableName">DestinationTableName</a></td> <td class="imsum_right">specifies the name of the table in the destination database. </td> </tr> <tr> <td class="imsum_left"><a href="#CreatePrimaryKey">CreatePrimaryKey</a></td> <td class="imsum_right">specifies that a new primary key is to be created in the target database </td> </tr> <tr> <td class="imsum_left"><a href="#UseHeaderLineAsColumnNames">UseHeaderLineAsColumnNames</a></td> <td class="imsum_right">specifies that the first row should be used to identify column names. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="addCopyTableListener" class="membertitle">addCopyTableListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addCopyTableListener</b>(</td> <td valign="top">[in] <a href="XCopyTableListener.html">XCopyTableListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds a listener which is to be notified of progress in the copy operation </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeCopyTableListener" class="membertitle">removeCopyTableListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeCopyTableListener</b>(</td> <td valign="top">[in] <a href="XCopyTableListener.html">XCopyTableListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes a listener </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="Operation" class="membertitle">Operation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Operation</b><dl> <dd>set raises (::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the basic operation for the wizard to execute. </dd> <dd><p>This must be one of the <a href="CopyTableOperation.html">CopyTableOperation</a> constants.</p> <p>At initialization time, you can use this attribute to control the initial operation in the wizard.</p> <p>After the wizard has finished, you can use this attribute to determine what operation was actually executed.</p> <p>Changing this attribute while the dialog is running is not supported, the result of such an attempt is undefined.</p> </dd> <dt><b>Throws</b></dt> <dd>IllegalArgumentException if you attempt to set an invalid operation, or if the given operation is not supported by the target database type, e.g. if you specified <a href="CopyTableOperation.html">CopyTableOperation</a>::<a href="CopyTableOperation.html#CreateAsView">CreateAsView</a> where the database does not support views. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DestinationTableName" class="membertitle">DestinationTableName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>DestinationTableName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the name of the table in the destination database. </dd> <dd><p>At initialization time, you can use this attribute to control the initial table name as suggested to the user.</p> <p>After the wizard has finished, you can use this attribute to determine what table was actually created resp. to which existing table the source table's data was appended.</p> <p>Changing this attribute while the dialog is running is not supported, the result of such an attempt is undefined.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CreatePrimaryKey" class="membertitle">CreatePrimaryKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/Optional.html">Optional</a>< string > <b>CreatePrimaryKey</b><dl> <dd>set raises (::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies that a new primary key is to be created in the target database </dd> <dd><p>At initialization time, you can specify the initial settings for the primary key in the UI.</p> <p>You cannot use this attribute to determine the primary key, possibly created by the wizard, after it finished. The reason is that during the wizard run, the user can define an arbitrarily complex primary key, e.g. including multiple columns, which cannot be represented in this simple attribute anymore.</p> <p>This attribute is ignored if <a href="#Operation">Operation</a> is <a href="CopyTableOperation.html">CopyTableOperation</a>::<a href="CopyTableOperation.html#AppendData">AppendData</a>.</p> <p>Changing this attribute while the dialog is running is not supported, the result of such an attempt is undefined.</p> <p>When a primary key is to be created by the wizard, it will be be an auto-increment column, if possible.</p> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if the target database does not support primary keys </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseHeaderLineAsColumnNames" class="membertitle">UseHeaderLineAsColumnNames</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseHeaderLineAsColumnNames</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the first row should be used to identify column names. </dd> <dd><p>This attribute is ignored when the source defines the column names which isn't the case when only a part of a table should be copied e.g. in the RTF format or in the HTML format. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
