Class RTFExport
Represents the RTF export filter.
Implements
Inherited Members
Namespace: FastReport.Export.RichText
Assembly: FastReport.dll
Syntax
public class RTFExport : ExportBase, IDisposable, IFRSerializableConstructors
RTFExport()
Initializes a new instance of the RTFExport class.
Declaration
public RTFExport()Properties
AutoSize
Gets or sets a value that determines whether the rows in the resulting table should calculate its height automatically.
Declaration
public bool AutoSize { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
Default value for this property is false. In this mode, each row in the resulting table has fixed height to get maximum wysiwyg. If you set it to true, the height of resulting table will be calculated automatically by the Word processor. The document will be more editable, but less wysiwyg.
Creator
Gets or sets the creator of the document.
Declaration
public string Creator { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
EmbedRichObject
Gets or sets a value that determines whether the repot's RichObject will be translated as picture or joined to generated RTF.
Declaration
public bool EmbedRichObject { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
Default value for this property is false. In this mode, each RichObject will be embedded as a picture. This is default behavior. If you set it to true, the RichObject will be incorporated as a navive part of document. This is experimetal feature.
ExportLocale
Gets or sets a value indicating that locale export are enabled.
Declaration
public bool ExportLocale { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
ImageFormat
Gets or sets the image format that will be used to save pictures in RTF file.
Declaration
public RTFImageFormat ImageFormat { get; set; }Property Value
| Type | Description |
|---|---|
| RTFImageFormat |
Remarks
Default value is Metafile. This format is better for exporting such objects as MSChartObject and ShapeObject.
JpegQuality
Gets or sets the quality of Jpeg images in RTF file.
Declaration
public int JpegQuality { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Remarks
Default value is 90. This property will be used if you select Jpeg in the ImageFormat property.
Locale
Get or set a locale for all document.
Declaration
public CultureInfo Locale { get; set; }Property Value
| Type | Description |
|---|---|
| System.Globalization.CultureInfo |
PageBreaks
Gets or sets a value indicating that page breaks are enabled.
Declaration
public bool PageBreaks { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Pictures
Gets or sets a value indicating that pictures are enabled.
Declaration
public bool Pictures { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
PrintOptimized
Gets or sets the PrintOptimized.
Declaration
public bool PrintOptimized { 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 rtf 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()