OfficeWriter Documentation
.
PowerPointWriter v8
Space Shortcuts
Page tree
ConfigureSpace tools

Versions Compared

Old Version 2

changes.mady.by.user Gabe Goodwin [softartisans]

Saved on

compared with

New Version 3

changes.mady.by.user Gabe Goodwin [softartisans]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Description

Excerpt

Sets a rectangular array of objects as a template data source.

Signature
C#
C#

 public void BindData(System.Object[,] arrayData, System.String[] columnNames, System.String dataSourceName, DataBindingProperties property)
Signature
vb.net
vb.net

Public Sub BindData(ByVal arrayData As Object(,), ByVal columnNames As String(), ByVal dataSourceName As String, ByVal [property] As DataBindingProperties)
Parameters
Param
arrayData
arrayData

A rectangular array of objects to use as the data source. By default, the first dimension corresponds to row and the second to column (that is, Object[row,column]).

Param
columnNames
columnNames

The names of the columns to get from the data source. If the columnNames parameter is null, field binding can only be performed by ordinal (for example, %%=DSN.#1 or %%=$DSN). If columnNames is specified, both ordinal field binding and named field binding can be used.

Param
dataSourceName
dataSourceName

The name of the set of data markers at which to insert the values imported from the data source. dataSourceName must be specified, but can be left as null or an empty string if this is the first data source bound AND the data markers in the template use the short data marker syntax or refer to the datasource by number rather than name. Note: dataSourceName does not include a data marker's column name, for example, the dataSourceName for %%=Products.ProductID is "Products."

Param
property
property

The DataBindingProperties object which contains information about how the data should be bound to the template.

Param
property
property

The DataBindingProperties object which contains information about how the data should be bound to the template. property Must be specified, but the DataBindingProperties need not be set beforehand. To bind data to a template with the default DataBindingProperties, pass in PowerPointTemplate.CreateDataBindingProperties() as the property value. Otherwise, use the PowerPointTemplate.CreateDataBindingProperties() method to generate a new DataBindingProperties object and set the DataBindingProperties.MaxRows, DataBindingProperties.Transpose, and/or DataBindingProperties.WorksheetName properties for the workbook.

Exceptions
Exception
ArgumentNullException
ArgumentNullException

BindData will throw this exception if null (C#) or Nothing (VB.NET) is passed to the method.

Exception
ArgumentException
ArgumentException

Exception
SARuntimeException
SARuntimeException

BindData will throw this exception if the data source contains more rows than the worksheet can hold.
If there is more than one data marker referring to a data source and the data source is forward only, the exception will be thrown only if the source is larger than all bindings can hold.

Example
Wiki Markup

{csharp}

          PowerPointTemplate pptt = new PowerPointTemplate();
          pptt.Open(Page.MapPath("./ArrayBindingTemplate2.xls"));

          //--- Create an array of names and an array of data
          //--- source values and bind the data source to the
          //--- template data markers
          //--- %%=TwoDimArray.FirstName
          //--- %%=TwoDimArray.LastName
          //--- %%=TwoDimArray.Position
          string[,] twoDimNormal = {
               {"Nancy", "Davolio", "Sales Manager"},
               {"Michael", "Suyama", "HR Representative"},
               {"Adrian", "King", "IS Support"}
               };
          string[] names = {"FirstName", "LastName", "Position"};
          pptt.BindData(twoDimNormal,
               names,
               "TwoDimArray",
               pptt.CreateDataBindingProperties());
{csharp}
{vb.net}
Option Strict On
Option Explicit On

          Dim pptt As New PowerPointTemplate()
          pptt.Open(Page.MapPath("./ArrayBindingTemplate2.xls"))

          '--- Create an array of names and an array of data
          '--- source values and bind the data source to the
          '--- template data markers
          '--- %%=TwoDimArray.FirstName
          '--- %%=TwoDimArray.LastName
          '--- %%=TwoDimArray.Position
          Dim twoDimNormal(,) As String = New String(,){ _
               {"Nancy", "Davolio", "Sales Manager"}, _
               {"Michael", "Suyama", "HR Representative"}, _
               {"Adrian", "King", "IS Support"}}
          Dim names As String() = {"FirstName", "LastName", "Position"}
          pptt.BindData(twoDimNormal, _
               names, _
               "TwoDimArray", _
               pptt.CreateDataBindingProperties())
        {vbnet}