Class HeaderDescriptor

The descriptor that is used to describe one element of the matrix header.

Inheritance

System.Object

HeaderDescriptor

Implements

IFRSerializable

Namespace: FastReport.AdvMatrix

Assembly: FastReport.dll

Syntax

public class HeaderDescriptor : IFRSerializable

Remarks

The class is used to define one header element of the matrix (either the column element or row element). The key properties are Expression and Sort.

The collection of descriptors used to represent the matrix header is stored in the AdvMatrixObject.Data.Columns and AdvMatrixObject.Data.Rows properties.

Constructors

HeaderDescriptor()

Initializes a new instance of the HeaderDescriptor class.

Declaration

public HeaderDescriptor()

HeaderDescriptor(String)

Initializes a new instance of the HeaderDescriptor class with the group expression specified.

Declaration

public HeaderDescriptor(string expression)

Parameters

Type	Name	Description
System.String	expression

Properties

ColSpan

Gets or sets column span of this item. 0 means span is set automatically.

Declaration

public int ColSpan { get; set; }

Property Value

Type	Description
System.Int32

DisplayText

Gets or sets a text which will be displayed in this item.

Declaration

public string DisplayText { get; set; }

Property Value

Type	Description
System.String

Remarks

DisplayText may contain text mixed with expressions just like in the TextObject, e.g. "Some text: [expr]". The default property value is empty for group descriptors. In this case the group value returned by the Expression property will be displayed in this item.

Expression

Gets or sets an expression which value will be used to fill the matrix.

Declaration

public string Expression { get; set; }

Property Value

Type	Description
System.String

Remarks

Expression may be any valid expression. Usually it's a data column: [DataSource.Column].

Filter

Gets or sets the filter expression.

Declaration

public string Filter { get; set; }

Property Value

Type	Description
System.String

InteractiveSort

Gets or sets a value indicating that this item can be sorted interactively.

Declaration

public bool InteractiveSort { get; set; }

Property Value

Type	Description
System.Boolean

InteractiveSortBy

Gets or sets an expression which value will be used to sort the header values interactively.

Declaration

public string InteractiveSortBy { get; set; }

Property Value

Type	Description
System.String

Remarks

This expression is used to sort header values when interactive sorting is on. The expression must contain single aggregate, e.g. "Sum([Table1.Field1])". The empty expression (by default) indicates automatic mode.

Items

Gets child items of this descriptor.

Declaration

public List<HeaderDescriptor> Items { get; }

Property Value

Type	Description
System.Collections.Generic.List<HeaderDescriptor>

MergeSingleItem

Determines whether the item should merge itself with single subitem.

Declaration

public bool MergeSingleItem { get; set; }

Property Value

Type	Description
System.Boolean

Name

Gets or sets the name of this descriptor.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Remarks

This property is used by the TopN engine to find linked items such as TopNTotal, Others, OtherTotal. All others descriptors have empty name.

PageBreak

Gets or sets a value indicating that the page break must be printed before this element.

Declaration

public bool PageBreak { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Page break is not printed before the very first element.

Parent

Gets the parent descriptor of this descriptor.

Declaration

public HeaderDescriptor Parent { get; }

Property Value

Type	Description
HeaderDescriptor

RowSpan

Gets or sets row span of this item. 0 means span is set automatically.

Declaration

public int RowSpan { get; set; }

Property Value

Type	Description
System.Int32

Sort

Gets or sets the sort order of header values.

Declaration

public SortOrder Sort { get; set; }

Property Value

Type	Description
SortOrder

Remarks

This property determines how the values displayed in this element are sorted. The default sort is ascending.

SortByTotal

Gets or sets an expression which value will be used to sort the header values.

Declaration

public string SortByTotal { get; set; }

Property Value

Type	Description
System.String

Remarks

This expression is used to sort header by its total value. The expression must contain single aggregate, e.g. "Sum([Table1.Field1])". The empty expression (by default) indicates that the header should be sorted by its value.

SortToggledBy

Gets or sets the sort button name which toggles the sort order of this item.

Declaration

public string SortToggledBy { get; set; }

Property Value

Type	Description
System.String

Stepped

Determines whether this item and its subitems will be displayed stepped.

Declaration

public bool Stepped { get; set; }

Property Value

Type	Description
System.Boolean

TopN

Gets TopN settings for this item.

Declaration

public TopNInfo TopN { get; }

Property Value

Type	Description
TopNInfo

Visible

Gets or sets the visibility of this item.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean

VisibleExpression

Gets or sets the expression that returns the visibility of this item.

Declaration

public string VisibleExpression { get; set; }

Property Value

Type	Description
System.String

VisibleToggledBy

Gets or sets the collapse button name which toggles the visibility of this item.

Declaration

public string VisibleToggledBy { get; set; }

Property Value

Type	Description
System.String

Methods

Add()

Adds new child descriptor.

Declaration

public HeaderDescriptor Add()

Returns

Type	Description
HeaderDescriptor	The new descriptor.

Add(HeaderDescriptor)

Adds a child descriptor.

Declaration

public HeaderDescriptor Add(HeaderDescriptor descr)

Parameters

Type	Name	Description
HeaderDescriptor	descr	The new descriptor.

Returns

Type	Description
HeaderDescriptor	The new descriptor.

Deserialize(FRReader)

Deserializes the object.

Declaration

public void Deserialize(FRReader reader)

Parameters

Type	Name	Description
FRReader	reader	Reader object.

Serialize(FRWriter)

Serializes the object.

Declaration

public void Serialize(FRWriter writer)

Parameters

Type	Name	Description
FRWriter	writer	Writer object.

Implements

IFRSerializable