Class DesignerForm
Represents standard designer's form.
Inheritance
Inherited Members
Namespace: FastReport.Design.StandardDesigner
Assembly: FastReport.dll
Syntax
public class DesignerForm : BaseForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IDesignerForm, IDesignerPluginRemarks
This form contains the DesignerControl. Use the Designer property to get access to this control.
Usually you don't need to create an instance of this class. The designer can be called using the FastReport.Report.Design method of the Report instance.
If you decided to use this class, you need:
- create an instance of this class;
- set the Designer.Report property to report that you need to design;
- call either ShowModal or Show methods to display a form.
Constructors
DesignerForm()
Creates a new instance of the DesignerForm class with default settings.
Declaration
public DesignerForm()DesignerForm(Boolean)
Creates a new instance of the DesignerForm class with default settings.
Declaration
public DesignerForm(bool welcome)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | welcome | enables welcome window |
Properties
Designer
Gets a reference to the Designer control which is actually a designer.
Declaration
public Designer Designer { get; }Property Value
| Type | Description |
|---|---|
| Designer |
Items
Gets a list of File menu buttons
Declaration
public Dictionary<string, ButtonItem> Items { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, FastReport.DevComponents.DotNetBar.ButtonItem> |
PluginName
Gets the plugin name.
Declaration
public string PluginName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
Dispose(Boolean)
Clean up any resources being used.
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing | true if managed resources should be disposed; otherwise, false. |
Overrides
GetOptionsPage()
Gets an options page that will be used in the Designer Options dialog to edit the plugin options.
Declaration
public DesignerOptionsPage GetOptionsPage()Returns
| Type | Description |
|---|---|
| DesignerOptionsPage | The options page, if implemented; otherwise, null. |
Localize()
Localizes the dialog controls.
Declaration
public override void Localize()Overrides
Remarks
Use this method to set control's captions specific to the current locale.
Lock()
Locks the plugin.
Declaration
public void Lock()Remarks
This method is called by the designer when report is loading. It may be needed to disable some operations (like painting) that use the report.
RestoreState()
Restores the plugin state.
Declaration
public void RestoreState()SaveState()
Saves the plugin state.
Declaration
public void SaveState()SelectionChanged()
Updates plugin state when current selection was changed.
Declaration
public void SelectionChanged()Remarks
Typically you need to do the same work in the SelectionChanged() and UpdateContent() methods.
Unlock()
Unlocks the plugin.
Declaration
public void Unlock()UpdateContent()
Updates plugin state when the report was modified.
Declaration
public void UpdateContent()Remarks
Typically you need to do the same work in the SelectionChanged() and UpdateContent() methods.
UpdateDpiDependencies()
Update controls on dpi change.
Declaration
public override void UpdateDpiDependencies()Overrides
Remarks
This method is called when the form's dpi is changed. Write custom logic to update some controls (such as ListBox.ItemHeight) here.
UpdateUIStyle()
Updates UI style of the plugin.
Declaration
public void UpdateUIStyle()Remarks
The plugin should update its style according to the designer's UIStyle property.
WndProc(ref Message)
Declaration
protected override void WndProc(ref Message m)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Message | m |