AbstractEntityInstance.EntityAsFormattedDataRow Method

  • Article

When overridden in a derived class, 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
Public Overridable Function EntityAsFormattedDataRow ( _
    tableToAddRowTo As DataTable _
) As DataRow

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

returnValue = instance.EntityAsFormattedDataRow(tableToAddRowTo)

public virtual 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.

Implements

IEntityInstance.EntityAsFormattedDataRow(DataTable)

Remarks

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 in to data rows only if absolutely necessary. Avoid using ADO.NET adapters that convert Business Data Catalog return types for maximum performance.

See Also

Reference

AbstractEntityInstance Class

AbstractEntityInstance Members

Microsoft.Office.Server.ApplicationRegistry.Runtime Namespace