Class CustomHighlights
Namespace: FastReport.Olap.Slice
Assembly: FastCube.Core.dll
Highlight collection
public class CustomHighlights : CollectionBase
Inheritance
object ← CollectionBase ← CustomHighlights
Constructors
CustomHighlights(MeasureField)
Creates a new instance.
public CustomHighlights(MeasureField measure)
Parameters
measure MeasureField
Fields
registeredHighlights
All registered highlights.
public static Dictionary<string, Type> registeredHighlights
Field Value
Properties
Measure
Reference to Measure field
public MeasureField Measure { get; }
Property Value
this[int]
Highlight by index
public CustomHighlight this[int Index] { get; }
Property Value
Methods
Add(Type)
Adds highlight defined by class
public CustomHighlight Add(Type Class)
Parameters
Class Type
highlight class
Returns
highlight instance
Add(string)
Adds highlight defined by class name
public CustomHighlight Add(string className)
Parameters
className string
highlight class name
Returns
highlight instance
Assign(CustomHighlights)
Make a full copy of another highlight collection
public void Assign(CustomHighlights source)
Parameters
source CustomHighlights
Source collection to copy from
BeginUpdate()
Start change operation
public virtual void BeginUpdate()
DoChange()
Does changes and call the event.
protected virtual void DoChange()
EndUpdate()
Finish change operation
public virtual void EndUpdate()
GetCompiledHighlights()
Get built-in highlights for editor
public static Dictionary<string, Type> GetCompiledHighlights()
Returns
Collection of highlights
GetExpressions()
Gets all expressions contained in the object.
public Expression[] GetExpressions()
Returns
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
public int IndexOf(CustomHighlight item)
Parameters
item CustomHighlight
highlight item
Returns
index in collection
Load(XmlItem)
Load from XML
public virtual void Load(XmlItem item)
Parameters
item XmlItem
XML item
OnClearComplete()
Calls changed event on clear complete.
protected override void OnClearComplete()
OnInsertComplete(int, object)
Calls changed event on insert complete.
protected override void OnInsertComplete(int index, object value)
Parameters
index int
value object
OnRemoveComplete(int, object)
Calls changed event on remove complete.
protected override void OnRemoveComplete(int index, object value)
Parameters
index int
value object
OnSetComplete(int, object, object)
Calls changed event on set complete.
protected override void OnSetComplete(int index, object oldValue, object newValue)
Parameters
index int
oldValue object
newValue object
OnValidate(object)
Validates value.
protected override void OnValidate(object value)
Parameters
value object
Exceptions
RequestAggregate(MeasureCell, HighlightAggregate, HighlightScanDirection)
Get min/max for measure defined by cell
public double RequestAggregate(MeasureCell cell, HighlightAggregate aggregate, HighlightScanDirection direction)
Parameters
cell MeasureCell
measure cell
aggregate HighlightAggregate
HighlightAggregate
direction HighlightScanDirection
Scan direction
Returns
min/max value
RequestExpression(MeasureCell, Expression)
Requests expression.
public object RequestExpression(MeasureCell cell, Expression expr)
Parameters
cell MeasureCell
expr Expression
Returns
RequestIsRepeatable(MeasureCell, HighlightScanDirection)
Requests is repeatable.
public bool RequestIsRepeatable(MeasureCell cell, HighlightScanDirection direction)
Parameters
cell MeasureCell
direction HighlightScanDirection
Returns
RequestPercent(MeasureCell, double, HighlightScanDirection)
Get percent for measure defined by cell
public double RequestPercent(MeasureCell cell, double percent, HighlightScanDirection direction)
Parameters
cell MeasureCell
measure cell
percent double
percent to get
direction HighlightScanDirection
Scan direction
Returns
percent value
RequestPercentile(MeasureCell, double, HighlightScanDirection)
Get percentile for measure defined by cell
public double RequestPercentile(MeasureCell cell, double percentile, HighlightScanDirection direction)
Parameters
cell MeasureCell
measure cell
percentile double
percentile to get
direction HighlightScanDirection
scan direction
Returns
percentile value
RequestRank(MeasureCell, HighlightScanDirection)
Requests rank.
public int RequestRank(MeasureCell cell, HighlightScanDirection direction)
Parameters
cell MeasureCell
direction HighlightScanDirection
Returns
RequestValue(MeasureCell)
Get measure cell value
public double RequestValue(MeasureCell cell)
Parameters
cell MeasureCell
measure cell
Returns
cell value
Save(XmlItem)
Save to XML
public virtual void Save(XmlItem item)
Parameters
item XmlItem
XML item
Changed
Event handler executes on all changes
public event EventHandler Changed