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

...

Description

Excerpt

This class is used to control settings for importing data into a table or table cell.

Signature
C#
C#
 public sealed class DataImportProperties
{signature}{signature:
}
Signature
vb.net
vb.net
Public NotInheritable Class DataImportProperties
{signature}
{remarks}To create a [DataImportProperties|DataImportProperties] object, use [
Remarks

To create a 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#}

.

To actually import data, use Element.ImportData and pass in a DataImportProperties object along with the data to import.

Example
Code Block
csharp
csharp
titleC#


          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=
Code Block
vbnet
vbnet
titlevb.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}|
Properties

Name

Description

AutoFit

Excerpt Include
DataImportProperties.AutoFit
DataImportProperties.AutoFit
nopaneltrue

AutoFormatter

Excerpt Include
DataImportProperties.AutoFormatter
DataImportProperties.AutoFormatter
nopaneltrue

ColumnIndexFilter

Excerpt Include
DataImportProperties.ColumnIndexFilter
DataImportProperties.ColumnIndexFilter
nopaneltrue

ColumnNameFilter

Excerpt Include
DataImportProperties.ColumnNameFilter
DataImportProperties.ColumnNameFilter
nopaneltrue

MaxColumns

Excerpt Include
DataImportProperties.MaxColumns
DataImportProperties.MaxColumns
nopaneltrue

MaxRows

Excerpt Include
DataImportProperties.MaxRows
DataImportProperties.MaxRows
nopaneltrue

UseColumnNames

Excerpt Include
DataImportProperties.UseColumnNames
DataImportProperties.UseColumnNames
nopaneltrue