Click or drag to resize
AbstractReportControl Class
Abstract report control.
Inheritance Hierarchy

Namespace: CMS.Reporting
Assembly: CMS.Reporting (in CMS.Reporting.dll) Version: 9.0.0
Syntax
C#
public class AbstractReportControl : InlineUserControl

The AbstractReportControl type exposes the following members.

Constructors
  NameDescription
Public methodAbstractReportControl
Constructor.
Top
Fields
  NameDescription
Protected fieldmViewStateTracked
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.)
Top
Properties
  NameDescription
Public propertyAllParameters
All parameters.
Public propertyCacheDependencies
CacheDependencies.
Public propertyCacheItemName
Name for report caching.
Public propertyCacheMinutes
Minutes for cache image holding.
Public propertyColors
Colors assigned to series.
Public propertyColumns
Selected columns for reports (replace ##COLUMNS##)
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyComputedWidth
Computex width if percent width is set.
Public propertyConnectionString
Connection string for query. Used in database separation.
Public propertyContextParameters
Context parameters.
Public propertyContextResolver
Web part context resolver.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyDynamicMacros
Special macros used for report macro resolving
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyEmailMode
If true, control is rendered for email.
Public propertyEnableExport
If true export is allowed
Public propertyEnableSubscription
If true, subscription is enabled
Public propertyGraphImageWidth
Width of chart image in percent versus displayable zone.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIsLiveSite
Indicates whether control is used in live site.
(Overrides AbstractUserControlIsLiveSite.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyItemType
Item type (graph,table or value).
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyOrderBy
Order by clause for reports (replace ##ORDERBY##)
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyQueryIsStoredProcedure
Query is stored procedure.
Public propertyQueryText
Query text.
Public propertyRangeInterval
Interval of time range.
Public propertyRangeValue
Value of range interval.
Public propertyRenderCssClasses
Inidcates if CSS classes should be rendered.
Public propertyReportDataSet
Return loaded dataset
Public propertyReportItemName
Report item name used for caching.
Public propertyReportParameters
Report parameters.
Public propertyReportSubscriptionSiteID
Report's subscription site ID (used in automatic generation
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertySavedReportGuid
Saved report guid.
Public propertySavedReportID
Saved report ID.
Public propertySelectedInterval
Get(set) selected interval of graph type (year,month,..)
Public propertySendOnlyNonEmptyDataSource
If true, only reports with non empty datasource is sent (used in subscriptions).
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertySubscriptionInfo
Report subscription information - used for sending reports by email.
Public propertyTableFirstColumnWidth
First width of the column
Public propertyTopN
Top N specification for reports (replace where ##TOPN##)
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWhereCondition
Where condition for reports (replace ##WHERE##)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodApplyTimeParameters
Sets FromDate and ToDate by given values (computed from actual datetime).
Public methodClearResolver
Clear context resolver.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Protected methodCheckEmailModeSubscription
Check if subscribed user has valid permission for the subscription and subscription is allowed on all levels (report/report part/control).
Protected methodCheckReportAccess
Checks if current user may see report output based on report access settings.
Protected methodInitParameters
Initializes report control parameters (ReportParameters and AllParameters properties).
Protected methodInitResolver
Initializes macro resolver (data from AllParameters and DynamicMacros properties).
Public methodIsValid
Check if control is part of givven report.
Public methodLoadData
Gets the data from the database.
Public methodLoadDefaultParameters
Loads default parameters from dataset definition.
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodProcessExport
Export the selected dataset
Public methodRegisterContextMenu
Registers context menu container for control
Public methodRegisterSubscriptionScript
Register JS function for opening subscription dialog.
Public methodReloadData
Reload data ready to override.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveMacros
Resolves the string macros.
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetDefaultDynamicMacros(Int32)
Sets the default dynamic macros for general charts (used in reports collecting all intervals in one report (weeks,years,days,...))
Public methodSetDefaultDynamicMacros(String)
Sets the default dynamic macros for general charts (used in reports collecting all intervals in one report (weeks,years,days,...))
Public methodSetDefaultDynamicMacros(HitsIntervalEnum)
Sets the default dynamic macros for general charts (used in reports collecting all intervals in one report (weeks,years,days,...))
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also