Class CrossViewObject

Represents the crossview object that is used to print cube slice or slicegrid.

Inheritance
System.Object
Base
ComponentBase
ReportComponentBase
BreakableComponent
TableBase
CrossViewObject
Implements
Inherited Members
Namespace: FastReport.CrossView
Assembly: FastReport.Base.dll
Syntax
public class CrossViewObject : TableBase, IFRSerializable, IParent

Constructors

CrossViewObject()

Initializes a new instance of the CrossViewObject class.

Declaration
public CrossViewObject()

Properties

ColumnDescriptorsIndexes

Declaration
public string ColumnDescriptorsIndexes { get; set; }
Property Value
Type Description
System.String

ColumnTerminalIndexes

Declaration
public string ColumnTerminalIndexes { get; set; }
Property Value
Type Description
System.String

CubeSource

Gets or sets a cube source.

Declaration
public CubeSourceBase CubeSource { get; set; }
Property Value
Type Description
CubeSourceBase

Data

Gets the object that holds data of Cube

Declaration
public CrossViewData Data { get; }
Property Value
Type Description
CrossViewData
Remarks

See the CrossViewData class for more details.

ModifyResultEvent

Gets or sets a script method name that will be used to handle the ModifyResult event.

Declaration
public string ModifyResultEvent { get; set; }
Property Value
Type Description
System.String
Remarks

See the ModifyResult event for more details.

RowDescriptorsIndexes

Declaration
public string RowDescriptorsIndexes { get; set; }
Property Value
Type Description
System.String

RowTerminalIndexes

Declaration
public string RowTerminalIndexes { get; set; }
Property Value
Type Description
System.String

ShowTitle

Gets or sets a value indicating whether to show a title row.

Declaration
public bool ShowTitle { get; set; }
Property Value
Type Description
System.Boolean

ShowXAxisFieldsCaption

Gets or sets a value indicating whether to show a X Axis fields Caption.

Declaration
public bool ShowXAxisFieldsCaption { get; set; }
Property Value
Type Description
System.Boolean

ShowYAxisFieldsCaption

Gets or sets a value indicating whether to show a Y Axis fields Caption.

Declaration
public bool ShowYAxisFieldsCaption { get; set; }
Property Value
Type Description
System.Boolean

Style

Gets or sets a matrix style.

Declaration
public string Style { get; set; }
Property Value
Type Description
System.String

Methods

Assign(Base)

Copies the contents of another, similar object.

Declaration
public override void Assign(Base source)
Parameters
Type Name Description
Base source

Source object to copy the contents from.
Overrides
Remarks

Call Assign to copy the properties from another object of the same type. The standard form of a call to Assign is

destination.Assign(source);

which tells the destination object to copy the contents of the source object to itself. In this method, all child objects are ignored. If you want to copy child objects, use the AssignAll method.

See Also

BuildTemplate()

Creates or updates the matrix template.

Declaration
public void BuildTemplate()
Remarks

Call this method after you modify the matrix descriptors using the Data object's properties.

DeserializeSubItems(FRReader)

Deserializes nested object properties.

Declaration
protected override void DeserializeSubItems(FRReader reader)
Parameters
Type Name Description
FRReader reader

Reader object.
Overrides
Remarks

Typically the object serializes all properties to the single xml item:

<TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>

Some objects like DataBand have child objects that serialized in subitems:

<DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
  <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
</DataBand>

To read such subitems, the DeserializeSubItems method is used. Base implementation reads the child objects. You may override it to read some specific subitems.

FinalizeComponent()

Performs a finalization after the report is finished.

Declaration
public override void FinalizeComponent()
Overrides
Remarks

This method is used by the report engine, do not call it directly.

GetData()

Gets the data from a datasource that the object is connected to.

Declaration
public override void GetData()
Overrides
Remarks

This method is called by the report engine before processing the object.

Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should get the data from a datasource that the object is connected to.

GetDataAsync(CancellationToken)

Declaration
public override async Task GetDataAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
Overrides

InitializeComponent()

Initializes the object before running a report.

Declaration
public override void InitializeComponent()
Overrides
Remarks

This method is used by the report engine, do not call it directly.

OnModifyResult(EventArgs)

This method fires the ModifyResult event and the script code connected to the ModifyResultEvent.

Declaration
public void OnModifyResult(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

Event data.

RestoreState()

Restores the object's state after printing it.

Declaration
public override void RestoreState()
Overrides
Remarks

This method is called by the report engine after processing the object.

Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should restore the object properties that were saved by the SaveState() method.

SaveState()

Saves the object's state before printing it.

Declaration
public override void SaveState()
Overrides
Remarks

This method is called by the report engine before processing the object.

Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should save any object properties that may be changed during the object printing. The standard implementation saves the object's bounds, visibility, bookmark and hyperlink.

Serialize(FRWriter)

Serializes the object.

Declaration
public override void Serialize(FRWriter writer)
Parameters
Type Name Description
FRWriter writer

Writer object.
Overrides
Remarks

Do not call this method directly. You should override it if you are developing a new component for FastReport.

This method is called when the object needs to save the state. It may happen when:

  • saving the report to the file or stream;
  • saving the report to the designer's undo buffer;
  • assigning the object to another object using the Assign(Base) or AssignAll methods;
  • saving the object to the designer's clipboard;
  • saving the object to the preview (when run a report).

Events

ModifyResult

Allows to modify the prepared matrix elements such as cells, rows, columns.

Declaration
public event EventHandler ModifyResult
Event Type
Type Description
System.EventHandler

Implements