Click or drag to resize

ReportView Class

A ReportView defines how a ReportModel is rendered.
Inheritance Hierarchy
SystemObject
  Seal.ModelRootEditor
    Seal.ModelRootComponent
      Seal.ModelReportComponent
        Seal.ModelReportView

Namespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 8.0.0.0+c5a14bc14715399f60fcf611201a5e8ad953fbc3
Syntax
C#
Copy
public class ReportView : ReportComponent

The ReportView type exposes the following members.

Constructors
 NameDescription
Public methodReportViewInitializes a new instance of the ReportView class
Top
Properties
 NameDescription
Public propertyCSVRenderer Current CSV renderer
Public propertyCultureInfo Current CultureInfo
Public propertyCultureName The language and culture used to display the report. If empty, the default culture is used.
Public propertyCustomTemplate The custom template text used instead of the template defined by the template name
Public propertyEnabled If false, the view is not parsed
Public propertyError Last error message
Public propertyExcelConfigurations The Excel configuration of the view
Public propertyExcelConverter Current Excel converter
Public propertyExcelConverterEdited True if the Excel converter was edited
Public propertyExcelRenderer Current Excel renderer
Public propertyExecutionPromptedRestrictions List of restrictions prompted to display in the view
Public propertyGUID The unique identifier
(Inherited from RootComponent)
Public propertyHelperReloadConfiguration Editor Helper: Load the template configuration file
Public propertyHelperResetParameters Editor Helper: Reset all template parameters to their default values
Public propertyHTML2PDFRenderer Current HTML2PDF renderer
Public propertyIdSuffix Unique identifier for execution used to build JS identifier (e.g. for datatables)
Public propertyInformation Last information message
Public propertyIsDrillEnabled True if the drill navigation is enabled
Public propertyIsRootView True if the view is the root view (no parent)
Public propertyIsServerPaginationEnabled True if the server pagination for DataTables is enabled for this view
Public propertyIsSubReportsEnabled True if the sub-reports navigation is enabled
Public propertyJsonRenderer Current Json renderer
Public propertyMenuName If not empty, overrides the default name of the report view in the Web Menu. Sub-menus can be specified using the '/' character (e.g. 'Samples/Orders').
Public propertyMenuPath Path of the view in the menu
Public propertyMenuReportViewName Name of the report in the menu
Public propertyModel Current report model if any
Public propertyModelGUID The data model identifier used for the view
Public propertyModelView Returns the first ancestor view having a model
Public propertyName The name
(Overrides RootComponentName)
Public propertyParameters The view parameters
Public propertyParentView Current parent view if any
Public propertyPartialTemplates The custom partial template list for the view
Public propertyPdfConfigurations The PDF configuration of the view
Public propertyPdfConverter 
Public propertyPdfConverterEdited True if the PDF Converter was edited
Public propertyPDFRenderer Current PDF renderer
Public propertyReferenceView Current reference view if any
Public propertyReferenceViewGUID If set, the values of the properties of the view may be taken from the reference view. This applies to parameters having their default value (including Excel and PDF configuration) and custom template texts with 'Use custom template text' set to 'false'.
Public propertyRenderer Returns the current renderer
Public propertyReport The current report
(Inherited from ReportComponent)
Public propertyReportViewTemplateChildren Returns the view templates that can be child of the view
Public propertyRestrictions 
Public propertyRestrictionsGUID List of Restrictions GUID to display for a Restrictions view.
Public propertyRestrictionsToSelect Helper to select Join Preferences
Public propertyRootView Helper to get the root view of the view
Public propertyShowInMenu If true, the report view is shown and can be executed from the menu of the Web Report Server.
Public propertySortOrder Sort order of the view
Public propertySortOrderFull Sort order with the view name
Public propertyTemplate Current ReportViewTemplate
Public propertyTemplateDescription The description of the template
Public propertyTemplateName The name of the view template. View templates are defined in the repository Views folder.
Public propertyTextRenderer Current Text renderer
Public propertyUseCustomTemplate If true, the template text can be modified
Public propertyUseModelName If true, the view name is got from the model name. This is only valid for a Model View.
Public propertyViewId Identifier of the view
Public propertyViewName View name translated
Public propertyViewTemplateText Current template text of the view
Public propertyWebExec For the Web Report Server: If true, the view can be executed from the report list.
Public propertyXMLRenderer Current XML renderer
Top
Methods
 NameDescription
Public methodAddAttribute Helper to create an HTTP attribute from a parameter value
Public methodAddDefaultModelViews Add the default children for a model
Public methodAfterSerialization Operations performed after the serialization
Public methodBeforeSerialization Operations performed before the serialization
Public methodConvertToExcel Convert the view to an Excel Sheet
Public methodStatic memberCreate Creates a basic view
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFindViewFromTemplate Helper to find a child view from its template name
Public methodGetBoolValue(String) Returns a parameter boolean value
Public methodGetBoolValue(String, Boolean) Returns a parameter boolean value with a default if it does not exist
Public methodGetBoolValueJS Returns a parameter boolean value for JavaScript
Public methodGetCSSLayoutRows Helper to return a list of CSS layout rows from the flex layout
Public methodGetDoubleValue Returns a parameter double value
Public methodGetGridLayoutColumnClass Returns the class of a layout column
Public methodGetGridLayoutColumns Helper to return a list of layout columns from a layout row
Public methodGetGridLayoutRows Helper to return a list of layout rows from the grid layout
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetHtmlValue Returns a parameter value with HTML encoding
Public methodGetNumericValue Returns a parameter integer value
Public methodGetParameter Returns a Parameter
Public methodGetPartialTemplateKey Returns a partial template key form a given name and model
Public methodGetSort Current sort order of the view
Public methodGetTranslatedMappedLabel Translates a mapped label having keywords %DisplayName%
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetValue Returns the parameter value
Public methodGetValueIfNotEmpty Returns the parameter value if not empty with a prefix and a suffix
Public methodGetValueOrDefault Returns the parameter value or the configuration value if it does not exist
Public methodGetView Returns a view from its identifier
Public methodHasValue True, if the parameter has a value
Public methodInit Init the editor objects
(Inherited from RootEditor)
Public methodInitDefaultValues Init the default values
(Inherited from RootEditor)
Public methodInitEditor Init the editor objects and the default values
(Inherited from RootEditor)
Public methodInitFromReferenceView Initializes the view properties from its reference view
Public methodInitPageChart Init the chart for a ResultPage
Public methodInitParameters Init all parameters with an option to reset their values
Public methodInitPartialTemplates Init the partial templates of the view
Public methodInitReferences Init all references
Public methodInitTemplates Initializes the view templates and parameters
Public methodIsAncestorOf True if the view is an ancestor of a given view
Public methodIsColumnHidden True if the column is hidden
Public methodIsGridLayoutColumnForModel True if the layout column is for a model
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParse Parse the view and returns the result
Public methodParseChildren Parse all children and returns the result
Public methodReinitGUIDChildren Reset children identifiers
Public methodReloadConfiguration Forces the reload of the configuration
Public methodReplaceInParameterValues Replace a pattern by a text in the parameter values
Public methodSetAdvancedConfigurations Set configurations for Excel or PDF converter
Public methodSetParameter(String, Boolean) Set a parameter boolean value
Public methodSetParameter(String, String) Set a parameter value
Public methodSetReadOnly Set all properties to readonly
(Inherited from RootEditor)
Public methodShouldSerializeCSVRenderer 
Public methodShouldSerializeCustomTemplate 
Public methodShouldSerializeEnabled 
Public methodShouldSerializeExcelRenderer 
Public methodShouldSerializeHTML2PDFRenderer 
Public methodShouldSerializeJsonRenderer 
Public methodShouldSerializePDFRenderer 
Public methodShouldSerializeRestrictionsGUID 
Public methodShouldSerializeShowInMenu 
Public methodShouldSerializeTextRenderer 
Public methodShouldSerializeUseModelName 
Public methodShouldSerializeXMLRenderer 
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUpdateEditor Update editor attributes
(Inherited from RootEditor)
Protected methodUpdateEditorAttributes Refresh properties attrivutes
(Inherited from RootEditor)
Top
Fields
 NameDescription
Protected field_dctd
(Inherited from RootEditor)
Protected field_GUID
(Inherited from RootComponent)
Protected field_name
(Inherited from RootComponent)
Protected field_report
(Inherited from ReportComponent)
Public fieldTag Object that can be used at run-time for any purpose
Public fieldViews Children of the view
Top
See Also