Interface XCopyTableWizard

Devguide

Index

Methods' Summary

Methods' Details

Attributes' Summary

Attributes' Details

:: com :: sun :: star :: sdb :: application ::

unpublished

interface XCopyTableWizard

Base Interfaces

XCopyTableWizard
┗ ::com::sun::star::ui::dialogs::XExecutableDialog

::com::sun::star::ui::dialogs::XExecutableDialog

(referenced interface's summary:): Specifies an interface for an executable dialog.

Description

describes a wizard which can be used to copy table like data from one database to another.

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.

The copy table wizard described by this interfaces cares for those, and other, settings.

Since

OOo 2.4

Methods' Summary
addCopyTableListener	adds a listener which is to be notified of progress in the copy operation
removeCopyTableListener	removes a listener

Methods' Details

addCopyTableListener

void
addCopyTableListener(	[in] XCopyTableListener	Listener );

Description: adds a listener which is to be notified of progress in the copy operation

removeCopyTableListener

void
removeCopyTableListener(	[in] XCopyTableListener	Listener );

Description: removes a listener

Attributes' Summary
Operation	specifies the basic operation for the wizard to execute.
DestinationTableName	specfies the name of the table in the destination database.
NewPrimaryKey	specifies that a new primary key in the target database is to be created.

Attributes' Details

Operation

short Operation set raises (::com::sun::star::lang::IllegalArgumentException); Description specifies the basic operation for the wizard to execute. This must be one of the CopyTableOperation constants. At initialization time, you can use this attribute to control the initial operation in the wizard. After the wizard has finished, you can use this attribute to determine what operation was actually executed. Changing this attribute while the dialog is running is not supported, the result of such an attempt is undefined.

DestinationTableName

string DestinationTableName; Description specfies the name of the table in the destination database. At initialization time, you can use this attribute to control the initial table name as suggested to the user. 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. Changing this attribute while the dialog is running is not supported, the result of such an attempt is undefined.

NewPrimaryKey

::com::sun::star::beans::Optional< string > NewPrimaryKey; Description specifies that a new primary key in the target database is to be created. At initialization time, you can specify the initial settings for the primary key in the UI. 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. This attribute is ignored if Operation is CopyTableOperation::AppendData. Changing this attribute while the dialog is running is not supported, the result of such an attempt is undefined.

Top of Page