Section Class

Represents a report band.

Inheritance

object

ReportObject

VisualReportObject

Section

Implements

IScriptContextProvider

Namespace: C1.Report

Assembly: C1.Report.dll

Syntax

public class Section : VisualReportObject, IScriptContextProvider

Public Class Section
    Inherits VisualReportObject
    Implements IScriptContextProvider

Remarks

Each Section object contains a collection of SubSection objects.

Every report contains the following sections:

A detail section.

A report header and a report footer section.

A page header and a page footer section.

A group header and a group footer section for each Group object in the report.

The total number of sections in a report is therefore

5 + 2 * Groups.Count

. Sections cannot be added and removed from reports directly. The number of sections is a function of the number of groups.

Although sections cannot be removed, they can be hidden by setting their Visible property to false.

Properties

Name	Description
AutoHeight	Gets or sets a value determining how the height of the section changes depending on its content.
Calculated	Gets a value indicating whether the current section has already been calculated and its RenderHeight property contains a valid value.
CanGrow	Gets or sets a value indicating whether the section's height is automatically increased to fit its content.
CanShrink	Gets or sets a value indicating whether the section's height should be reduced when one or more fields shrink.
Fields	Gets a collection of all fields in this Section.
ForcePageBreak	Gets or sets a value determining whether page breaks should be inserted before and/or after the section.
Height	Gets the height of the current section in twips. This is the sum of the heights of all sub-sections of the current section.
KeepTogether	Specifies whether the Section should be kept together on a page.
Name	Gets or sets the Section name.
OnFormat	Gets or sets a string containing VBScript code to be executed before the Section is formatted.
OnPrint	Gets or sets a string containing VBScript code to be executed before the Section is printed (after it is formatted).
ParentReport	Gets the FlexReport object that contains this Section.
PrintAtPageBottom	For master report's footer sections only, gets or sets a value indicating whether the current section should print at the bottom of the page immediately above the page footer, rather than right below the detail. The default is false. This property is ignored for non-footer sections or for footers of sub-reports.
RenderHeight	Gets the actual height of the current section. This is the sum of the heights of all its sub-sections. This property can only be used while the report is being rendered, otherwise it returns -1. Note that if this property is used in the section's OnFormat script, then it returns the height calculated for the previous instance of the section, or -1 if this is the first calculation.
Repeat	For group header, group footer and report footer sections only, gets or sets a value indicating whether the current section should be repeated at the top or bottom of each page. The default is false.
SplitBehavior	Gets or sets a value determining how the section behaves when it is too high to fit in the vertical space available on the current page.
SubSections	Gets the collection of sub-sections in the current section. This collection contains at least one element.
Type	Returns the Section type (e.g., PageHeader, Detail).
UseColumnLayout	For master report's group and detail sections only, gets or sets a value indicating whether the current section should use column layout defined by Columns and ColumnLayout properties.
Visible	Specifies whether the Section will be rendered in the report.

Methods

Name	Description
AfterRender()	Called when report rendering finished. Can be used to finalize object after rendering.
AssignFrom(ReportObject, bool)	Assigns (copies) properties from another Section to the current object. This method copies list of subsections but does not copy list of fields. This method does NOT copy type of the section.
BeforeRender()	Called where report rendering starts. Can be used to initialize object before rendering.
CalculateSize()	Calculates section's size. Note! This method does not execute OnFormat script and does not fire StartSection event and intended to be used from VB scripts to update RenderHeight property.
CreateSame()	Creates instance of the same type as current object.
GetPropsTable()
Import(XmlNodeWrapperBase)	Imports node from legacy xml report definition;