Class ImportPlugin
Base class for all import plugins.
Inheritance
Implements
Namespace: FastReport.Design
Assembly: FastReport.dll
Syntax
public class ImportPlugin : IDesignerPluginConstructors
ImportPlugin()
Initializes a new instance of the ImportPlugin class with default settings.
Declaration
public ImportPlugin()ImportPlugin(Designer)
Initializes a new instance of the ImportPlugin class with a specified designer.
Declaration
public ImportPlugin(Designer designer)Parameters
| Type | Name | Description |
|---|---|---|
| Designer | designer | The report designer. |
Properties
Designer
Gets or sets reference to the designer.
Declaration
public Designer Designer { get; protected set; }Property Value
| Type | Description |
|---|---|
| Designer |
Filter
Gets or sets the filter string used in the "Open File" dialog.
Declaration
public string Filter { get; protected set; }Property Value
| Type | Description |
|---|---|
| System.String |
Import
Gets or sets reference to the import.
Declaration
protected ImportBase Import { get; set; }Property Value
| Type | Description |
|---|---|
| ImportBase |
Name
Gets or sets the name of plugin.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
PluginName
Gets the plugin name.
Declaration
public string PluginName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Report
Gets or sets reference to the report.
Declaration
public Report Report { get; protected set; }Property Value
| Type | Description |
|---|---|
| Report |
Methods
GetFilter()
Returns a file filter for a open dialog.
Declaration
protected virtual string GetFilter()Returns
| Type | Description |
|---|---|
| System.String | String that contains a file filter, for example: "Bitmap image (.bmp)|.bmp" |
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. |
LoadReport(Report, Stream)
Loads the specified file into specified report from stream.
Declaration
public virtual void LoadReport(Report report, Stream file)Parameters
| Type | Name | Description |
|---|---|---|
| Report | report | Report object. |
| System.IO.Stream | file | File stream. |
LoadReport(Report, String)
Loads the specified file into specified report.
Declaration
public virtual void LoadReport(Report report, string filename)Parameters
| Type | Name | Description |
|---|---|---|
| Report | report | Report object. |
| System.String | filename | File name. |
Localize()
Localizes the plugin.
Declaration
public virtual void Localize()Remarks
This method is called by the designer when current localization is changed.
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()
Updates layout on dpi change.
Declaration
public void UpdateDpiDependencies()UpdateUIStyle()
Updates UI style of the plugin.
Declaration
public virtual void UpdateUIStyle()Remarks
The plugin should update its style according to the designer's UIStyle property.