Class HierarchicalRecord

Hierarchical record - record with properties to build hierarchy of records which can be shown on a Hierarchical chart (TreeMap, Sunburst, Bubble)

Inheritance

System.Object

RecordBase

HierarchicalRecord

HierarchicalRootRecord

Implements

IHierarchicalRecord

IRecord

Inherited Members

RecordBase.DoChange()

RecordBase.Change

Namespace: FastReport.BG.Data

Assembly: FastReport.BG.dll

Syntax

public class HierarchicalRecord : RecordBase, IHierarchicalRecord, IRecord

Constructors

HierarchicalRecord()

Constructs HierarchicalRecord instance

Declaration

public HierarchicalRecord()

HierarchicalRecord(String)

Constructs Hierarchical record with specified text Record Type = HierarchicalRecordType.Group

Declaration

public HierarchicalRecord(string text)

Parameters

Type	Name	Description
System.String	text	record text

HierarchicalRecord(String, Double)

Constructs Hierarchical record with specified text and value Record Type = HierarchicalRecordType.Value

Declaration

public HierarchicalRecord(string text, double value)

Parameters

Type	Name	Description
System.String	text	record text
System.Double	value	record value

Fields

children

Childs.

Declaration

protected HierarchicalRecords children

Field Value

Type	Description
HierarchicalRecords

Properties

Children

Children collection

Declaration

public virtual HierarchicalRecords Children { get; }

Property Value

Type	Description
HierarchicalRecords

Index

Record index in parent children list

Declaration

[Browsable(false)]
public int Index { get; }

Property Value

Type	Description
System.Int32

Level

Record level in hierarchy

Declaration

[Browsable(false)]
public int Level { get; }

Property Value

Type	Description
System.Int32

Parent

Reference to parent record

Declaration

[Browsable(false)]
public HierarchicalRecord Parent { get; }

Property Value

Type	Description
HierarchicalRecord

RecordType

Type of record

Declaration

public virtual HierarchicalRecordType RecordType { get; set; }

Property Value

Type	Description
HierarchicalRecordType

Tag

Record tag

Declaration

public override object Tag { get; set; }

Property Value

Type	Description
System.Object

Overrides

RecordBase.Tag

Text

Record text

Declaration

public override string Text { get; set; }

Property Value

Type	Description
System.String

Overrides

RecordBase.Text

Value

Record value

Declaration

public override double Value { get; set; }

Property Value

Type	Description
System.Double

Overrides

RecordBase.Value

Methods

Deserialize(XmlItem)

Deserialize Record from XMLItem

Declaration

public void Deserialize(XmlItem item)

Parameters

Type	Name	Description
XmlItem	item	XMLItem for deserialization

ResetValue()

Resets Value to default (0)

Declaration

public void ResetValue()

Serialize(XmlItem)

Serialize Record to XmlItem

Declaration

public void Serialize(XmlItem item)

Parameters

Type	Name	Description
XmlItem	item	XmlItem for serialization

ShouldSerializeValue()

Defines whether Designer should serialze Value property

Declaration

public bool ShouldSerializeValue()

Returns

Type	Description
System.Boolean	true - should serialize;false - should not serialize

Remarks

Records with Type = HierarchicalRecordType.Group does not serialize their Value

Explicit Interface Implementations

IHierarchicalRecord.Children

Declaration

IEnumerable<IHierarchicalRecord> IHierarchicalRecord.Children { get; }

Returns

Type	Description
System.Collections.Generic.IEnumerable<IHierarchicalRecord>

IHierarchicalRecord.Parent

Declaration

IHierarchicalRecord IHierarchicalRecord.Parent { get; }

Returns

Type	Description
IHierarchicalRecord

Implements

IHierarchicalRecord

IRecord