Page tree

Versions Compared

Key

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

...

Wiki Markup
{description}
{excerpt}Sets a template's main document data source to an

...

 {msdn

...

:System.Collections.IDictionary

...

|IDictionary} collection. An {{IDictionary}} represents a collection of key\-and\-value pairs.

...

Signature
C#C#

{excerpt}
{signature:C#}
 public void SetDataSource(System.Collections.IDictionary dataSource)
Signature
{signature}
{signature:vb.net
vb.net
}
Public Sub SetDataSource(ByVal dataSource As System.Collections.IDictionary)
Parameters

...

An IDictionary collection of key-and-value pairs.

Exceptions


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

          wTempl.SetDataSource(coll);
        
{code}
{code:vb.net
|title=vb.net
}

          wTempl.SetDataSource(coll)
        {code}

{example}
Exception
ArgumentNullExceptionArgumentNullException

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

Exception
ArgumentExceptionArgumentException
Remarks

Each merge field in a WordWriter template must bind to a data source field/value pair. The number of merge fields in the main template document (the part of the document that is not within a repeat block) may not exceed the number of values in the data source defined by SetDataSource. However, the number of values in the data source may be greater than the number of merge fields in the main template document.

Do not call this method more than once for a single instance of WordTemplate. To set multiple main document data sources, use the following methods:
{signature}
{parameters}
{param:dataSource}An {{IDictionary}} collection of key\-and\-value pairs.
{param}
{exceptions}
{exception:ArgumentNullException}[Save|WordTemplate.Save] will throw this exception if {{null}} \(C\#\) or {{Nothing}} \(VB.NET\) is passed to the method.
{exception}
{exception:ArgumentException}
{exception}
{remarks}Each merge field in a WordWriter template must bind to a data source field/value pair. The number of merge fields in the main template document \(the part of the document that is not within a repeat block\) may not exceed the number of values in the data source defined by [SetDataSource|WordTemplate.SetDataSource]. However, the number of values in the data source may be greater than the number of merge fields in the main template document.

Do not call this method more than once for a single instance of [WordTemplate|WordTemplate]. To set multiple main document data sources, use the following methods:\[SetDataSource(Object(), String(), String)|WordTemplate.SetDataSource(Object(), String(), String)]\[SetDataSource(System.Data.DataSet, String)|WordTemplate.SetDataSource(System.Data.DataSet, String)]\[SetDataSource(System.Data.DataTable, String)|WordTemplate.SetDataSource(System.Data.DataTable, String)]\[SetDataSource(System.Data.IDataReader, String)|WordTemplate.SetDataSource(System.Data.IDataReader, String)]
Example
Code Block
csharpcsharp
titleC#
Code Block
vb.nettitle