Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup
{description}
{excerpt}This class is used to control settings for importing data into a table or table cell.{excerpt}
{signature:C#}
 public sealed class DataImportProperties
{signature}{signature:vb.net}
Public NotInheritable Class DataImportProperties
{signature}
{remarks}To create a [DataImportProperties|DataImportProperties] object, use [Document.CreateDataImportProperties|Document.CreateDataImportProperties()].

To actually import data, use [Element.ImportData|Element.ImportData(Object()())] and pass in a {{DataImportProperties}} object along with the data to import.

{remarks}
{example}{code:csharp|title=C#}

          WordApplication app = new WordApplication();
          Document doc = app.Create();
          DataImportProperties importProps = doc.CreateDataImportProperties();

          //--- Set a few properties
          importProps.UseColumnNames = true;
          importProps.AutoFit = true;

          //--- Import data into a new table and apply the DataImportProperties
          Table dataImportTable = oTable.ImportData(oDataTable, importProps);
        {code}
{code:vbnet|title=vb.net}

          Dim app As New WordApplication()
          Dim doc As Document = app.Create()
          Dim importProps As DataImportProperties = doc.CreateDataImportProperties()

          '--- Set a few properties
          importProps.UseColumnNames = True
          importProps.AutoFit = True

          '--- Import data into a new table and apply the DataImportProperties
          Table dataImportTable = oTable.ImportData(oDataTable, importProps)
        {code}

{example}
{properties}
||Name||Description||
|[AutoFit|DataImportProperties.AutoFit]|{excerpt-include:DataImportProperties.AutoFit|nopanel=true}|
|[AutoFormatter|DataImportProperties.AutoFormatter]|{excerpt-include:DataImportProperties.AutoFormatter|nopanel=true}|
|[ColumnIndexFilter|DataImportProperties.ColumnIndexFilter]|{excerpt-include:DataImportProperties.ColumnIndexFilter|nopanel=true}|
|[ColumnNameFilter|DataImportProperties.ColumnNameFilter]|{excerpt-include:DataImportProperties.ColumnNameFilter|nopanel=true}|
|[MaxColumns|DataImportProperties.MaxColumns]|{excerpt-include:DataImportProperties.MaxColumns|nopanel=true}|
|[MaxRows|DataImportProperties.MaxRows]|{excerpt-include:DataImportProperties.MaxRows|nopanel=true}|
|[UseColumnNames|DataImportProperties.UseColumnNames]|{excerpt-include:DataImportProperties.UseColumnNames|nopanel=true}|