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
{introducedin:7.1.0.1855}
{description}
{excerpt}Imports data from a SharePoint View 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.SPView view, Microsoft.SharePoint.SPList list, DataImportProperties props)
{signature}{signature:vb.net}
Public Shared Function ImportData(ByVal area As Area, ByVal view As Microsoft.SharePoint.SPView, 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:view}SharePoint View to use as a data source for the template
{param}
{param:list}SharePoint List associated with the SharePoint View{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(myView, myList, importProps);
        {code}
{code:vb.net|title=vb.net}

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

{example}