Exago .NET API Documentation
EntityColumnMetadata Class Properties

WebReports.Api.Reports Namespace : EntityColumnMetadata Class

For a list of all members of this type, see EntityColumnMetadata members.

Public Properties
 NameDescription
Public Property

Data columns can have description text added. If the data field is hovered over in a selection screen in the Report Designer, the description text will pop up in a tooltip. 

Tooltip text can be added verbatim in the Column Description field. In-line HTML tags like <b> can also be used if desired. Text may also be registered in the language files. For more information, review the Column Metadata section of the Data Objects article on the Support Center.

 
Public Property

Custom Columns are a way to add columns to Exago that don't exist in the Data Source. This is completely transparent for the users; they can then use them like any other column. New data columns can be created from composite or interpreted data fields. You could even use a formula to create data from scratch. Admins often use custom columns to make popular formula sorts available on an application-wide level.

When creating a Custom Formula Column, the ColumnSource should be set to EntityColumnSource.ExagoFormula. By default, columns from data sources are EntityColumnSource.Data.

 
Public PropertyA string representation of the data type in this column.  
Public PropertyFor custom formula columns, this column contains the Exago formula that defines the contents of the column.  
Public PropertyThe format of datetime data fields. Allows datetime data fields to be properly pulled out of generic string columns. Implemented in order to support datetime metadata for vertical tables.  
Public Property

Whether this field can be added to reports, as an interactive filter or not at all via the user interface.

This setting affects the availability of the column in the user interface. Filters may still be programmatically added to reports with the API regardless of the setting here.
 
Public Property

Whether this field may be added as a Sort to a report in the user interface.

This setting affects the availability of the column in the user interface. Sorts may still be programmatically added to reports with the API regardless of the setting here.
 
Public PropertyDetermine if this column will be visible in the user interface. Even when not visible, the Entity (Data Object) is still available for reporting.  
Public PropertyThe Column Alias, the name of the data field that the end-users see.  
Public Property

Specify a custom formula by which columns should be sorted and grouped by the application.

This field allows admins to specify how columns should be sorted and grouped by the application. By default, Exago will sort (and group) columns based on the data in the column. You can use this metadata field to specify different data by which the column should be sorted.

For example, you may have a custom column Employees.FullName like the following:

{Employees.FirstName} & ' ' & {Employees.LastName}

By default, Exago would sort this field on the full string. You may want to sort on just the LastName, instead. In Sort and Group-By Value, enter {Employees.LastName}, and the column will sort on LastName.

Another common example is sorting a Month field by the numeric representation of the month instead of the name. Since this value accepts any valid Exago formula (except aggregates), custom functions can also be used.

 
Top
See Also

Reference

EntityColumnMetadata Class
WebReports.Api.Reports Namespace