Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Wiki Markup
{introducedin:7.1.0.1855

...

Description

Excerpt

Imports data from a SharePoint List to the specified Area. The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved.

Signature
C#C#
}
{description}
{excerpt}Imports data from a SharePoint List to the specified [Area|Area].  The new data will overwrite values and formulas in the target worksheet cells, but existing formatting will be preserved.{excerpt}
{signature:C#}
public static Area ImportData(this Area area, Microsoft.SharePoint.SPList list, DataImportProperties props)
Signature
{signature}{signature:vb.net
vb.net
}
Public Shared Function ImportData(ByVal area As Area, ByVal list As Microsoft.SharePoint.SPList, ByVal props As DataImportProperties) As Area
Parameters

...

The current Area object which is calling ImportData

...

SharePoint List to use as a data source for the Area

...

A DataImportProperties object that contains a set of properties that will determine the behavior of the data import.

Returns

An Area object representing the set of cells populated with the imported values.

This is an extension method for the Area object to be used for binding SharePoint data to spreadsheets from within SharePoint. To use this method, you must add a reference to
{signature}
{parameters}
{param:area}The current Area object which is calling ImportData
{param}
{param:list}SharePoint List to use as a data source for the Area{param}
{param:props}A [DataImportProperties|DataImportProperties] object that contains a set of properties that will determine the behavior of the data import.{param}
{returns}An {{Area}} object representing the set of cells populated with the imported values.{returns}
{remarks}
{note}This is an extension method for the Area object to be used for binding SharePoint data to spreadsheets from within SharePoint.  To use this method, you must add a reference to SoftArtisans.OfficeWriter.ExcelWriter.SharePointIntegration.dll
{note}
{remarks}
{example}{code:csharp|title=C#}

          DataImportProperties importProps = wb.CreateDataImportProperties();
          importProps.Transpose = true;
          Area importedArea = a.ImportData(myList, importProps);
        
{code}
{code:vb.net
|title=vb.net
}

          Dim importProps As DataImportProperties = wb.CreateDataImportProperties()
          importProps.Transpose = True
          Dim importedArea As Area = a.ImportData(myList, importProps)
        {code}

{example}
Remarks
Note
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle