Page History

...

Description

Excerpt
Sets a main document data source to an ADO.NET

...

DataSet.

...

A

...

DataSet

...

contains

...

a

...

collection

...

of

...

DataTables.

...

If

...

you

...

set

...

a

...

main

...

document

...

data

...

source

...

to

...

a

...

DataSet,

...

WordWriter

...

will

...

get

...

the

...

first

...

row

...

of

...

the

...

first

...

DataTable

...

in

...

the

...

DataSet.

...

Signature

	C#
	C#

 public void SetDataSource(System.Data.DataSet ds, System.String name)
{signature}
{signature:

}

Signature

	vb.net


	vb.net

Public Sub SetDataSource(ByVal ds As System.Data.DataSet, ByVal name As String)
{signature}
{parameters}
{param:ds}An

Parameters

Param

	ds
	ds

An ADO.NET

DataSet

to

use

as

the

template's

data

source.

WordWriter

will

use

the

first

row

of

the

first

DataTable

in

the

DataSet

as

the

data

source.

{param} {param:name}Specifies the data source name for the set of merge fields. {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 a set \(merge fields that share the same data source name or number\) 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 set. This method may be called once for each set of merge fields in the main document. {remarks} {example}{code:csharp|title=C#}

Param

	name
	name

Specifies the data source name for the set of merge fields.

Exceptions

Exception

	ArgumentNullException
	ArgumentNullException

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

Exception

	ArgumentException
	ArgumentException

Remarks

Each merge field in a WordWriter template must bind to a data source field/value pair. The number of merge fields in a set (merge fields that share the same data source name or number) 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 set.

This method may be called once for each set of merge fields in the main document.

Example

Code Block

	csharp
	csharp
title	C#



          WordTemplate oWW = new WordTemplate();
          oWW.Open(@"c:\temp\template.doc");
          string strSQL = "SELECT LastName, FirstName, " +
               "TitleOfCourtesy, Address, City, Region, PostalCode " +
               "FROM Employees WHERE EmployeeID=1";

          //--- Create an OLEDB connection.
          OleDbConnection oConn = new OleDbConnection(strConnString);

          //--- Create an instance of the OleDbDataAdapter
          //--- object.
          OleDbDataAdapter oAdpt = new OleDbDataAdapter(strSQL, oConn);

          //--- Create a DataSet and fill it with the data
          //--- returned by the SQL database query.
          DataSet oDS = new DataSet();
          oAdpt.Fill(oDS);

          //--- Pass the DataSet to SetDataSource. WordWriter
          //--- will use the first DataTable in the DataSet as
          //--- the data source.
          oWW.SetDataSource(oDS, "Employee");
          ...

{code} {code:

Code Block

	vb.net

|title=


	vb.net
title	vb.net

}



          Dim oWW As New WordTemplate()
          oWW.Open("c:\temp\template.doc")
          Dim strSQL As String = "SELECT LastName, FirstName, " & _
               "TitleOfCourtesy, Address, City, Region, PostalCode " & _
               "FROM Employees WHERE EmployeeID=1"

          '--- Create an OLEDB connection.
          Dim oConn As New OleDbConnection(strConnString)

          '--- Create an instance of the OleDbDataAdapter
          '--- object.
          Dim oAdpt As New OleDbDataAdapter(strSQL, oConn)

          '--- Create a DataSet and fill it with the data
          '--- returned by the SQL database query.
          Dim oDS As New DataSet()
          oAdpt.Fill(oDS)

          '--- Pass the DataSet to SetDataSource. WordWriter
          '--- will use the first DataTable in the DataSet as
          '--- the data source.
          oWW.SetDataSource(oDS, "Employee")
          ...

{code} {example}

Space Shortcuts

Page tree

Versions Compared

Old Version 8

New Version 9

Key