com.aspose.diagram

Class HTMLSaveOptions

public class HTMLSaveOptions 
extends RenderingSaveOptions

Allows to specify additional options when rendering diagram pages to HTML.

Constructor Summary
HTMLSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
 
Property Getters/Setters Summary
java.awt.geom.Rectangle2D.FloatgetArea()
Gets or sets the area of the shapes will be saved .
java.lang.StringgetDefaultFont()
void
setDefaultFont(java.lang.Stringvalue)
           When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. Set the DefaultFont such as MingLiu or MS Gothic to show these characters.
intgetEmfRenderSetting()
void
           Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
booleangetEnlargePage()
void
setEnlargePage(booleanvalue)
           Specifies whether enlarge page .
booleangetExportGuideShapes()
void
setExportGuideShapes(booleanvalue)
           Defines whether need exporting the guide shapes or not.
booleangetExportHiddenPage()
void
setExportHiddenPage(booleanvalue)
           Defines whether need exporting the hidden page or not.
booleanisExportComments()
void
setExportComments(booleanvalue)
           Defines whether need exporting the comments or not.
intgetPageCount()
void
setPageCount(intvalue)
           Gets or sets the number of pages to render in HTML. Default is MaxValue which means all pages of the diagram will be rendered.
intgetPageIndex()
void
setPageIndex(intvalue)
           Gets or sets the 0-based index of the first page to render. Default is 0.
PageSizegetPageSize()
void
           Gets or sets the page size for the generated images. Can be PageSize or null.
intgetResolution()
void
setResolution(intvalue)
           Gets or sets the resolution for the generated html, in dots per inch.
booleangetSaveAsSingleFile()
void
setSaveAsSingleFile(booleanvalue)
           Indicates whether save the html as single file. The default value is false.
booleangetSaveForegroundPagesOnly()
void
           Specifies whether all pages will be saved in image or only foreground.
intgetSaveFormat()
void
setSaveFormat(intvalue)
           Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat only. The value of the property is SaveFileFormat integer constant.
booleangetSaveTitle()
void
setSaveTitle(booleanvalue)
           Defines whether need exporting the title or not.
booleangetSaveToolBar()
void
setSaveToolBar(booleanvalue)
           Specifies whether saving toolbar The default value is true.
ShapeCollectiongetShapes()
void
           Gets or sets shapes to render. Default count is 0.
IStreamProvidergetStreamProvider()
void
           Gets or sets the IStreamProvider for exporting objects.
java.lang.StringgetTitle()
void
setTitle(java.lang.Stringvalue)
           Gets or sets the title of diagram to render in HTML. If Title is null Diagram.DocumentProperties.Title DocumentProperties will be used as Title. If Diagram.DocumentProperties.Title is null or empty the file name of Diagram will be used as Title.
IWarningCallbackgetWarningCallback()
void
           Gets or sets warning callback.
 

    • Constructor Detail

      • HTMLSaveOptions

        public HTMLSaveOptions()
                        throws java.lang.Exception
        Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
    • Property Getters/Setters Detail

      • getTitle/setTitle

        public java.lang.String getTitle() / public void setTitle(java.lang.String value)
        
        Gets or sets the title of diagram to render in HTML. If Title is null Diagram.DocumentProperties.Title DocumentProperties will be used as Title. If Diagram.DocumentProperties.Title is null or empty the file name of Diagram will be used as Title.
      • getPageCount/setPageCount

        public int getPageCount() / public void setPageCount(int value)
        
        Gets or sets the number of pages to render in HTML. Default is MaxValue which means all pages of the diagram will be rendered.
      • getSaveToolBar/setSaveToolBar

        public boolean getSaveToolBar() / public void setSaveToolBar(boolean value)
        
        Specifies whether saving toolbar The default value is true.
      • getPageIndex/setPageIndex

        public int getPageIndex() / public void setPageIndex(int value)
        
        Gets or sets the 0-based index of the first page to render. Default is 0.
      • getSaveFormat/setSaveFormat

        public int getSaveFormat() / public void setSaveFormat(int value)
        
        Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat only. The value of the property is SaveFileFormat integer constant.
      • getExportHiddenPage/setExportHiddenPage

        public boolean getExportHiddenPage() / public void setExportHiddenPage(boolean value)
        
        Defines whether need exporting the hidden page or not. Default value is true.
      • getSaveTitle/setSaveTitle

        public boolean getSaveTitle() / public void setSaveTitle(boolean value)
        
        Defines whether need exporting the title or not. Default value is true.
      • getSaveForegroundPagesOnly/setSaveForegroundPagesOnly

        public boolean getSaveForegroundPagesOnly() / public void setSaveForegroundPagesOnly(boolean value)
        
        Specifies whether all pages will be saved in image or only foreground. If true - rendered only foreground pages(with background if present). If false - rendered foreground pages(with background if present) after that empty background pages. Can return true only when PageCount > 1. The default value is false.
      • getStreamProvider/setStreamProvider

        public IStreamProvider getStreamProvider() / public void setStreamProvider(IStreamProvider value)
        
        Gets or sets the IStreamProvider for exporting objects.
      • getSaveAsSingleFile/setSaveAsSingleFile

        public boolean getSaveAsSingleFile() / public void setSaveAsSingleFile(boolean value)
        
        Indicates whether save the html as single file. The default value is false. If there are multiple pages,those pages and other resources need to be saved into separate files. For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. If so, user may set this property as true.
      • getResolution/setResolution

        public int getResolution() / public void setResolution(int value)
        
        Gets or sets the resolution for the generated html, in dots per inch. This property has effect only when saving to html. The default value is 96.
      • getPageSize/setPageSize

        public PageSize getPageSize() / public void setPageSize(PageSize value)
        
        Gets or sets the page size for the generated images. Can be PageSize or null. The default value is null. If PageSize is null then page size for generated image is obtained from source diagram.
      • getShapes/setShapes

        public ShapeCollection getShapes() / public void setShapes(ShapeCollection value)
        
        Gets or sets shapes to render. Default count is 0.
      • getArea

        public java.awt.geom.Rectangle2D.Float getArea()
        
        Gets or sets the area of the shapes will be saved . This property has effect only when saving to raster image formats.
      • getExportGuideShapes/setExportGuideShapes

        public boolean getExportGuideShapes() / public void setExportGuideShapes(boolean value)
        
        Defines whether need exporting the guide shapes or not. Default value is true.
      • isExportComments/setExportComments

        public boolean isExportComments() / public void setExportComments(boolean value)
        
        Defines whether need exporting the comments or not. Default value is false.
      • getEnlargePage/setEnlargePage

        public boolean getEnlargePage() / public void setEnlargePage(boolean value)
        
        Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
      • getEmfRenderSetting/setEmfRenderSetting

        public int getEmfRenderSetting() / public void setEmfRenderSetting(int value)
        
        Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When #Error Cref: !:EmfRenderSetting.EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is #Error Cref: !:EmfRenderSetting.EmfOnly.
      • getDefaultFont/setDefaultFont

        public java.lang.String getDefaultFont() / public void setDefaultFont(java.lang.String value)
        
        When characters in the diagram are unicode and not be set with correct font value or the font is not installed locally, they may appear as block in pdf, image or XPS. Set the DefaultFont such as MingLiu or MS Gothic to show these characters.
      • getWarningCallback/setWarningCallback

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        
        Gets or sets warning callback.