TX Text Control .NET Server

LoadDataFromModelAsync Method

Method|Introduced in 24.0
Namespace
TXTextControl.Web
Package
None: the TX Text Control .NET Server setup installs it, for .NET Framework.
Assembly
TXTextControl.Web.dll

Description

Loads a collection implementing interface System.Collections.IEnumerable as a data source.

Syntax

LoadDataFromModelAsync(System.Collections.IEnumerable)

Interprets all public properties of the objects in the collection as possible table columns and / or child tables. The type of the first object in the collection is analyzed via .NET reflection and used as the basis of the assumed table structure. For more information about using object based data sources see DocumentServer.MailMerge.MergeObjects. The method returns immediately.

public async System.Threading.Tasks.Task LoadDataFromModelAsync(System.Collections.IEnumerable model);
ParameterDescription
model

Specifies a System.Collections.IEnumerable that contains the merge data.

LoadDataFromModelAsync(System.Collections.IEnumerable, System.IFormatProvider)

Allows to additionally specify a format which should be applied when converting date / time values and numerical values to strings.

public async System.Threading.Tasks.Task LoadDataFromModelAsync(System.Collections.IEnumerable model, System.IFormatProvider numberAndDateTimeFormat);
ParameterDescription
model

Specifies a System.Collections.IEnumerable that contains the merge data.

numberAndDateTimeFormat

The format which should be applied when converting date / time values and numerical values to strings.

Examples

The following example loads a small customer model into the server-side editor helper before the Razor view renders it.

var customers = new[]
{
    new { CustomerName = "Contoso Ltd.", City = "Seattle" }
};
var configuredEditor = textControl.LoadDataFromModel(customers);
Console.WriteLine($"Configured editor: {configuredEditor.GetType().Name}");