Packagestimulsoft.report.export.settings.htmls
Classpublic class StiHtmlExportSettings
InheritanceStiHtmlExportSettings Inheritance StiPageRangeExportSettings Inheritance StiExportSettings Inheritance Object
Subclasses StiHtml5ExportSettings, StiMhtExportSettings

Class describes settings for export to HTML format.


Public Properties
 PropertyDefined By
  addPageBreaks : Boolean
Gets or sets value which indicates that special page breaks marker will be added to result html file.
StiHtmlExportSettings
  bookmarksTreeWidth : int
Gets or sets defaullt width of bookmarks tree.
StiHtmlExportSettings
  compressToArchive : Boolean
Gets or sets a value indicating whether it is necessary to save output file as zip-file.
StiHtmlExportSettings
  continuousPages : Boolean
Gets or sets value which indicates that all report pages will be shown as vertical ribbon.
StiHtmlExportSettings
  encoding : String
Gets or sets encoding of html file.
StiHtmlExportSettings
  exportBookmarksMode : int
Gets or sets export mode of bookmarks tree.
StiHtmlExportSettings
  exportFormat : int
[override] [read-only]
StiHtmlExportSettings
  exportMode : int
Gets or sets mode of html file creation.
StiHtmlExportSettings
  exportQuality : int
Gets or sets quality of html file.
StiHtmlExportSettings
  htmlType : int
Gets or sets type of the exported html file.
StiHtmlExportSettings
  imageFormat : int
Gets or sets image format for exported images.
StiHtmlExportSettings
  imageQuality : Number
Gets or sets image quality of images which will be exported to result file.
StiHtmlExportSettings
  imageResolution : Number
Gets or sets image resolution of images which will be exported to result file.
StiHtmlExportSettings
  pageHorAlignment : int
Gets or sets the horizontal alignment of pages.
StiHtmlExportSettings
 InheritedpageRange : StiPagesRange
StiPageRangeExportSettings
  removeEmptySpaceAtBottom : Boolean
Gets or sets a value indicating whether it is necessary to remove empty space at the bottom of the page.
StiHtmlExportSettings
  useEmbeddedImages : Boolean
Gets or sets a value indicating whether it is necessary to save images as embedded data in html file.
StiHtmlExportSettings
  useStylesTable : Boolean
Gets or sets value which indicates that table styles will be used in result html file.
StiHtmlExportSettings
  zoom : Number
Gets or sets zoom factor of exported file.
StiHtmlExportSettings
Public Methods
 MethodDefined By
  
StiHtmlExportSettings(htmlType:int = 0)
StiHtmlExportSettings
  
toXMLString():String
[override]
StiHtmlExportSettings
Property Detail
addPageBreaksproperty
addPageBreaks:Boolean

Gets or sets value which indicates that special page breaks marker will be added to result html file. HTML5 export mode is not supported.


Implementation
    public function get addPageBreaks():Boolean
    public function set addPageBreaks(value:Boolean):void
bookmarksTreeWidthproperty 
bookmarksTreeWidth:int

Gets or sets defaullt width of bookmarks tree. HTML5 export mode is not supported.


Implementation
    public function get bookmarksTreeWidth():int
    public function set bookmarksTreeWidth(value:int):void
compressToArchiveproperty 
compressToArchive:Boolean

Gets or sets a value indicating whether it is necessary to save output file as zip-file. HTML5 and MHT export mode is not supported.


Implementation
    public function get compressToArchive():Boolean
    public function set compressToArchive(value:Boolean):void
continuousPagesproperty 
continuousPages:Boolean

Gets or sets value which indicates that all report pages will be shown as vertical ribbon. HTML and MHT export mode is not supported.


Implementation
    public function get continuousPages():Boolean
    public function set continuousPages(value:Boolean):void
encodingproperty 
encoding:String

Gets or sets encoding of html file.


Implementation
    public function get encoding():String
    public function set encoding(value:String):void
exportBookmarksModeproperty 
exportBookmarksMode:int

Gets or sets export mode of bookmarks tree. HTML5 export mode is not supported.


Implementation
    public function get exportBookmarksMode():int
    public function set exportBookmarksMode(value:int):void
exportFormatproperty 
exportFormat:int  [read-only] [override]


Implementation
    public function get exportFormat():int
exportModeproperty 
exportMode:int

Gets or sets mode of html file creation. HTML5 export mode is not supported.


Implementation
    public function get exportMode():int
    public function set exportMode(value:int):void
exportQualityproperty 
exportQuality:int

Gets or sets quality of html file. HTML5 export mode is not supported.


Implementation
    public function get exportQuality():int
    public function set exportQuality(value:int):void
htmlTypeproperty 
htmlType:int

Gets or sets type of the exported html file.


Implementation
    public function get htmlType():int
    public function set htmlType(value:int):void
imageFormatproperty 
imageFormat:int

Gets or sets image format for exported images.


Implementation
    public function get imageFormat():int
    public function set imageFormat(value:int):void
imageQualityproperty 
imageQuality:Number

Gets or sets image quality of images which will be exported to result file.


Implementation
    public function get imageQuality():Number
    public function set imageQuality(value:Number):void
imageResolutionproperty 
imageResolution:Number

Gets or sets image resolution of images which will be exported to result file.


Implementation
    public function get imageResolution():Number
    public function set imageResolution(value:Number):void
pageHorAlignmentproperty 
pageHorAlignment:int

Gets or sets the horizontal alignment of pages. HTML5 and MHT export mode is not supported.


Implementation
    public function get pageHorAlignment():int
    public function set pageHorAlignment(value:int):void
removeEmptySpaceAtBottomproperty 
removeEmptySpaceAtBottom:Boolean

Gets or sets a value indicating whether it is necessary to remove empty space at the bottom of the page. HTML5 and MHT export mode is not supported.


Implementation
    public function get removeEmptySpaceAtBottom():Boolean
    public function set removeEmptySpaceAtBottom(value:Boolean):void
useEmbeddedImagesproperty 
useEmbeddedImages:Boolean

Gets or sets a value indicating whether it is necessary to save images as embedded data in html file. HTML5 and MHT export mode is not supported.


Implementation
    public function get useEmbeddedImages():Boolean
    public function set useEmbeddedImages(value:Boolean):void
useStylesTableproperty 
useStylesTable:Boolean

Gets or sets value which indicates that table styles will be used in result html file. HTML5 and MHT export mode is not supported.


Implementation
    public function get useStylesTable():Boolean
    public function set useStylesTable(value:Boolean):void
zoomproperty 
zoom:Number

Gets or sets zoom factor of exported file. HTML5 export mode is not supported.


Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
Constructor Detail
StiHtmlExportSettings()Constructor
public function StiHtmlExportSettings(htmlType:int = 0)



Parameters
htmlType:int (default = 0)
Method Detail
toXMLString()method
override public function toXMLString():String

Returns
String




Mon Mar 27 2017, 09:08 AM +03:00