EntityParameterCollection Class

The collection of Parameters on an Entity (Data Object) in the configuration. Do not instantiate this collection, access the collection via the Entity.Parameters Property.

Parameters that are passed to stored procedures, table functions, Web Services or .NET Assembly methods. Clicking in the drop-down will bring up a menu. Click the Add button and select the parameter from the drop-down list.

Syntax

public class EntityParameterCollection : WebReports.Api.Common.WrProtectedList<EntityParameter>

Remarks

Collection classes are enumerable Lists of a specific object type.

See the Example section for ways to iterate through and manipulate Collections.

Example

Various ways to interact with Collection objects.

/* Usings */
using System.Linq;
using WebReports.Api;
using WebReports.Api.Common;

/* Namespace and Class definitions omitted */

Logger Logger = Log.GetLogger();
Api Api = new Api("/Exago/");

EntityCollection Entities = Api.Entities; // get the static Api.Entities Collection by reference

foreach (Entity Entity in Entities) // iterate through the EntityCollection and log all items
    Logger.InfoFormat("Original - Entity: '{0}'", Entity.Name);

// List methods may be overridden or overloaded depending on the Collection type
Entities.Add(new Entity(Api.PageInfo, "Customers")); // add a new Entity "Customers" to Entities
Entities.Remove(Entities.GetEntity("Orders")); // remove Entity "Orders" from Entities

foreach (Entity Entity in Entities) // iterate and log again
    Logger.InfoFormat("Modified - Entity: '{0}'", Entity.Name);

// Standard List and IEnumerable Linq methods can be used on Collection objects
Entities.OrderBy(Entity => Entity.Name) // sort Entities by Entity.Name
// (Order does not matter for every Collection type)

// Iterate and log again, this time using List<T>.ForEach
Entities.ForEach(Entity => Logger.InfoFormat("Sorted - Entity: '{0}'", Entity.Name));

/*
This code writes the following output to the Exago logfile (in an example configuration):

Original - Entity: 'Orders'
Original - Entity: 'Products'
Modified - Entity: 'Products'
Modified - Entity: 'Customers'
Sorted - Entity: 'Customers'
Sorted - Entity: 'Products'

*/

Inheritance Hierarchy

System.Object
WebReports.Api.Reports.EntityParameterCollection

Reference