Studio Reports - Sections and Applicable Properties

Applies to: Kyvos Reporting

Report Section Properties

Each section of an Kyvos Reporting report supports specific properties that define layout, behavior, and export settings. The following table lists the available properties for each section type.

Report

Property	Description

Property	Description
`ApplyI18nForDataFields`	Enables internationalization (i18n) for data fields.
`documentName`	Sets the name of the document.
`PrintWidth`	Defines the maximum printable width of the report.
`ScriptDebuggerEnabled`	Allows script debugging during report generation.
`ScriptLanguage`	Specifies the scripting language used (e.g., JavaScript).
`ShowParameterUI`	Enables or disables the parameter prompt UI at runtime.
`Watermark`	Sets the watermark text or image.
`WatermarkAlignment`	Controls alignment of the watermark on the report.
`WatermarkPrintOnPages`	Specifies on which pages the watermark should appear.
`XLCellHeight`	Defines Excel cell height during export.
`XLCellWidth`	Defines Excel cell width during export.

Report Header and Report Footer

Property	Description

Property	Description
`Name`	Section name.
`BackColor`	Background color of the section.
`BackStyle`	Defines if background is applied (Normal) or transparent.
`CanGrow`	Expands the section vertically if content overflows.
`CanShrink`	Shrinks the section vertically if content is smaller.
`height`	Height of the section.
`IncludeInCSV`	Includes the section in CSV export.
`NewPage`	Controls page breaks before/after section.
`Underlay Next Section`	Allows section to print underneath the next one.
`Visible`	Sets section visibility.
`XLBackground`	Background fill when exporting to Excel.
`XMLTagName`	Custom XML tag name for export.

Page Header and Page Footer

Property	Description

Property	Description
`Name`	Section name.
`BackColor`	Background color of the section.
`BackStyle`	Normal or transparent background.
`CaptionPos`	Position of the caption in the section.
`height`	Height of the section.
`IncludeInCSV`	Includes section in CSV export.
`OnPages`	Controls display based on page (e.g., exclude RH/RF pages).
`Underlay Next Section(s)`	Allows overlay with following section(s).
`Visible`	Sets section visibility.
`XLBackground`	Background fill when exporting to Excel.

Group Header and Group Footer

Property	Description

Property	Description
`Name`	Section name.
`BackColor`	Background color of the section.
`BackStyle`	Normal or transparent background.
`CanGrow`	Expands the section if content overflows.
`CanShrink`	Shrinks the section if content is minimal.
`ChraGroupBy`	Character-based grouping.
`ColumnLayout`	Defines multi-column layout for grouping.
`DataField`	Field used for grouping.
`DateGroupBy`	Group by date interval (Day, Month, Year, etc.).
`GrpKeepTogether`	Keeps group header/footer together on same page.
`height`	Height of the section.
`IncludeInCSV`	Includes section in CSV export.
`KeepTogether`	Prevents page breaks within the group.
`NewColumn`	Starts a new column after the section.
`NewPage`	Starts a new page after the section.
`NumericGroupBy`	Numeric grouping based on range or interval.
`RankingField`	Field to use for ranking records.
`RankingFunction`	Function to apply for ranking (e.g., Top N).
`Repeat`	Repeats the group header on every page.
`SortOrder`	Sorting order for the group.
`TOCField`	Adds entry to the Table of Contents.
`Underlay Next Section(s)`	Allows overlay with following section(s).
`Visible`	Sets section visibility.
`XLBackground`	Background color for Excel export.
`XMLTagName`	Custom XML tag name for export.
`XMLType`	Defines XML element type (attribute, element, etc.).

Detail Section

Property	Description

Property	Description
`Name`	Section name.
`BackColor`	Background color of the section.
`BackStyle`	Normal or transparent background.
`CanGrow`	Expands section if content overflows.
`CanShrink`	Shrinks section if content is minimal.
`ColumnCount`	Number of columns for multi-column layout.
`ColumnDirection`	Order of content rendering (AcrossDown or DownAcross).
`ColumnSpacing`	Spacing between columns.
`height`	Height of the section.
`IncludeInCSV`	Includes section in CSV export.
`KeepTogether`	Prevents detail records from splitting across pages.
`NewColumn`	Starts a new column after the section.
`NewPage`	Starts a new page after the section.
`Underlay Next Section(s)`	Allows overlay with following section(s).
`Visible`	Sets section visibility.
`XLBackground`	Background fill for Excel export.
`XMLTagName`	Custom XML tag name for export.
`XMLType`	Defines XML element type for export.