Class Cube

Inheritance

System.Object

System.MarshalByRefObject

System.ComponentModel.Component

Cube

Namespace: FastReport.Olap.Cube

Assembly: FastReport.Olap.dll

Syntax

[ToolboxBitmap(typeof(Cube), "Resources.Cube.bmp")]
public class Cube : Component, IComponent, IDisposable

Constructors

Cube()

Declaration

public Cube()

Cube(IContainer)

Declaration

public Cube(IContainer container)

Parameters

Type	Name	Description
System.ComponentModel.IContainer	container

Properties

Aborted

Gets a value indicating that cube execution was aborted.

Declaration

[Browsable(false)]
public bool Aborted { get; }

Property Value

Type	Description
System.Boolean

Active

Determines whether the Cube is Active or not. To open the Cube set correctly SourceType property and Active = true.

Declaration

public bool Active { get; set; }

Property Value

Type	Description
System.Boolean

Caption

The Cube caption. Visible in the Slice grid header and Fields dialog.

Declaration

public string Caption { get; set; }

Property Value

Type	Description
System.String

CompressCubeFile

Defines whether to use compression for cube files

Declaration

public bool CompressCubeFile { get; set; }

Property Value

Type	Description
System.Boolean

CubeFields

Declaration

public CubeFields CubeFields { get; }

Property Value

Type	Description
CubeFields

DataSource

Declaration

public DataSource DataSource { get; set; }

Property Value

Type	Description
DataSource

DayOfWeekISO8601

use ISO8601 to calc day of week

Declaration

public bool DayOfWeekISO8601 { get; set; }

Property Value

Type	Description
System.Boolean

Description

The Cube description. Can be used to set/get a detailed string description. Is not visible in any visual component.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

LoadingStep

Declaration

[Browsable(false)]
public LoadingStep LoadingStep { get; }

Property Value

Type	Description
LoadingStep

Operation

Gets the cube operation that is currently performed.

Declaration

[Browsable(false)]
public CubeOperation Operation { get; }

Property Value

Type	Description
CubeOperation

SaveExtras

Option which regulates what extras saves with Cube to the cube file or stream

Declaration

public SliceSaveExtras SaveExtras { get; set; }

Property Value

Type	Description
SliceSaveExtras

SkipFieldsWithErrors

To ignore fields which have not passed the test on the datasource opening

Declaration

public bool SkipFieldsWithErrors { get; set; }

Property Value

Type	Description
System.Boolean

SourceType

Determines which source of data must be used to load the Cube after setting Active = true

Declaration

public SourceType SourceType { get; set; }

Property Value

Type	Description
SourceType

State

More detailed information about the Cube sate. See also Active property.

Declaration

[Browsable(false)]
public State State { get; }

Property Value

Type	Description
State

TimeStats

Gets the cube operations duration

Declaration

[Browsable(false)]
public TimeStats TimeStats { get; }

Property Value

Type	Description
TimeStats

WeekNumberISO8601

use ISO8601 to calc WeekNumber

Declaration

public bool WeekNumberISO8601 { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Abort()

Aborts the cube execution.

Declaration

public void Abort()

Append(Stream)

Declaration

public void Append(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream

Append(String)

Declaration

public void Append(string fileName)

Parameters

Type	Name	Description
System.String	fileName

AppendData()

Declaration

public void AppendData()

ClearGroups()

Declaration

public void ClearGroups()

Close()

Declaration

public void Close()

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

Overrides

System.ComponentModel.Component.Dispose(System.Boolean)

GetFieldsCount()

Declaration

public int GetFieldsCount()

Returns

Type	Description
System.Int32

GetSourceRecordsCount()

Declaration

public int GetSourceRecordsCount()

Returns

Type	Description
System.Int32

GetSourceValue(Int32, CubeField)

Declaration

public Variant GetSourceValue(int recordIndex, CubeField cubeField)

Parameters

Type	Name	Description
System.Int32	recordIndex
CubeField	cubeField

Returns

Type	Description
Variant

GetSourceValue(Int32, Int32)

Declaration

public Variant GetSourceValue(int recordIndex, int fieldIndex)

Parameters

Type	Name	Description
System.Int32	recordIndex
System.Int32	fieldIndex

Returns

Type	Description
Variant

GetSourceValueAsString(Int32, CubeField)

Declaration

public string GetSourceValueAsString(int recordIndex, CubeField cubeField)

Parameters

Type	Name	Description
System.Int32	recordIndex
CubeField	cubeField

Returns

Type	Description
System.String

GetSourceValueAsString(Int32, Int32)

Declaration

public string GetSourceValueAsString(int recordIndex, int fieldIndex)

Parameters

Type	Name	Description
System.Int32	recordIndex
System.Int32	fieldIndex

Returns

Type	Description
System.String

GetSourceValueId(Int32, CubeField)

Declaration

public int GetSourceValueId(int recordIndex, CubeField cubeField)

Parameters

Type	Name	Description
System.Int32	recordIndex
CubeField	cubeField

Returns

Type	Description
System.Int32

GetSourceValueId(Int32, Int32)

Declaration

public int GetSourceValueId(int recordIndex, int fieldIndex)

Parameters

Type	Name	Description
System.Int32	recordIndex
System.Int32	fieldIndex

Returns

Type	Description
System.Int32

GetSourceValueIdAndVariant(Int32, CubeField, out Variant)

Declaration

public int GetSourceValueIdAndVariant(int recordIndex, CubeField cubeField, out Variant value)

Parameters

Type	Name	Description
System.Int32	recordIndex
CubeField	cubeField
Variant	value

Returns

Type	Description
System.Int32

GetSourceValueIdAndVariant(Int32, Int32, out Variant)

Declaration

public int GetSourceValueIdAndVariant(int recordIndex, int fieldIndex, out Variant value)

Parameters

Type	Name	Description
System.Int32	recordIndex
System.Int32	fieldIndex
Variant	value

Returns

Type	Description
System.Int32

Load(Stream)

Declaration

public void Load(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream

Load(String)

Declaration

public void Load(string fileName)

Parameters

Type	Name	Description
System.String	fileName

LoadGroups(XmlItem, Boolean)

Declaration

public void LoadGroups(XmlItem item, bool clearGroups)

Parameters

Type	Name	Description
XmlItem	item
System.Boolean	clearGroups

Open()

Declaration

public void Open()

RefreshData()

Declaration

public void RefreshData()

Save(Stream, Boolean, Object)

Declaration

public void Save(Stream s, bool compress = true, object filter = null)

Parameters

Type	Name	Description
System.IO.Stream	s
System.Boolean	compress
System.Object	filter

Save(String)

Declaration

public void Save(string fileName)

Parameters

Type	Name	Description
System.String	fileName

SaveGroups(XmlItem, Boolean)

Declaration

public void SaveGroups(XmlItem item, bool onlyForNotSavedFields = false)

Parameters

Type	Name	Description
XmlItem	item
System.Boolean	onlyForNotSavedFields

SendAlert(CubeAlertEventArgs)

Declaration

protected void SendAlert(CubeAlertEventArgs alert)

Parameters

Type	Name	Description
CubeAlertEventArgs	alert

Events

AlertEventHandler

Declaration

public event CubeAlertEventHandler AlertEventHandler

Event Type

Type	Description
CubeAlertEventHandler

ManualLoad

Declaration

public event CubeManualLoadEventHandler ManualLoad

Event Type

Type	Description
CubeManualLoadEventHandler