Class CustomHighlights

Highlight collection

Inheritance

System.Object

System.Collections.CollectionBase

CustomHighlights

Namespace: FastReport.Olap.Slice

Assembly: FastReport.Olap.dll

Syntax

public class CustomHighlights : CollectionBase, IList, ICollection, IEnumerable

Constructors

CustomHighlights(MeasureField)

Declaration

public CustomHighlights(MeasureField measure)

Parameters

Type	Name	Description
MeasureField	measure

Fields

registeredHighlights

Declaration

public static Dictionary<string, Type> registeredHighlights

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Type>

Properties

Item[Int32]

Highlight by index

Declaration

public CustomHighlight this[int Index] { get; }

Parameters

Type	Name	Description
System.Int32	Index	highlight index

Property Value

Type	Description
CustomHighlight	highlight instance

Measure

Reference to Measure field

Declaration

public MeasureField Measure { get; }

Property Value

Type	Description
MeasureField

Methods

Add(String)

Adds highlight defined by class name

Declaration

public CustomHighlight Add(string className)

Parameters

Type	Name	Description
System.String	className	highlight class name

Returns

Type	Description
CustomHighlight	highlight instance

Add(Type)

Adds highlight defined by class

Declaration

public CustomHighlight Add(Type Class)

Parameters

Type	Name	Description
System.Type	Class	highlight class

Returns

Type	Description
CustomHighlight	highlight instance

Assign(CustomHighlights)

Make a full copy of another highlight collection

Declaration

public void Assign(CustomHighlights source)

Parameters

Type	Name	Description
CustomHighlights	source	Source collection to copy from

BeginUpdate()

Start change operation

Declaration

public virtual void BeginUpdate()

DoChange()

Declaration

protected virtual void DoChange()

EndUpdate()

Finish change operation

Declaration

public virtual void EndUpdate()

GetCompiledHighlights()

Get built-in highlights for editor

Declaration

public static Dictionary<string, Type> GetCompiledHighlights()

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Type>	Collection of highlights

GetExpressions()

Gets all expressions contained in the object.

Declaration

public Expression[] GetExpressions()

Returns

Type	Description
Expression[]	Array of expressions or null if object contains no expressions.

Remarks

Do not call this method directly.

This method is called by FastCube each time before building a slice. FastCube do this to collect all expressions and compile them.

IndexOf(CustomHighlight)

item position in collection

Declaration

public int IndexOf(CustomHighlight item)

Parameters

Type	Name	Description
CustomHighlight	item	highlight item

Returns

Type	Description
System.Int32	index in collection

Load(XmlItem)

Load from XML

Declaration

public virtual void Load(XmlItem item)

Parameters

Type	Name	Description
XmlItem	item	XML item

OnClearComplete()

Declaration

protected override void OnClearComplete()

Overrides

System.Collections.CollectionBase.OnClearComplete()

OnInsertComplete(Int32, Object)

Declaration

protected override void OnInsertComplete(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

Overrides

System.Collections.CollectionBase.OnInsertComplete(System.Int32, System.Object)

OnRemoveComplete(Int32, Object)

Declaration

protected override void OnRemoveComplete(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

Overrides

System.Collections.CollectionBase.OnRemoveComplete(System.Int32, System.Object)

OnSetComplete(Int32, Object, Object)

Declaration

protected override void OnSetComplete(int index, object oldValue, object newValue)

Parameters

Type	Name	Description
System.Int32	index
System.Object	oldValue
System.Object	newValue

Overrides

System.Collections.CollectionBase.OnSetComplete(System.Int32, System.Object, System.Object)

OnValidate(Object)

Declaration

protected override void OnValidate(object value)

Parameters

Type	Name	Description
System.Object	value

Overrides

System.Collections.CollectionBase.OnValidate(System.Object)

RequestAggregate(MeasureCell, HighlightAggregate, HighlightScanDirection)

Get min/max for measure defined by cell

Declaration

public double RequestAggregate(MeasureCell cell, HighlightAggregate aggregate, HighlightScanDirection direction)

Parameters

Type	Name	Description
MeasureCell	cell	measure cell
HighlightAggregate	aggregate	HighlightAggregate
HighlightScanDirection	direction	Scan direction

Returns

Type	Description
System.Double	min/max value

RequestExpression(MeasureCell, Expression)

Declaration

public object RequestExpression(MeasureCell cell, Expression expr)

Parameters

Type	Name	Description
MeasureCell	cell
Expression	expr

Returns

Type	Description
System.Object

RequestIsRepeatable(MeasureCell, HighlightScanDirection)

Declaration

public bool RequestIsRepeatable(MeasureCell cell, HighlightScanDirection direction)

Parameters

Type	Name	Description
MeasureCell	cell
HighlightScanDirection	direction

Returns

Type	Description
System.Boolean

RequestPercent(MeasureCell, Double, HighlightScanDirection)

Get percent for measure defined by cell

Declaration

public double RequestPercent(MeasureCell cell, double percent, HighlightScanDirection direction)

Parameters

Type	Name	Description
MeasureCell	cell	measure cell
System.Double	percent	percent to get
HighlightScanDirection	direction	Scan direction

Returns

Type	Description
System.Double	percent value

RequestPercentile(MeasureCell, Double, HighlightScanDirection)

Get percentile for measure defined by cell

Declaration

public double RequestPercentile(MeasureCell cell, double percentile, HighlightScanDirection direction)

Parameters

Type	Name	Description
MeasureCell	cell	measure cell
System.Double	percentile
HighlightScanDirection	direction	scan direction

Returns

Type	Description
System.Double	percentile value

RequestRank(MeasureCell, HighlightScanDirection)

Declaration

public int RequestRank(MeasureCell cell, HighlightScanDirection direction)

Parameters

Type	Name	Description
MeasureCell	cell
HighlightScanDirection	direction

Returns

Type	Description
System.Int32

RequestValue(MeasureCell)

Get measure cell value

Declaration

public double RequestValue(MeasureCell cell)

Parameters

Type	Name	Description
MeasureCell	cell	measure cell

Returns

Type	Description
System.Double	cell value

Save(XmlItem)

Save to XML

Declaration

public virtual void Save(XmlItem item)

Parameters

Type	Name	Description
XmlItem	item	XML item

Events

Changed

Event handler executes on all changes

Declaration

public event EventHandler Changed

Event Type

Type	Description
System.EventHandler