Class XMLExport
Represents the Excel 2003 XML export filter.
Implements
Inherited Members
Namespace: FastReport.Export.Xml
Assembly: FastReport.dll
Syntax
public class XMLExport : ExportBase, IDisposable, IFRSerializableConstructors
XMLExport()
Initializes a new instance of the XMLExport class.
Declaration
public XMLExport()Properties
Creator
Gets or sets the name of document creator.
Declaration
public string Creator { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
DataOnly
Gets or sets a value that determines whether to export the databand rows only.
Declaration
public bool DataOnly { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
PageBreaks
Gets or sets a value that determines whether to insert page breaks in the output file or not.
Declaration
public bool PageBreaks { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
SplitPages
Each report page is placed on a new Excel page.
Declaration
public bool SplitPages { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Wysiwyg
Gets or sets a value that determines whether the wysiwyg mode should be used for better results.
Declaration
public bool Wysiwyg { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
Default value is true. In wysiwyg mode, the resulting Excel file will look as close as possible to the prepared report. On the other side, it may have a lot of small rows/columns, which will make it less editable. If you set this property to false, the number of rows/columns in the resulting file will be decreased. You will get less wysiwyg, but more editable file.
Methods
ExportBand(BandBase)
This method is called for each band on exported page.
Declaration
protected override void ExportBand(BandBase band)Parameters
| Type | Name | Description |
|---|---|---|
| BandBase | band | Band, dispose after method compite. |
Overrides
ExportPageBegin(ReportPage)
This method is called at the start of exports of each page.
Declaration
protected override void ExportPageBegin(ReportPage page)Parameters
| Type | Name | Description |
|---|---|---|
| ReportPage | page | Page for export may be empty in this method. |
Overrides
ExportPageEnd(ReportPage)
This method is called at the end of exports of each page.
Declaration
protected override void ExportPageEnd(ReportPage page)Parameters
| Type | Name | Description |
|---|---|---|
| ReportPage | page | Page for export may be empty in this method. |
Overrides
Finish()
This method is called when the export is finished.
Declaration
protected override void Finish()Overrides
GetFileFilter()
Returns a file filter for a save dialog.
Declaration
protected override string GetFileFilter()Returns
| Type | Description |
|---|---|
| System.String | String that contains a file filter, for example: "Bitmap image (.bmp)|.bmp" |
Overrides
Serialize(FRWriter)
Serializes the object.
Declaration
public override void Serialize(FRWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| FRWriter | writer | Writer object. |
Overrides
Remarks
Do not call this method directly. You should override it if you are developing a new component for FastReport.
This method is called when the object needs to save the state. It may happen when:
- saving the report to the file or stream;
- saving the report to the designer's undo buffer;
- assigning the object to another object using the Assign(Base) or AssignAll methods;
- saving the object to the designer's clipboard;
- saving the object to the preview (when run a report).
ShowDialog()
Displays a dialog with export options.
Declaration
public override bool ShowDialog()Returns
| Type | Description |
|---|---|
| System.Boolean | true if dialog was closed with OK button. |
Overrides
Remarks
Before calling this method, set the report.
Start()
This method is called when the export starts.
Declaration
protected override void Start()