GrapeCity.ActiveReports.Design.Designer

Designer Class

Serves as the central designer component for creating and editing reports, including both Section and Page within the ActiveReports designer environment.

Inheritance

Designer

Implements

Namespace: GrapeCity.ActiveReports.Design

Assembly: MESCIUS.ActiveReports.Design.Win.dll

Syntax

[ToolboxBitmap(typeof(CommonResources), "CommonResources.Designer.bmp")]
public class Designer : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IUIService

Remarks

<p>

The Designer class is a key component of the ActiveReports design-time environment, facilitating the creation, editing, and previewing of report designs.

This class represents the windows forms component that could be used to integrate the report editing capabilities into a Windows forms application.

Constructors

Name	Description
Designer()	Initializes a new instance of the Designer class without specifying a package service.

Properties

Name	Description
ActiveTab	Gets a value representing the currently selected tab in the designer interface.
DesignerHost
DesignerUnits	Gets or sets a value indicating the measurement units used within the designer environment.
DrawGrid	Gets or sets a value indicating whether a grid is displayed in the designer workspace.
EnableOleObject	Gets or sets a value indicating whether OLE (Object Linking and Embedding) object support is enabled in the designer.
EnablePreview	Gets or sets a value indicating whether the 'Preview' tab is visible on the design surface tool panel.
EnableScripting	Gets or sets a value indicating whether the 'Script' tab is visible on the design surface tool panel.
FontResolver	Gets or sets a value representing the font resolver used by the designer to resolve fonts in reports.
GridMode	Gets or sets a value representing the mode in which the grid is displayed in the designer workspace.
GridX	Gets or sets a value representing the horizontal spacing between grid lines in the designer.
GridY	Gets or sets a value representing the vertical spacing between grid lines in the designer.
IsDirty	Gets or sets a value representing the dirty flag of the report. Note: the setter is for internal purposes only and does not manage conversion scenarios.
LaunchDataSourceWizard	Gets or sets a value indicating whether the Data Source Dialog should be launched automatically. This property is obsolete and should not be used in new development.
LayoutMode	Gets or sets a value representing the layout mode for the design surface, determining how controls are aligned and interact with the grid.
LockControls	Gets or sets a value indicating whether the controls within the designer are locked, preventing modifications.
PageReportDesignerActions	Gets or sets a value representing the allowed actions in PageReport Designer.
PreviewPages	Gets or sets a value representing the number of pages of the report that should be generated for preview.
PromptUser	Gets or sets a value indicating whether to display a confirmation dialog when a control is deleted.
PropertyGrid	Gets or sets a value representing the PropertyGrid instance used by the designer to display and edit the properties of the currently selected report item.
Report	Gets or sets a value representing the currently loaded report. This object provides access to the report's layout and control properties.
ReportPartsDirectory	Gets or sets a value representing the directory path where report parts are stored for use in the report items library.
ReportTabsPanelVisible	Gets or sets a value indicating whether the panel containing the tabs for switching between Design, Script, and Preview modes is visible.
ReportTabsVisible	Gets or sets a value indicating whether the tabs for switching between Design, Script, and Preview modes are displayed in the report designer interface.
ReportType	Gets a value indicating the type of the currently loaded report.
ResourceLocator	Gets or sets a value representing the mechanism for locating and retrieving report resources such as images, data sources, and subreports.
ScrollingMode	Gets or sets a value representing the scrolling mode for the designer view.
Selection	Gets a value representing the collection of objects currently selected in the designer.
ShowDataSourceIcon	Gets or sets a value indicating whether the DataSource icon is visible on the detail section bar. This icon allows users to modify the report's data source settings.
SnapGrid	Gets or sets a value indicating whether controls on the design surface should align to the nearest grid point.
ToolBoxItem	Gets or sets a value representing the toolbox item associated with the SectionReport in the designer.
ToolPanel	Gets or sets a value representing the tools that are available in the designer's tool panel.
Toolbox	Gets or sets a value representing the IToolboxService implementation for the report designer.
UndoManager	Gets a value representing the UndoManager instance that manages undo and redo operations within the designer.
Zoom	Gets or sets a value representing the zoom level for the designer surface.

Methods

Name	Description
CreateToolStrips(params DesignerToolStrips[])	Generates an array of ToolStrip objects for use in the End User Designer interface.
DestroyComponent(IComponent)	Removes a component from the designer's site. It is essential to call this method after a Section, Parameter, Control, or Field is removed from its collection to ensure proper removal of its design-time component.
ExecuteAction(DesignerAction)	Executes the specified DesignerAction command within the designer environment.
ExecuteAction(DesignerAction, object)	Executes the specified DesignerAction command with an optional parameter. This method can be utilized when implementing custom toolbars or menus within the designer environment. It enables the execution of report actions in response to user interactions with toolbar or menu items.
LoadReport(FileInfo)	Loads an existing report from the specified file into the designer.
LoadReport(Stream)	Loads an existing report from a stream into the designer. This method is obsolete.
LoadReport(XmlReader, DesignerReportType)	Loads an existing report of the specified type from the provided System.Xml.XmlReader into the designer.
LoadReport(XmlReader, DesignerReportType, string)	Loads an existing report of the specified type and name from the provided System.Xml.XmlReader into the designer.
NewReport()	Initializes the designer with a new report layout of the default type, which is Section. This method serves as a convenience wrapper for creating a new Section report.
NewReport(DesignerReportType)	Initializes the designer with a new report layout of the specified type. This method simplifies the process of creating a new report by allowing the caller to specify the type of report they wish to create, such as Section or Page.
NewReport(DesignerReportType, bool)	Initializes the designer with a new report layout of the specified type and, if requested, launches the Data Source Dialog. This method facilitates the creation of a new report by allowing the specification of the report type (e.g., Section, Page) and provides an option to immediately launch the Data Source Dialog, which assists in setting up data connections and queries for the report.
OnHandleCreated(EventArgs)
OnLayout(LayoutEventArgs)	Handles the Layout event.
PointToSection(object, Point)	Translates a point from designer coordinates to coordinates relative to a specified section.
QueryActionChecked(DesignerAction)	Determines whether a specific designer action is currently in the checked (selected) state.
QueryActionEnabled(DesignerAction)	Checks whether a specific designer action is currently enabled.
RunDataWizard()	Opens the Data Source Dialog automatically when creating a new report.
SaveReport(FileInfo)	Saves a report XML layout to the specified file.
SaveReport(Stream)	Saves a report XML layout to the specified stream.
SaveReport(XmlWriter)	Saves a report XML layout to the specified writer.
ScaleSizeToDpi(Size)	Scales a Size from the default DPI (dots per inch) settings to the DPI settings of the current device.
SectionAt(Point)	Retrieves the section located at the specified point within the designer surface.

Events

Name	Description
ActiveTabChanged	Occurs when the currently ActiveTab in the designer interface changes.
ChartDataSourceClicked	Occurs when a data source item within a chart is selected by the user.
ContextMenuOpen	Occurs immediately before the context menu is displayed in the designer.
DataSourceIconClick	Occurs when the user clicks on the DataSource icon within the designer environment.
DataSourceIconClicked	Occurs after the DataSource dialog has been closed by the user.
DesignerTabChanged	Occurs after the designer tab has been changed by the user.
EditModeEntering	Occurs just before the designer enters edit mode for a report component.
EditModeExit	Occurs immediately after the designer exits edit mode for a report component.
LayoutChanged	Occurs after the report layout has been modified. This event signifies a permanent change in the layout.
LayoutChanging	Occurs before a change in the layout is made. This event allows interception and prevention of layout modifications.
LocateCredentials	Occurs when credentials are needed to access a data source. This event facilitates secure credential provision.
LocateDataSource	Occurs when a data source is needed for the report. This event enables dynamic data source resolution.
ReportChanged	Occurs when any modification is made to the report, such as changes to the design, data sources, or properties.
ReportNameChanged	Occurs when the name of the report changes. This event can be used to respond to changes in the report's name, such as updating UI elements or performing additional logic.
ScriptChanged	Occurs after modifications have been made to the report's script.
SelectionChanged	Occurs when the selection within the designer changes, such as when a different report component is selected by the user.
StatusChanged	Occurs when there is a need to update toolbars or other UI elements related to Section reports, due to changes in the report's state or selection.
ToolboxItemChanged	Occurs when the ToolboxItem property changes, indicating a modification to the toolbox item selection or properties.