GetElements(ICatalogEntity,ICatalog,Boolean) Method

public static CatalogElement[] GetElements( 
   ICatalogEntity entity,
   ICatalog catalog,
   bool ignoreNullValueItems
)

'Declaration
 
Public Overloads Shared Function GetElements( _
   ByVal entity As ICatalogEntity, _
   ByVal catalog As ICatalog, _
   ByVal ignoreNullValueItems As Boolean _
) As CatalogElement()

'Usage
 
Dim entity As ICatalogEntity
Dim catalog As ICatalog
Dim ignoreNullValueItems As Boolean
Dim value() As CatalogElement
 
value = CatalogDescriptor.GetElements(entity, catalog, ignoreNullValueItems)

public:
static array<CatalogElement^>^ GetElements( 
   ICatalogEntity^ entity,
   ICatalog^ catalog,
   bool ignoreNullValueItems
) 

Parameters

entity

An ICatalogEntity whose properties will be returned.

catalog

The ICatalog interface that describes the provided entity.

ignoreNullValueItems

If this parameter is set to true, properties that have null (Nothing in Visual Basic) values won't be returned.

Return Value

For the provided ICatalogEntity all properties annotated with the EntityElementAttribute will be enumerated.
A key for the ICatalogEntity will be retrieved using ICatalogEntity.CatalogKey method.
A key for each property will be retrieved using the following method:
If the EntityElementAttribute.Name has a value (not null or empty string) then it will be used as the key value otherwise the actual Name of the System.Reflection.PropertyInfo will be used as the key.
The CatalogDescriptor will use the ICatalog object to find the information of this catalog element and fill them in a CatalogElement object.

Target Platforms

Reference

CatalogDescriptor Class
CatalogDescriptor Members
Overload List