Class ReportViewerModel

Contains all the properties and events of the ReportViewer

Inheritance

System.Object

ReportViewerModel

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.Web.ReportViewer

Assembly: BoldReports.Web.dll

Syntax

public class ReportViewerModel

Constructors

ReportViewerModel()

Initializes a new instance of the ReportViewerModel class.

Declaration

public ReportViewerModel()

Properties

AccessInternalValue

Allows to pass the hidden or internal report parameter informations to client side. The default is false.

Declaration

public bool AccessInternalValue { get; set; }

Property Value

Type	Description
System.Boolean	If true it will return the hidden parameters to user ; otherwise false.

Assemblies

Gets the assemblies used in the custom code or code modules.

Declaration

public List<Assembly> Assemblies { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.Reflection.Assembly>	A collection that contains the assemblies that are used in the custom code or code modules.

CacheSettings

Gets or sets the possible caching mode of the report. It contains cache expiration strategies.

Declaration

public CacheSettings CacheSettings { get; set; }

Property Value

Type	Description
CacheSettings	Specifies the cache expiration strategies

CsvOptions

Gets or sets the CSV document export behaviors.

Declaration

public CsvOptions CsvOptions { get; set; }

Property Value

Type	Description
CsvOptions	It contains details of the encoding, delimiters, qualifiers, extension, line break, UseFormattedValues.

CustomStyleSheets

Gets or sets the external css to load custom styles in the report.

Declaration

public Dictionary<string, Dictionary<string, string>> CustomStyleSheets { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.Dictionary<System.String, System.String>>	The collections of external css details.

DataSourceCredentials

Gets or sets the collections of data source credentials to connect the report server.

Declaration

public List<DataSourceCredentials> DataSourceCredentials { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DataSourceCredentials>	The List containing the Name, UserID, Password, ConnectionString, IntegratedSecurity of the data source.

DataSources

Represents the collection of the data source to connect the database from a server.

Declaration

public ReportDataSourceCollection DataSources { get; set; }

Property Value

Type	Description
BoldReports.Web.ReportDataSourceCollection	The data sources collection represents the data sources referenced in a published report definition.

DisablePageSplitting

Gets or sets a boolean value that indicates whether the textbox reportitem page splitting is allowed or not.The default is false.

Declaration

public bool DisablePageSplitting { get; set; }

Property Value

Type	Description
System.Boolean	Set the value as true to avoid page splitting; otherwise false.

DisablePreviewDataLimit

Declaration

public bool DisablePreviewDataLimit { get; set; }

Property Value

Type	Description
System.Boolean

EmbedImageData

Gets or sets a boolean value that indicates whether the image data is embedded as base64 data in HTML tags or not. The default is false.

Declaration

public bool EmbedImageData { get; set; }

Property Value

Type	Description
System.Boolean	It set to true if embedded image data is base64 data in HTML tags; otherwise false.

EnableRequestLimiting

Gets or sets a boolean value that indicates whether the enabled the single call process is allowed or not.The default is false.

Declaration

public bool EnableRequestLimiting { get; set; }

Property Value

Type	Description
System.Boolean	Set the value as true to avoid Multiple request call from client side; otherwise false.

EnableVirtualEvaluation

Gets or sets a boolean value that indicates whether the virtual evaluation is enabled or not. The default is false.

Declaration

public bool EnableVirtualEvaluation { get; set; }

Property Value

Type	Description
System.Boolean	Set the value as true to handle the larger amount data; otherwise false.

Remarks

EnableVirtualEvaluation is used to handle the larger amount data.

ExcelOptions

Gets or sets the Excel document export behaviors.

Declaration

public ExcelOptions ExcelOptions { get; set; }

Property Value

Type	Description
ExcelOptions	It contains the ExcelSaveType, LayoutOption, PasswordToOpen, PasswordToModify, ExcelSheetProtection, ReadOnlyRecommended, DisableCellFormat.

ExportResources

Gets or Sets the Scripts, JQuery and Styles required to export the reports with data visualization items.

Declaration

public ExportResources ExportResources { get; set; }

Property Value

Type	Description
ExportResources	Conatins the list of Scripts, JQuery and Styles.

ExportSettings

Gets or Sets the image quality required to export the reports with data visualization items in high or Low quality.

Declaration

public ExportSettings ExportSettings { get; set; }

Property Value

Type	Description
ExportSettings	Image quality is an integer that represents the 1 to 10.

ExtendedAttributes

Gets or sets the collection of extended attributes.

Declaration

public Dictionary<string, string> ExtendedAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>	A dictionary containing key-value pairs that represent the extended attributes.

FontSettings

Gets or sets the fonts location details to load font from given path.

Declaration

public FontSettings FontSettings { get; set; }

Property Value

Type	Description
FontSettings	The collections of report fonts details.

HTMLOptions

Gets or sets the HTML document export behaviors.

Declaration

public HTMLOptions HTMLOptions { get; set; }

Property Value

Type	Description
HTMLOptions	The class containing the HideHTMLPageSeparator.

IsDesignerPreview

Gets or sets a boolean value that indicates whether the report is opened via designer preview or not. The default is false.

Declaration

public bool IsDesignerPreview { get; set; }

Property Value

Type	Description
System.Boolean	Set the vlue as true to identify report opened through designer preview; otherwide false.

IsDrillthroughReport

Gets or sets a boolean value that indicates whether the report is drillthrough or not. The default is false.

Declaration

public bool IsDrillthroughReport { get; }

Property Value

Type	Description
System.Boolean	It set to true if the report is drillthrough ; otherwise false.

JSONSerializers

Gets or sets the type of serializer to convert the objects into JSON format.

Declaration

public JSONSerializers JSONSerializers { get; set; }

Property Value

Type	Description
JSONSerializers	Contains the type of serializer, default value is JavaScriptSerializer.

LanguagesDateFormat

Load the date format of the particular culture.

Declaration

public Dictionary<string, string> LanguagesDateFormat { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.String>	Contains a collection of date format used in the report.

LocaleSettings

Declaration

public LocaleSettings LocaleSettings { get; set; }

Property Value

Type	Description
LocaleSettings

MaxResponseTimeInterval

Gets or sets the response time in seconds to respond for the client with response time to update the progress.

Declaration

public double MaxResponseTimeInterval { get; set; }

Property Value

Type	Description
System.Double	Time with seconds.

MeasureTextOption

Represents the various modes available to measure text of the report.

Declaration

public MeasureTextOptions MeasureTextOption { get; set; }

Property Value

Type	Description
MeasureTextOptions	Contains the measure text mode of the report.

Parameters

Represents the collections of parameters used in the report.

Declaration

public IEnumerable<ReportParameter> Parameters { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<BoldReports.Web.ReportParameter>	Contains the parameter name,value,label,nullable,prompt.

PDFOptions

Gets or sets the PDF document export behaviors.

Declaration

public PDFOptions PDFOptions { get; set; }

Property Value

Type	Description
PDFOptions	It contains the ImageProcessOption, Fonts, PdfConformanceLevel, PdfSecurity, EnableComplexScript

PerformanceSetting

Represents the collection of the Performance Settings enabled in the report.

Declaration

public PerformanceSetting PerformanceSetting { get; set; }

Property Value

Type	Description
PerformanceSetting	Specifies the collection of performance setting for on demand process.

PPTOptions

Gets or sets the PowerPoint document export behaviors.

Declaration

public PPTOptions PPTOptions { get; set; }

Property Value

Type	Description
PPTOptions	The class containing the PowerPoint FormatType, EncryptionPassword.

ProcessingMode

Gets or sets the modes of the report processing.

Declaration

public ProcessingMode ProcessingMode { get; set; }

Property Value

Type	Description
ProcessingMode	Containing whether the processing mode is remote or local.

ReportDefinition

Gets or sets the ReportDefinition object of a report file.

Declaration

public ReportDefinition ReportDefinition { get; set; }

Property Value

Type	Description
ReportDefinition	The ReportDefinition object contains report information.

ReportingServer

Gets or sets the reporting server details to load report from server.

Declaration

public ReportingServer ReportingServer { get; set; }

Property Value

Type	Description
ReportingServer	The collections of reporting server details.

ReportName

Declaration

public string ReportName { get; set; }

Property Value

Type	Description
System.String

ReportPath

Represents the local file path or report server path of the report.

Declaration

public string ReportPath { get; set; }

Property Value

Type	Description
System.String	A string containing the path to load the report.

ReportServerCredential

Gets or sets the report server credentials to connect the report server.

Declaration

public ICredentials ReportServerCredential { get; set; }

Property Value

Type	Description
System.Net.ICredentials	Provides the base authentication interface for retrieving credentials for Web client authentication.

ReportServerFormsCredential

Gets or sets the Forms credentials to connect with the specified SSRS report server.

Declaration

public ReportServerFormsCredential ReportServerFormsCredential { get; set; }

Property Value

Type	Description
ReportServerFormsCredential	Contains the username, password to connect report server.

ReportServerPreAuthentication

Declaration

public bool ReportServerPreAuthentication { get; set; }

Property Value

Type	Description
System.Boolean

ReportServerUrl

Gets or Sets the url to connect the server to access the report.

Declaration

public string ReportServerUrl { get; set; }

Property Value

Type	Description
System.String	A string containing the url to connect the server.

RoundLayoutMeasures

Gets or sets a boolean value that indicates whether the report layout measurement rounding is applied or not. The default is true.

Declaration

public bool RoundLayoutMeasures { get; set; }

Property Value

Type	Description
System.Boolean	It set to true if report layout measurement rounding is applied ; otherwise false.

Stream

Loads a report definition from the local file system using a Stream.

Declaration

public Stream Stream { get; set; }

Property Value

Type	Description
System.IO.Stream	A Stream Containing the file path to load the report.

UserProfile

Gets or sets the user profile of the user currently accessing the report or component.

Declaration

public UserProfile UserProfile { get; set; }

Property Value

Type	Description
UserProfile	Containing the user details.

WordOptions

Gets or sets the word document export behaviors.

Declaration

public WordOptions WordOptions { get; set; }

Property Value

Type	Description
WordOptions	It contains the FormatType, LayoutOption, ParagraphSpacing, ProtectionType, ProtectionPassword, EncryptionPassword.

Methods

Dispose()

Provides a mechanism for releasing unmanaged resources.

Declaration

public void Dispose()

Remarks

It close or release unmanaged resources such as files, streams, and handles held by an instance of the class that implements this interface.