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

Use ColumnNameFilter to select specific columns within the imported data. Only the specified columns will be imported to the worksheet.

Signature
C#
C#
 public System.String[] ColumnNameFilter{ get; set; }
{signature}{signature:
}
Signature
vb.net
vb.net
Public Property ColumnNameFilter() As String()
{signature}
{remarks}If the length of the specified array is greater than  [MaxColumns|DataImportProperties.MaxColumns], or exceeds the size of the target area  and [Truncate|DataImportProperties.Truncate] is set to {{true}},  the smaller value will be used.

Using   {{ColumnNameFilter}} overwrites  any previous [ColumnIndexFilter|DataImportProperties.ColumnIndexFilter] setting.

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

If the length of the specified array is greater than MaxColumns, or exceeds the size of the target area and Truncate is set to true, the smaller value will be used.

Using ColumnNameFilter overwrites any previous ColumnIndexFilter setting.

Example
Code Block
csharp
csharp
titleC#


          //--- Get ColumnNameFilter
          string[] arrNames = importProps.ColumnNameFilter;

          //--- Set ColumnNameFilter
          importProps.ColumnNameFilter = arrNames;
        
{code} {code:
Code Block
vb.net
|title=
vb.net
titlevb.net
}


          '--- Get ColumnNameFilter
          Dim arrNames() As String = importProps.ColumnNameFilter

          '--- Set ColumnNameFilter
          importProps.ColumnNameFilter = arrNames
        
{code} {example}