For Babelfish Release 1.11.3.13

ResultListDisplayColumn Class

Defines one column within a Result List Format table. Which includes the header, body, and footer values. Also includes logic to dynamtically determine when the column is shown, or not shown.

Definition

Namespace: Scopos.BabelFish.DataModel.Definitions
Assembly: BabelFish (in BabelFish.dll) Version: 1.11.3.13+877481945de6b4d2a3a561fea58e2494717cd263
C#
public class ResultListDisplayColumn : IReconfigurableRulebookObject
Inheritance
Object    ResultListDisplayColumn
Implements
IReconfigurableRulebookObject

Constructors

ResultListDisplayColumn Public consructor.

Properties

Body Text, with field interpolation, to display in each cell.

The value of .Body will always be displayed in a body row. If .Child is null, the value of .Body is always displayed in the child rows.

Interpolation fields are defined in the ResultListFormat's Fields section.


Obsolete
BodyLinkTo What, if anything, the text in this cell should link to.
Obsolete
BodyValues Specifies the text, specific class set, and link to options in each line in this column.

NOTE: Most Columsn only define a single line to display.

Child Text, with field interpolation, to display in each cell in a child row.

If .Child is null or an empty stirng, the value of .Body is displayed in its place.

Interpolation fields are defined in the ResultListFormat's Fields section.


Obsolete
ChildValues Specifies the text, specific class set, and link to options in each line in this column's child cells.

NOTE: Most Columsn only define a single line to display.

If ChildValues are not specified .BodyValues is used instead.

ClassList A list of css classes to decorate each cell within this column.
Obsolete
ClassSet List of ClassSet objects that will decorate each cell in this column.

Each ClassSet includes a name of a CSS class (string) and a ShowWhen object to determine if it should be added the the classes used when displaying the column.

Every cell (each body cell and each child cell) will get decorate with the classes listed in .ClassSet. To augment a specific cell, use the .ClassSet property in ResultListCellValue.

Comment Internal documentation comments. All text is ignored by the system.
Footer Text, without interpolation, to display in the footer cell.
Header Text, with out interpolation, to display in the header cell.
ShowSpanningWhen Logic to determine when the Spanning text is displayed.

In order for the Spanning text to be displayed, both this columns .ShowWhen and .ShowSpanningWhen must evaluate to true.

Default is to always show the Spanning text.

ShowWhen Logic to determine when this column should be included (or shown).

Default is to always show the column.

Spanning Text, with field interpolation, to display accress multiple columns, starting at this column.

Only one ResultListDisplayColumn may have a value for Spanning.

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ShouldSerializeBodyValues Newtonsoft helper method, to determine if .BadyValues should be serialized.
ShouldSerializeChildValues Newtonsoft helper method, to determine if .ChildValues should be serialized.
ShouldSerializeClassList A Newtonsoft Conditional Property to only serialize ClassList when the list has something in it. https://www.newtonsoft.com/json/help/html/ConditionalProperties.htm
ShouldSerializeClassSet A Newtonsoft Conditional Property to only serialize ClassSEt when the list has something in it. https://www.newtonsoft.com/json/help/html/ConditionalProperties.htm
ShouldSerializeShowSpanningWhen Newtonsoft.json helper method to determine when the property ShowSpanningWhen is serialized.
ShouldSerializeShowWhen 
ToStringReturns a string that represents the current object.
(Overrides ObjectToString)

See Also