Class ReportProperties

The report properties describes global options for a report or sub report.

Inheritance
System.Object
BridgedObject
ReportProperties
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: inetsoftware.Reporting
Assembly: inetsoftware.Reporting.dll
Syntax
public class ReportProperties : BridgedObject

Properties

AcrossThenDown

The printing direction of a multi-column report.

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

ClipboardEnabled

Enable the clipboard of the viewer. If disabled, then the user can't copy text from the viewer to the clipboard. This setting is on by default.

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

ConvertNullValuesToDefault

If is set to true the report will convert null values from the database to a 0 (for numeric fields) or a blank(for non-numeric fields).

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

Distinct

If it is 

true
then duplicated records will not be fetched.

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

EnabledFormats

a list of valid formats, that is, which formats it is possible to render. All values that can be used in the Engine Constructor are valid.

Declaration
public string[] EnabledFormats { get; set; }
Property Value
Type Description
System.String[]

ExportEnabled

Enable or disable the export button and the export API of the viewer.

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

FormatGroupsWithMultipleColumn

Should be group header/footer be treated as an ordinary label in a multi-column report?

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

FormatWithMultipleColumns

Sets if the detail section of the report should be formatted in multiple columns of variable or fixed (labels) length.

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

FormPrint

Determines whether this report is a form - forms are never automatically resized if the designed margins are larger than the printable area, rather, the area which is not printable is truncated instead.The default value is false.

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

GroupTreeVisible

Enable or disable the GroupTree of the viewer.

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

HidePageFooterInsideReportHeader

The value of the flag "Hide PageFooter inside ReportHeader".

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

Horizontal

The horizontal gap between multi-column labels.

Declaration
public int Horizontal { get; set; }
Property Value
Type Description
System.Int32

LabelHeight

The height of a multi-column label.

Declaration
public int LabelHeight { get; set; }
Property Value
Type Description
System.Int32

LabelName

The label name, such as "User Defined Label" or "Address".

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

LabelWidth

The width of a multi-column label.

Declaration
public int LabelWidth { get; set; }
Property Value
Type Description
System.Int32

MarginBottom

The top bottom margin of the page in twips.

Declaration
public int MarginBottom { get; set; }
Property Value
Type Description
System.Int32

MarginLeft

The left margin of the page in twips.

Declaration
public int MarginLeft { get; set; }
Property Value
Type Description
System.Int32

MarginRight

The right margin of the page in twips.

Declaration
public int MarginRight { get; set; }
Property Value
Type Description
System.Int32

MarginTop

The top margin of the page in twips.

Declaration
public int MarginTop { get; set; }
Property Value
Type Description
System.Int32

PaperHeight

The height of the report page in twips.

Declaration
public int PaperHeight { get; set; }
Property Value
Type Description
System.Int32

PaperWidth

The width of the report page in twips.

Declaration
public int PaperWidth { get; set; }
Property Value
Type Description
System.Int32

PrintingEnabled

Enable or disable the print button in some document viewers.

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

RowBufferSize

The row count which will be cached during the rendering process. We advise to set this at 30000 rows. The minimum size of buffer is 3 rows.A row count of 0 disables the row buffer.Decrease this value if the engine throws OutOfMemoryError but note that this increases the rendering time.

Declaration
public int RowBufferSize { get; set; }
Property Value
Type Description
System.Int32

SaveDatasource

If a copy of the datasource configuration should saved in the report file.

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

ShowSuppressedGroupTreeNodes

Controls the group tree nodes of suppressed group areas will be shown.

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

SuppressIfNoRows

Is set to true the (sub)report will only be printed if rows are fetched from the database.

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

Vertical

The vertical gap between multi-column labels.

Declaration
public int Vertical { get; set; }
Property Value
Type Description
System.Int32

Methods

GetPaperOrient()

Returns the orientation of the paper.

Declaration
public int GetPaperOrient()
Returns
Type Description
System.Int32

IsValidForRowBuffer()

Returns whether or not this report is suited for buffering of rows. Buffering rows causes the engine to only fetch parts of the data at a time, reducing memory usage, but raising the rendering time.Row buffering is intended for rendering large amounts of data.In order to use row buffering, the report should not contain groups, summary functions, charts, or crosstabs. To use row buffering, set the buffer size with setRowBufferSize.

Declaration
public bool IsValidForRowBuffer()
Returns
Type Description
System.Boolean

true if this report is suited for row buffering

SetPaperOrient(Int32, Int32)

Sets the orientation and size of the report for printing.

Declaration
public void SetPaperOrient(int paperOrientation, int paperSize)
Parameters
Type Name Description
System.Int32 paperOrientation

The orientation of the paper
System.Int32 paperSize

The size of the paper.

SetPaperSize(Int32, Int32)

Sets the paper width and paper height depending on the supplied paper format and orientation.

Declaration
public void SetPaperSize(int paperOrient, int paperFormat)
Parameters
Type Name Description
System.Int32 paperOrient

The paper orientation to set for this report.
System.Int32 paperFormat

The paper format to set for this report.