StiSubReport Class

Namespace: Stimulsoft.Report.Components

Inheritance

Inherits from: StiContainer

Constructors

Constructor Description
StiSubReport() Creates a new component of the type StiSubReport.
StiSubReport(RectangleD rect) Creates a new component of the type StiSubReport.

StiSubReport()

Creates a new component of the type StiSubReport.

StiSubReport(rect: RectangleD)

Creates a new component of the type StiSubReport.

Parameters

  • rect (RectangleD) — The rectangle describes size and position of the component.

Properties

Property Type Description
KeepSubReportTogether bool  
Parameters StiParametersCollection  
SubReportPageGuid string  
SubReportUrl string  
ToolboxCategory StiToolboxCategory  

Methods

Method Returns Description
CanContainIn bool May this container be located in the specified component.
Clone (+1 overloads) object  
Convert void Converts a component out of one unit into another.
GetEvents StiEventsCollection Returns events collection of this component.
GetExternalSubReport StiReport Returns the SubReport template for rendering.
GetSubReportForPage static StiSubReport  
GetSubReportFromFile StiReport Returns the SubReport from specified path.
GetSubReportFromUrl StiReport Returns the SubReport from specified url.
InvokeFillParameters void Raises the FillParameters event.
LoadFromJsonObject void  
OnFillParameters void Raises the FillParameters event.
SaveToJsonObject JObject  

Method Details

CanContainIn

CanContainIn(component: StiComponent): bool

May this container be located in the specified component.

Parameters

  • component (StiComponent) — Component for checking.

Returns bool — true, if this container may is located in the specified component.

Clone

Clone(cloneProperties: bool): object

Parameters

  • cloneProperties (bool)

Returns object

Clone(cloneProperties: bool, cloneComponents: bool): object

Creates a new object that is a copy of the current instance.

Parameters

  • cloneProperties (bool)
  • cloneComponents (bool)

Returns object — A new object that is a copy of this instance.

Convert

Convert(oldUnit: StiUnit, newUnit: StiUnit, isReportSnapshot: bool): void

Converts a component out of one unit into another.

Parameters

  • oldUnit (StiUnit) — Old units.
  • newUnit (StiUnit) — New units.
  • isReportSnapshot (bool)

GetEvents

GetEvents(): StiEventsCollection

Returns events collection of this component.

Returns StiEventsCollection

GetExternalSubReport

GetExternalSubReport(): StiReport

Returns the SubReport template for rendering.

Returns StiReport

GetSubReportForPage static

GetSubReportForPage(page: StiPage): StiSubReport

Parameters

  • page (StiPage)

Returns StiSubReport

GetSubReportFromFile

GetSubReportFromFile(url: string): StiReport

Returns the SubReport from specified path.

Parameters

  • url (string)

Returns StiReport

GetSubReportFromUrl

GetSubReportFromUrl(url: string): StiReport

Returns the SubReport from specified url.

Parameters

  • url (string)

Returns StiReport

InvokeFillParameters

InvokeFillParameters(sender: StiComponent, e: StiFillParametersEventArgs): void

Raises the FillParameters event.

Parameters

  • sender (StiComponent)
  • e (StiFillParametersEventArgs)

LoadFromJsonObject

LoadFromJsonObject(jObject: JObject): void

Parameters

OnFillParameters

OnFillParameters(e: StiFillParametersEventArgs): void

Raises the FillParameters event.

Parameters

  • e (StiFillParametersEventArgs)

SaveToJsonObject

SaveToJsonObject(mode: StiJsonSaveMode): JObject

Parameters

Returns JObject