Class CustomHighlight
Namespace: FastReport.Olap.Slice
Assembly: FastCube.Core.dll
Base class for highlight Implements abstract interface
public abstract class CustomHighlight
Inheritance
Constructors
CustomHighlight(CustomHighlights)
Creates a new instance.
public CustomHighlight(CustomHighlights owner)
Parameters
owner CustomHighlights
Fields
owner
Owner of the instance.
protected CustomHighlights owner
Field Value
Properties
ApplyTo
Defines cell types to apply highlight
public HighlightApply ApplyTo { get; set; }
Property Value
Caption
Caption for highlight editor
public virtual string Caption { get; }
Property Value
HideValue
Defines whether to draw only highlight in the cell without the cell value itself E.g.: bar and icon highlights can be drawn without the value
public virtual bool HideValue { get; }
Property Value
Index
Highlight index in list
public int Index { get; set; }
Property Value
IsCustomDrawn
Defines whether highlight needs to be pained by highlight class
public virtual bool IsCustomDrawn { get; }
Property Value
Owner
Reference to owner highlights list
public CustomHighlights Owner { get; }
Property Value
ScanDirection
Value scan direction for highlights that depend on surrounding cells
public HighlightScanDirection ScanDirection { get; set; }
Property Value
Methods
AcceptCell(MeasureCell)
Test whether value passes highlight condition
public abstract bool AcceptCell(MeasureCell cell)
Parameters
cell MeasureCell
cell to test
Returns
True - acceps, False - skips
Assign(CustomHighlight)
Copy settings from source highlight
public virtual void Assign(CustomHighlight source)
Parameters
source CustomHighlight
Source to copy from
BeginUpdate()
Allows to start multiple property change operation Needs to be finished with EndUpdate
public virtual void BeginUpdate()
DoChange()
Does changes and call the event.
protected void DoChange()
EndUpdate()
Finish multiple property change operation
public virtual void EndUpdate()
GetExpressions()
Gets all expressions contained in the object.
public virtual 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.
Load(XmlItem)
Load from XML
public virtual void Load(XmlItem item)
Parameters
item XmlItem
XML Item
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