Share via

IEntityInstance.EntityAsFormattedDataRow Method

  • Article

Exposes the entity instance as a DataRow object in the specified DataTable object with formatting of the complex fields in the entity instance.

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Runtime
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
Function EntityAsFormattedDataRow ( _
    tableToAddRowTo As DataTable _
) As DataRow

'Usage
Dim instance As IEntityInstance
Dim tableToAddRowTo As DataTable
Dim returnValue As DataRow

returnValue = instance.EntityAsFormattedDataRow(tableToAddRowTo)

DataRow EntityAsFormattedDataRow(
    DataTable tableToAddRowTo
)

Parameters

  • tableToAddRowTo
    Type: System.Data.DataTable
    The DataTable object to add the entity instance as a row to.

Return Value

Type: System.Data.DataRow
A DataRow object containing all the fields in the entity instance.

Remarks

The DataTable is a central object in the Microsoft ADO.NET library. It represents one table of in-memory data.

When entity instances are transformed into data rows in a data table, they lose the special semantics attached to them in the Business Data Catalog, such as the ability to call instance methods on them. Therefore, you should transform entity instances into data rows only if absolutely necessary. Avoid using ADO.NET adapters that convert Business Data Catalog return types for maximum performance.

See Also

Reference

IEntityInstance Interface

IEntityInstance Members

Microsoft.Office.Server.ApplicationRegistry.Runtime Namespace