Class ReportDefinition

Inheritance

System.Object

ReportDefinition

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: BoldReports.RDL.DOM

Assembly: BoldReports.Web.dll

Syntax

public class ReportDefinition

Constructors

ReportDefinition()

Declaration

public ReportDefinition()

ReportDefinition(ReportSerializer)

Declaration

public ReportDefinition(ReportSerializer serializer)

Parameters

Type	Name	Description
BoldReports.RDL.DOM.ReportSerializer	serializer

Properties

Author

Gets or sets the author of the report.

Declaration

public string Author { get; set; }

Property Value

Type	Description
System.String	A string representing the author's name.

AutoRefresh

Gets or sets the interval for automatic report refreshing.

Declaration

public int AutoRefresh { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the auto-refresh interval in seconds.

Body

Gets or sets the body of the report.

Declaration

public Body Body { get; set; }

Property Value

Type	Description
Body	The body content of the report.

Classes

Gets or sets the classes used in the report.

Declaration

public Classes Classes { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Classes	The classes defined for the report.

Code

Gets or sets the code associated with the report.

Declaration

public string Code { get; set; }

Property Value

Type	Description
System.String	A string containing custom code for the report.

CodeModules

Gets or sets the code modules used in the report.

Declaration

public CodeModules CodeModules { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.CodeModules	The code modules included in the report.

ConsumeContainerWhitespace

Gets or sets a value indicating whether to remove container whitespace.

Declaration

public bool ConsumeContainerWhitespace { get; set; }

Property Value

Type	Description
System.Boolean	true if container whitespace is removed; otherwise, false.

CustomProperties

Gets or sets custom properties for the report.

Declaration

public CustomProperties CustomProperties { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.CustomProperties	The custom properties defined in the report.

DataElementName

Gets or sets the name for the data element.

Declaration

public string DataElementName { get; set; }

Property Value

Type	Description
System.String	A string representing the data element's name.

DataElementStyle

Gets or sets the style of the data elements in the report.

Declaration

public DataElementStyles DataElementStyle { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.DataElementStyles	The style for data elements.

DataSchema

Gets or sets the data schema for the report.

Declaration

public string DataSchema { get; set; }

Property Value

Type	Description
System.String	A string representing the data schema information.

DataSets

Gets or sets the datasets in the report.

Declaration

public DataSets DataSets { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.DataSets	The datasets included in the report.

DataSources

Gets or sets the data sources for the report.

Declaration

public DataSources DataSources { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.DataSources	The data sources used in the report.

DataTransform

Gets or sets the data transform for the report.

Declaration

public string DataTransform { get; set; }

Property Value

Type	Description
System.String	A string representing the data transform logic.

DefaultFontFamily

Declaration

public string DefaultFontFamily { get; set; }

Property Value

Type	Description
System.String

DeferVariableEvaluation

Gets or sets a value indicating whether variable evaluation is deferred.

Declaration

public bool DeferVariableEvaluation { get; set; }

Property Value

Type	Description
System.Boolean	true if variable evaluation is deferred; otherwise, false.

Description

Gets or sets the description of the report.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	A string representing the report description.

EmbeddedImages

Gets or sets the embedded images in the report.

Declaration

public EmbeddedImages EmbeddedImages { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.EmbeddedImages	The collection of embedded images in the report.

InitialPageName

Gets or sets the initial page name of the report.

Declaration

public string InitialPageName { get; set; }

Property Value

Type	Description
System.String	A string representing the initial page name.

Language

Gets or sets the language used in the report.

Declaration

public string Language { get; set; }

Property Value

Type	Description
System.String	A string representing the report's language.

Page

Gets or sets the page properties of the report.

Declaration

public Page Page { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Page	The page settings for the report.

PageUnit

Declaration

public string PageUnit { get; set; }

Property Value

Type	Description
System.String

RDLType

Declaration

public RDLType RDLType { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.RDLType

ReportParameters

Gets or sets the report parameters.

Declaration

public ReportParameters ReportParameters { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.ReportParameters	The parameters defined for the report.

ReportParametersLayout

Gets or sets the layout of the report parameters.

Declaration

public ReportParametersLayout ReportParametersLayout { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.ReportParametersLayout	The layout structure for the parameters section.

ReportSections

Gets or sets the sections of the report.

Declaration

public ReportSections ReportSections { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.ReportSections	The sections included in the report.

ReportServerUrl

Declaration

public string ReportServerUrl { get; set; }

Property Value

Type	Description
System.String

ReportUnitType

Declaration

public string ReportUnitType { get; set; }

Property Value

Type	Description
System.String

Variables

Gets or sets the variables used within the report.

Declaration

public Variables Variables { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Variables	The variables used in the report logic.

Width

Gets or sets the width of the report.

Declaration

public Size Width { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.Size	The size representing the report width.

Methods

ResetClasses()

Resets the 'Classes' property to a new instance.

Declaration

public void ResetClasses()

ResetCodeModules()

Resets the 'CodeModules' property to a new instance.

Declaration

public void ResetCodeModules()

ResetConsumeContainerWhitespace()

Resets the 'ConsumeContainerWhitespace' property to false.

Declaration

public void ResetConsumeContainerWhitespace()

ResetCustomProperties()

Resets the 'CustomProperties' property to a new instance.

Declaration

public void ResetCustomProperties()

ResetDataElementStyle()

Resets the 'DataElementStyle' to 'DataElementStyles.Attribute'.

Declaration

public void ResetDataElementStyle()

ResetDataSets()

Resets the 'DataSets' property to a new instance.

Declaration

public void ResetDataSets()

ResetDataSources()

Resets the 'DataSources' property to a new instance.

Declaration

public void ResetDataSources()

ResetDefaultFontFamily()

Resets the 'DefaultFontFamily' property to "Segoe UI".

Declaration

public void ResetDefaultFontFamily()

ResetEmbeddedImages()

Resets the 'EmbeddedImages' property to a new instance.

Declaration

public void ResetEmbeddedImages()

ResetPageUnit()

Resets the 'PageUnit' property to an empty string.

Declaration

public void ResetPageUnit()

ResetReportParameters()

Resets the 'ReportParameters' property to a new instance.

Declaration

public void ResetReportParameters()

ResetReportParametersLayout()

Resets the 'ReportParametersLayout' property to null.

Declaration

public void ResetReportParametersLayout()

ResetReportSections()

Resets the 'ReportSections' property to a new instance.

Declaration

public void ResetReportSections()

ResetReportServerUrl()

Resets the 'ReportServerUrl' property to null.

Declaration

public void ResetReportServerUrl()

ResetReportUnitType()

Resets the 'ReportUnitType' property to "Inch".

Declaration

public void ResetReportUnitType()

ResetVariables()

Resets the 'Variables' property to a new instance.

Declaration

public void ResetVariables()

ShouldSerializeClasses()

Determines whether the 'Classes' property should be serialized.

Declaration

public bool ShouldSerializeClasses()

Returns

Type	Description
System.Boolean	True if 'Classes' is not null and contains items; otherwise, false.

ShouldSerializeCodeModules()

Determines whether the 'CodeModules' property should be serialized.

Declaration

public bool ShouldSerializeCodeModules()

Returns

Type	Description
System.Boolean	True if 'CodeModules' is not null and contains items; otherwise, false.

ShouldSerializeConsumeContainerWhitespace()

Determines whether the 'ConsumeContainerWhitespace' property should be serialized.

Declaration

public bool ShouldSerializeConsumeContainerWhitespace()

Returns

Type	Description
System.Boolean	True if 'ConsumeContainerWhitespace' is true; otherwise, false.

ShouldSerializeCustomProperties()

Determines whether the 'CustomProperties' property should be serialized.

Declaration

public bool ShouldSerializeCustomProperties()

Returns

Type	Description
System.Boolean	True if 'CustomProperties' is not null and contains items; otherwise, false.

ShouldSerializeDataElementStyle()

Determines whether the 'DataElementStyle' property should be serialized.

Declaration

public bool ShouldSerializeDataElementStyle()

Returns

Type	Description
System.Boolean	True if 'DataElementStyle' is different from 'DataElementStyles.Attribute'; otherwise, false.

ShouldSerializeDataSets()

Determines whether the 'DataSets' property should be serialized.

Declaration

public bool ShouldSerializeDataSets()

Returns

Type	Description
System.Boolean	True if 'DataSets' is not null and contains items; otherwise, false.

ShouldSerializeDataSources()

Determines whether the 'DataSources' property should be serialized.

Declaration

public bool ShouldSerializeDataSources()

Returns

Type	Description
System.Boolean	True if 'DataSources' is not null and contains items; otherwise, false.

ShouldSerializeDefaultFontFamily()

Determines whether the 'DefaultFontFamily' property should be serialized.

Declaration

public bool ShouldSerializeDefaultFontFamily()

Returns

Type	Description
System.Boolean	True if 'RDLType' is 'RDL2016', 'DefaultFontFamily' is not empty, and is not 'Arial'; otherwise, false.

ShouldSerializeDeferVariableEvaluation()

Determines whether the 'DeferVariableEvaluation' property should be serialized.

Declaration

public bool ShouldSerializeDeferVariableEvaluation()

Returns

Type	Description
System.Boolean	True if 'DeferVariableEvaluation' is true; otherwise, false.

ShouldSerializeEmbeddedImages()

Determines whether the 'EmbeddedImages' property should be serialized.

Declaration

public bool ShouldSerializeEmbeddedImages()

Returns

Type	Description
System.Boolean	True if 'EmbeddedImages' is not null and contains items; otherwise, false.

ShouldSerializePageUnit()

Determines whether the 'PageUnit' property should be serialized.

Declaration

public bool ShouldSerializePageUnit()

Returns

Type	Description
System.Boolean	True if 'PageUnit' is not null or empty; otherwise, false.

ShouldSerializeReportParameters()

Determines whether the 'ReportParameters' property should be serialized.

Declaration

public bool ShouldSerializeReportParameters()

Returns

Type	Description
System.Boolean	True if 'ReportParameters' is not null and contains items; otherwise, false.

ShouldSerializeReportParametersLayout()

Determines whether the 'ReportParametersLayout' property should be serialized.

Declaration

public bool ShouldSerializeReportParametersLayout()

Returns

Type	Description
System.Boolean	True if 'ReportParametersLayout' is not null; otherwise, false.

ShouldSerializeReportSections()

Determines whether the 'ReportSections' property should be serialized.

Declaration

public bool ShouldSerializeReportSections()

Returns

Type	Description
System.Boolean	True if 'ReportSections' is not null and contains items; otherwise, false.

ShouldSerializeReportServerUrl()

Determines whether the 'ReportServerUrl' property should be serialized.

Declaration

public bool ShouldSerializeReportServerUrl()

Returns

Type	Description
System.Boolean	True if 'ReportServerUrl' is not null or empty; otherwise, false.

ShouldSerializeReportUnitType()

Determines whether the 'ReportUnitType' property should be serialized.

Declaration

public bool ShouldSerializeReportUnitType()

Returns

Type	Description
System.Boolean	True if 'ReportUnitType' is not null or empty; otherwise, false.

ShouldSerializeVariables()

Determines whether the 'Variables' property should be serialized.

Declaration

public bool ShouldSerializeVariables()

Returns

Type	Description
System.Boolean	True if 'Variables' is not null and contains items; otherwise, false.

ShouldSerializeWidth()

Determines whether the 'Width' property should be serialized.

Declaration

public bool ShouldSerializeWidth()

Returns

Type	Description
System.Boolean	True if [condition that determines when Width should be serialized]; otherwise, false.