AbstractReportControl Class

Abstract report control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.Reporting.Web.UI.AbstractReportControl

Namespace: CMS.Reporting.Web.UI
Assembly: CMS.Reporting.Web.UI (in CMS.Reporting.Web.UI.dll) Version: 10.0.0

Syntax

public class AbstractReportControl : InlineUserControl

The AbstractReportControl type exposes the following members.

Constructors

	Name	Description
Public method	AbstractReportControl	Constructor.

Properties

	Name	Description
Public property	AllParameters	All parameters.
Public property	CacheDependencies	CacheDependencies.
Public property	CacheItemName	Name for report caching.
Public property	CacheMinutes	Minutes for cache image holding.
Public property	Colors	Colors assigned to series.
Public property	Columns	Selected columns for reports (replace ##COLUMNS##)
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ComputedWidth	Computex width if percent width is set.
Public property	ConnectionString	Connection string for query. Used in database separation.
Public property	ContextParameters	Context parameters.
Public property	ContextResolver	Web part context resolver.
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	DynamicMacros	Special macros used for report macro resolving
Public property	EmailMode	If true, control is rendered for email.
Public property	EnableExport	If true export is allowed
Public property	EnableSubscription	If true, subscription is enabled
Public property	GraphImageWidth	Width of chart image in percent versus displayable zone.
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IsLiveSite	Indicates whether control is used in live site. (Overrides AbstractUserControl.IsLiveSite.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	ItemType	Item type (graph,table or value).
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	OrderBy	Order by clause for reports (replace ##ORDERBY##)
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	QueryIsStoredProcedure	Query is stored procedure.
Public property	QueryText	Query text.
Public property	RangeInterval	Interval of time range.
Public property	RangeValue	Value of range interval.
Public property	RenderCssClasses	Inidcates if CSS classes should be rendered.
Public property	ReportDataSet	Return loaded dataset
Public property	ReportItemName	Report item name used for caching.
Public property	ReportParameters	Report parameters.
Public property	ReportSubscriptionSiteID	Report's subscription site ID (used in automatic generation
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	SavedReportGuid	Saved report guid.
Public property	SavedReportID	Saved report ID.
Public property	SelectedInterval	Get(set) selected interval of graph type (year,month,..)
Public property	SendOnlyNonEmptyDataSource	If true, only reports with non empty datasource is sent (used in subscriptions).
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	SubscriptionInfo	Report subscription information - used for sending reports by email.
Public property	TableFirstColumnWidth	First width of the column
Public property	TopN	Top N specification for reports (replace where ##TOPN##)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)
Public property	WhereCondition	Where condition for reports (replace ##WHERE##)

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	ApplyTimeParameters	Sets FromDate and ToDate by given values (computed from actual datetime).
Public method	ClearResolver	Clear context resolver.
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Protected method	CheckEmailModeSubscription	Check if subscribed user has valid permission for the subscription and subscription is allowed on all levels (report/report part/control).
Protected method	CheckReportAccess	Checks if current user may see report output based on report access settings.
Protected method	InitParameters	Initializes report control parameters (ReportParameters and AllParameters properties).
Protected method	InitResolver	Initializes macro resolver (data from AllParameters and DynamicMacros properties).
Public method	IsValid	Check if control is part of givven report.
Public method	LoadData	Gets the data from the database.
Public method	LoadDefaultParameters	Loads default parameters from dataset definition.
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Public method	ProcessExport	Export the selected dataset
Public method	RegisterContextMenu	Registers context menu container for control
Public method	RegisterSubscriptionScript	Register JS function for opening subscription dialog.
Public method	ReloadData	Reload data ready to override.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveMacros	Resolves the string macros.
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SetDefaultDynamicMacros(Int32)	Sets the default dynamic macros for general charts (used in reports collecting all intervals in one report (weeks,years,days,...))
Public method	SetDefaultDynamicMacros(String)	Sets the default dynamic macros for general charts (used in reports collecting all intervals in one report (weeks,years,days,...))
Public method	SetDefaultDynamicMacros(HitsIntervalEnum)	Sets the default dynamic macros for general charts (used in reports collecting all intervals in one report (weeks,years,days,...))
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

Extension Methods

	Name	Description
Public Extension Method	CallHandled	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 Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)