OfficeWriter Documentation
.
ExcelWriter v8 Docs
Space Shortcuts
Page tree
ConfigureSpace tools

Versions Compared

Old Version 5

changes.mady.by.user Unknown User (williaml)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (williaml)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Introducedin
7.1.0.1855

...

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#
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
{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
Parameters
Param
area
area

The current Area object which is calling ImportData

Param
list
list

SharePoint List to use as a data source for the Area

Param
props
props

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.

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#}

Example
Code Block
csharp
csharp
titleC#


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


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

{example}