HTMLSaveOptions
Inheritance: java.lang.Object, com.aspose.diagram.SaveOptions, com.aspose.diagram.RenderingSaveOptions
public class HTMLSaveOptions extends RenderingSaveOptions
Allows to specify additional options when rendering diagram pages to HTML.
Constructors
| Constructor | Description |
|---|---|
| HTMLSaveOptions() | Initializes a new instance of this class that can be used to save a document in the Aspose.Diagram.SaveFileFormat format. |
Methods
| Method | Description |
|---|---|
| createSaveOptions(int saveFormat) | Creates a save options object of a class suitable for the specified save format. |
| equals(Object arg0) | |
| getClass() | |
| getDefaultFont() | 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. |
| getEmfRenderSetting() | Setting for rendering Emf metafile. |
| getEnlargePage() | Specifies whether enlarge page . |
| getExportGuideShapes() | Defines whether need exporting the guide shapes or not. |
| getExportHiddenPage() | Defines whether need exporting the hidden page or not. |
| getPageCount() | the number of pages to render in HTML. |
| getPageIndex() | the 0-based index of the first page to render. |
| getPageSize() | the page size for the generated images. |
| getResolution() | the resolution for the generated html, in dots per inch. |
| getSaveAsSingleFile() | Indicates whether save the html as single file. |
| getSaveForegroundPagesOnly() | Specifies whether all pages will be saved in image or only foreground. |
| getSaveFormat() | Specifies the format in which the rendered diagram pages will be saved if this save options object is used. |
| getSaveTitle() | Defines whether need exporting the title or not. |
| getSaveToolBar() | Specifies whether saving toolbar The default value is true. |
| getShapes() | shapes to render. |
| getStreamProvider() | the IStreamProvider for exporting objects. |
| getTitle() | the title of diagram to render in HTML. |
| getWarningCallback() | warning callback. |
| hashCode() | |
| isExportComments() | Defines whether need exporting the comments or not. |
| notify() | |
| notifyAll() | |
| setDefaultFont(String value) | For the description of this property, please see getDefaultFont() |
| setEmfRenderSetting(int value) | For the description of this property, please see getEmfRenderSetting() |
| setEnlargePage(boolean value) | For the description of this property, please see getEnlargePage() |
| setExportComments(boolean value) | For the description of this property, please see isExportComments() |
| setExportGuideShapes(boolean value) | For the description of this property, please see getExportGuideShapes() |
| setExportHiddenPage(boolean value) | For the description of this property, please see getExportHiddenPage() |
| setPageCount(int value) | For the description of this property, please see getPageCount() |
| setPageIndex(int value) | For the description of this property, please see getPageIndex() |
| setPageSize(PageSize value) | For the description of this property, please see getPageSize() |
| setResolution(int value) | For the description of this property, please see getResolution() |
| setSaveAsSingleFile(boolean value) | For the description of this property, please see getSaveAsSingleFile() |
| setSaveForegroundPagesOnly(boolean value) | For the description of this property, please see getSaveForegroundPagesOnly() |
| setSaveFormat(int value) | For the description of this property, please see getSaveFormat() |
| setSaveTitle(boolean value) | For the description of this property, please see getSaveTitle() |
| setSaveToolBar(boolean value) | For the description of this property, please see getSaveToolBar() |
| setShapes(ShapeCollection value) | For the description of this property, please see getShapes() |
| setStreamProvider(IStreamProvider value) | For the description of this property, please see getStreamProvider() |
| setTitle(String value) | For the description of this property, please see getTitle() |
| setWarningCallback(IWarningCallback value) | |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
HTMLSaveOptions()
public HTMLSaveOptions()
Initializes a new instance of this class that can be used to save a document in the Aspose.Diagram.SaveFileFormat format.
createSaveOptions(int saveFormat)
public static SaveOptions createSaveOptions(int saveFormat)
Creates a save options object of a class suitable for the specified save format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | The Aspose.Diagram.SaveFileFormat for which to create a save options object. |
Returns: SaveOptions - An object of a class that derives from SaveOptions.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getDefaultFont()
public String getDefaultFont()
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.
Returns: java.lang.String
getEmfRenderSetting()
public int getEmfRenderSetting()
Setting for rendering Emf metafile. 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 EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is EmfOnly"/>.
Returns: int
getEnlargePage()
public boolean getEnlargePage()
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
Returns: boolean
getExportGuideShapes()
public boolean getExportGuideShapes()
Defines whether need exporting the guide shapes or not. Default value is true.
Returns: boolean
getExportHiddenPage()
public boolean getExportHiddenPage()
Defines whether need exporting the hidden page or not. Default value is true.
Returns: boolean
getPageCount()
public int getPageCount()
the number of pages to render in HTML. Default is MaxValue which means all pages of the diagram will be rendered.
Returns: int
getPageIndex()
public int getPageIndex()
the 0-based index of the first page to render. Default is 0.
Returns: int
getPageSize()
public PageSize getPageSize()
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.
Returns: PageSize
getResolution()
public int getResolution()
the resolution for the generated html, in dots per inch. This property has effect only when saving to html. The default value is 96.
Returns: int
getSaveAsSingleFile()
public boolean getSaveAsSingleFile()
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.
Returns: boolean
getSaveForegroundPagesOnly()
public boolean getSaveForegroundPagesOnly()
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.
Returns: boolean
getSaveFormat()
public int getSaveFormat()
Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be Aspose.Diagram.SaveFileFormat only.
Returns: int
getSaveTitle()
public boolean getSaveTitle()
Defines whether need exporting the title or not. Default value is true.
Returns: boolean
getSaveToolBar()
public boolean getSaveToolBar()
Specifies whether saving toolbar The default value is true.
Returns: boolean
getShapes()
public ShapeCollection getShapes()
shapes to render. Default count is 0.
Returns: ShapeCollection
getStreamProvider()
public IStreamProvider getStreamProvider()
the IStreamProvider for exporting objects.
Returns: IStreamProvider
getTitle()
public String getTitle()
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.
Returns: java.lang.String
getWarningCallback()
public IWarningCallback getWarningCallback()
warning callback.
Returns: IWarningCallback
hashCode()
public native int hashCode()
Returns: int
isExportComments()
public boolean isExportComments()
Defines whether need exporting the comments or not. Default value is false.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setDefaultFont(String value)
public void setDefaultFont(String value)
For the description of this property, please see getDefaultFont()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setEmfRenderSetting(int value)
public void setEmfRenderSetting(int value)
For the description of this property, please see getEmfRenderSetting()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setEnlargePage(boolean value)
public void setEnlargePage(boolean value)
For the description of this property, please see getEnlargePage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportComments(boolean value)
public void setExportComments(boolean value)
For the description of this property, please see isExportComments()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportGuideShapes(boolean value)
public void setExportGuideShapes(boolean value)
For the description of this property, please see getExportGuideShapes()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setExportHiddenPage(boolean value)
public void setExportHiddenPage(boolean value)
For the description of this property, please see getExportHiddenPage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPageCount(int value)
public void setPageCount(int value)
For the description of this property, please see getPageCount()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageIndex(int value)
public void setPageIndex(int value)
For the description of this property, please see getPageIndex()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setPageSize(PageSize value)
public void setPageSize(PageSize value)
For the description of this property, please see getPageSize()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PageSize |
setResolution(int value)
public void setResolution(int value)
For the description of this property, please see getResolution()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setSaveAsSingleFile(boolean value)
public void setSaveAsSingleFile(boolean value)
For the description of this property, please see getSaveAsSingleFile()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSaveForegroundPagesOnly(boolean value)
public void setSaveForegroundPagesOnly(boolean value)
For the description of this property, please see getSaveForegroundPagesOnly()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSaveFormat(int value)
public void setSaveFormat(int value)
For the description of this property, please see getSaveFormat()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setSaveTitle(boolean value)
public void setSaveTitle(boolean value)
For the description of this property, please see getSaveTitle()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSaveToolBar(boolean value)
public void setSaveToolBar(boolean value)
For the description of this property, please see getSaveToolBar()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setShapes(ShapeCollection value)
public void setShapes(ShapeCollection value)
For the description of this property, please see getShapes()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ShapeCollection |
setStreamProvider(IStreamProvider value)
public void setStreamProvider(IStreamProvider value)
For the description of this property, please see getStreamProvider()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IStreamProvider |
setTitle(String value)
public void setTitle(String value)
For the description of this property, please see getTitle()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setWarningCallback(IWarningCallback value)
public void setWarningCallback(IWarningCallback value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IWarningCallback |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |