Class DesignerOptionsPage

The base class for designer plugin's options page.

Inheritance
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Windows.Forms.Control
System.Windows.Forms.ScrollableControl
System.Windows.Forms.ContainerControl
System.Windows.Forms.Form
DesignerOptionsPage
Namespace: FastReport.Forms
Assembly: FastReport.dll
Syntax
public class DesignerOptionsPage : Form, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl
Remarks

Use this class if you develop a designer plugin that may be configured in the "View|Options..." menu. You need to implement an options page for your plugin and return it in the IDesignerPlugin.GetOptionsPage method.

Constructors

DesignerOptionsPage()

Initializes a new instance of the DesignerOptionsPage class with default settings.

Declaration
public DesignerOptionsPage()
Remarks

Usually you need to define another contructor which takes one parameter - the plugin.

Examples

This example shows how to define own constructor which takes a plugin:

public DialogPageOptions(DialogPageDesigner pd) : base()
{
  FPageDesigner = pd;
  InitializeComponent();
}

Fields

tab1

The TabPage control.

Declaration
public TabPage tab1
Field Value
Type Description
System.Windows.Forms.TabPage

tc1

The TabControl control.

Declaration
public TabControl tc1
Field Value
Type Description
System.Windows.Forms.TabControl

Properties

RestartRequired

Gets or sets a value indicating that restart is required.

Declaration
public bool RestartRequired { get; set; }
Property Value
Type Description
System.Boolean

Methods

Done(DialogResult)

Finalizes the options page.

Declaration
public virtual void Done(DialogResult result)
Parameters
Type Name Description
System.Windows.Forms.DialogResult result

The dialog result.
Remarks

Override this method to pass controls' values to the plugin. Do this if result is DialogResult.OK.

Init()

Initializes controls on this options page.

Declaration
public virtual void Init()
Remarks

Override this method to fill options page's controls with initial values.

UpdateDpiDependencies()

Updates images used in the control.

Declaration
public virtual void UpdateDpiDependencies()

Events

RestartRequiredChanged

Event is fired whenever the RestartRequired property is changed.

Declaration
public event EventHandler RestartRequiredChanged
Event Type
Type Description
System.EventHandler

Extension Methods