LowCodeHtmlSaveOptions
LowCodeHtmlSaveOptions class
Options for saving html in low code way.
class LowCodeHtmlSaveOptions extends LowCodeSaveOptions;
Constructors
| Name | Description |
|---|---|
| constructor(LowCodeSaveOptions) | Constructs from a parent object convertible to this. |
| constructor() | Default Constructor. |
Methods
| Method | Description |
|---|---|
| getSaveFormat() | Gets and sets the format of spreadsheet. |
| setSaveFormat(SaveFormat) | Gets and sets the format of spreadsheet. |
| getHtmlOptions() | The general options for saving html. |
| setHtmlOptions(HtmlSaveOptions) | The general options for saving html. |
| isNull() | Checks whether the implementation object is null. |
| getOutputFile() | Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored. |
| setOutputFile(string) | Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored. |
| getOutputStream() | Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored. |
| setOutputStream(Uint8Array) | Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored. |
constructor(LowCodeSaveOptions)
Constructs from a parent object convertible to this.
constructor(obj: LowCodeSaveOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | LowCodeSaveOptions | The parent object. |
constructor()
Default Constructor.
constructor();
getSaveFormat()
Gets and sets the format of spreadsheet.
getSaveFormat() : SaveFormat;
Returns
Remarks
When changing this property, the save format specified by HtmlOptions will be ignored(if it had been specified before).
setSaveFormat(SaveFormat)
Gets and sets the format of spreadsheet.
setSaveFormat(value: SaveFormat) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SaveFormat | The value to set. |
Remarks
When changing this property, the save format specified by HtmlOptions will be ignored(if it had been specified before).
getHtmlOptions()
The general options for saving html.
getHtmlOptions() : HtmlSaveOptions;
Returns
Remarks
When one HtmlSaveOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).
setHtmlOptions(HtmlSaveOptions)
The general options for saving html.
setHtmlOptions(value: HtmlSaveOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | HtmlSaveOptions | The value to set. |
Remarks
When one HtmlSaveOptions instance is specified, the SaveFormat will be overwritten(if it had been specified before).
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getOutputFile()
Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored.
getOutputFile() : string;
setOutputFile(string)
Gets and sets the file(with path if needed) for saving the generated data. When setting this property with value other than null or empty string, OutputStream will be ignored.
setOutputFile(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getOutputStream()
Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored.
getOutputStream() : Uint8Array;
setOutputStream(Uint8Array)
Gets and sets the Stream for writing the generated data to. When setting this property with value other than null, OutputFile will be ignored.
setOutputStream(value: Uint8Array) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Uint8Array | The value to set. |