Class CustomHighlight
Base class for highlight Implements abstract interface
Namespace: FastReport.Olap.Slice
Assembly: FastReport.Olap.dll
Syntax
public abstract class CustomHighlightConstructors
CustomHighlight(CustomHighlights)
Declaration
public CustomHighlight(CustomHighlights owner)Parameters
| Type | Name | Description |
|---|---|---|
| CustomHighlights | owner |
Fields
owner
Declaration
protected CustomHighlights ownerField Value
| Type | Description |
|---|---|
| CustomHighlights |
Properties
ApplyTo
Defines cell types to apply highlight
Declaration
public HighlightApply ApplyTo { get; set; }Property Value
| Type | Description |
|---|---|
| HighlightApply |
Caption
Caption for highlight editor
Declaration
public virtual string Caption { get; }Property Value
| Type | Description |
|---|---|
| System.String |
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
Declaration
public virtual bool HideValue { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Index
Highlight index in list
Declaration
public int Index { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
IsCustomDrawn
Defines whether highlight needs to be pained by highlight class
Declaration
public virtual bool IsCustomDrawn { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Owner
Reference to owner highlights list
Declaration
public CustomHighlights Owner { get; }Property Value
| Type | Description |
|---|---|
| CustomHighlights |
ScanDirection
Value scan direction for highlights that depend on surrounding cells
Declaration
public HighlightScanDirection ScanDirection { get; set; }Property Value
| Type | Description |
|---|---|
| HighlightScanDirection |
Methods
AcceptCell(MeasureCell)
Test whether value passes highlight condition
Declaration
public abstract bool AcceptCell(MeasureCell cell)Parameters
| Type | Name | Description |
|---|---|---|
| MeasureCell | cell | cell to test |
Returns
| Type | Description |
|---|---|
| System.Boolean | True - acceps, False - skips |
Assign(CustomHighlight)
Copy settings from source highlight
Declaration
public virtual void Assign(CustomHighlight source)Parameters
| Type | Name | Description |
|---|---|---|
| CustomHighlight | source | Source to copy from |
BeginUpdate()
Allows to start multiple property change operation Needs to be finished with EndUpdate
Declaration
public virtual void BeginUpdate()DoChange()
Declaration
protected void DoChange()EndUpdate()
Finish multiple property change operation
Declaration
public virtual void EndUpdate()GetExpressions()
Gets all expressions contained in the object.
Declaration
public virtual 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.
Load(XmlItem)
Load from XML
Declaration
public virtual void Load(XmlItem item)Parameters
| Type | Name | Description |
|---|---|---|
| XmlItem | item | XML Item |
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 ChangedEvent Type
| Type | Description |
|---|---|
| System.EventHandler |