LowCodePdfSaveOptions
LowCodePdfSaveOptions class
Options for saving pdf in low code way.
class LowCodePdfSaveOptions extends LowCodeSaveOptions;
Constructors
| Name | Description |
|---|---|
| constructor(LowCodeSaveOptions) | Constructs from a parent object convertible to this. |
| constructor() | Default Constructor. |
Methods
| Method | Description |
|---|---|
| getSaveFormat() | The save format for the output. For converting to pdf, it can only be SaveFormat.Pdf. |
| setSaveFormat(SaveFormat) | The save format for the output. For converting to pdf, it can only be SaveFormat.Pdf. |
| getPdfOptions() | The options for saving Pdf file. |
| setPdfOptions(PdfSaveOptions) | The options for saving Pdf file. |
| 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()
The save format for the output. For converting to pdf, it can only be SaveFormat.Pdf.
getSaveFormat() : SaveFormat;
Returns
setSaveFormat(SaveFormat)
The save format for the output. For converting to pdf, it can only be SaveFormat.Pdf.
setSaveFormat(value: SaveFormat) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SaveFormat | The value to set. |
getPdfOptions()
The options for saving Pdf file.
getPdfOptions() : PdfSaveOptions;
Returns
setPdfOptions(PdfSaveOptions)
The options for saving Pdf file.
setPdfOptions(value: PdfSaveOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PdfSaveOptions | The value to set. |
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. |