MarkdownSaveOptions
Inheritance: java.lang.Object, com.aspose.pdf.SaveOptions com.aspose.pdf.UnifiedSaveOptions com.aspose.pdf.markdownoptions.MarkdownSaveOptions, com.aspose.pdf.SaveOptions, com.aspose.pdf.UnifiedSaveOptions com.aspose.pdf.markdownoptions.MarkdownSaveOptions, com.aspose.pdf.UnifiedSaveOptions, com.aspose.pdf.markdownoptions.MarkdownSaveOptions
public class MarkdownSaveOptions extends UnifiedSaveOptions
Represents the document save option class in the markdown format.
Constructors
| Constructor | Description |
|---|---|
| MarkdownSaveOptions | Creates an instance option to save a document in markdown format. |
Methods
| Method | Description |
|---|---|
| getAreaToExtract | Get or set an rectangle area to extract content to markdown. |
| getEmphasisStyle | Gets or sets the style of emphasis for generated document. |
| getExtractVectorGraphics | Gets and sets a property indicating whether vector graphics should be extracted. |
| getHeadingLevels | Defines expected heading levels to use in FontSize recognition headers strategy. If this property value is set, then header recognition {@link HeadingRecognitionStrategy#Heuristic} strategy will be selected when set {@link HeadingRecognitionStrategy#Auto} strategies even if the document contains bookmarks. |
| getHeadingRecognitionStrategy | Gets or sets the heading recognition strategy. |
| getHeadingStyle | Gets or sets the heading style for generated document. |
| getLineBreakStyle | Gets or sets the line break style for generated document. |
| getResourcesDirectoryName | Gets and sets the directory name to save document resources such as images. If the value is not specified, then the images will be written to the same directory as the markdown file itself. This is not path, it is only name! This directory will be automatically created in the directory with the saved markdown file. |
| getResourcesDirectoryPath | Gets and sets the directory name to save document resources such as images. This directory will be automatically created in the directory with the saved markdown file. |
| getSubscriptAndSuperscriptConversion | Gets ans sets allowance to convert subscript and superscript. This value is true by default. |
| getUseImageHtmlTag | Gets and sets allowance to use of an img tag to insert images to the left and right of the text. In this case, in the markdown viewer, the text will wrap around the image. |
| setAreaToExtract | Get or set an rectangle area to extract content to markdown. |
| setEmphasisStyle | Gets or sets the style of emphasis for generated document. |
| setExtractVectorGraphics | Gets and sets a property indicating whether vector graphics should be extracted. |
| setHeadingLevels | Defines expected heading levels to use in FontSize recognition headers strategy. If this property value is set, then header recognition {@link HeadingRecognitionStrategy#Heuristic} strategy will be selected when set {@link HeadingRecognitionStrategy#Auto} strategies even if the document contains bookmarks. |
| setHeadingRecognitionStrategy | Gets or sets the heading recognition strategy. |
| setHeadingStyle | Gets or sets the heading style for generated document. |
| setLineBreakStyle | Gets or sets the line break style for generated document. |
| setResourcesDirectoryName | Gets and sets the directory name to save document resources such as images. If the value is not specified, then the images will be written to the same directory as the markdown file itself. This is not path, it is only name! This directory will be automatically created in the directory with the saved markdown file. |
| setResourcesDirectoryPath | Gets and sets the directory name to save document resources such as images. This directory will be automatically created in the directory with the saved markdown file. |
| setSubscriptAndSuperscriptConversion | Gets ans sets allowance to convert subscript and superscript. This value is true by default. |
| setUseImageHtmlTag | Gets and sets allowance to use of an img tag to insert images to the left and right of the text. In this case, in the markdown viewer, the text will wrap around the image. |
MarkdownSaveOptions
public MarkdownSaveOptions()
Creates an instance option to save a document in markdown format.
getAreaToExtract
public final Rectangle getAreaToExtract()
Get or set an rectangle area to extract content to markdown.
Returns: Rectangle instance
getEmphasisStyle
public final int getEmphasisStyle()
Gets or sets the style of emphasis for generated document.
Returns: EmphasisStyle element
getExtractVectorGraphics
public final boolean getExtractVectorGraphics()
Gets and sets a property indicating whether vector graphics should be extracted.
Returns: boolean value
getHeadingLevels
public final HeadingLevels getHeadingLevels()
Defines expected heading levels to use in FontSize recognition headers strategy. If this property value is set, then header recognition {@link HeadingRecognitionStrategy#Heuristic} strategy will be selected when set {@link HeadingRecognitionStrategy#Auto} strategies even if the document contains bookmarks.
Returns: HeadingLevels instance
getHeadingRecognitionStrategy
public final int getHeadingRecognitionStrategy()
Gets or sets the heading recognition strategy.
Returns: HeadingRecognitionStrategy element
getHeadingStyle
public final int getHeadingStyle()
Gets or sets the heading style for generated document.
Returns: HeadingStyle element
getLineBreakStyle
public final int getLineBreakStyle()
Gets or sets the line break style for generated document.
Returns: LineBreakStyle element
getResourcesDirectoryName
public final String getResourcesDirectoryName()
Gets and sets the directory name to save document resources such as images. If the value is not specified, then the images will be written to the same directory as the markdown file itself. This is not path, it is only name! This directory will be automatically created in the directory with the saved markdown file.
Returns: String value
getResourcesDirectoryPath
public final String getResourcesDirectoryPath()
Gets and sets the directory name to save document resources such as images. This directory will be automatically created in the directory with the saved markdown file.
Returns: String value
getSubscriptAndSuperscriptConversion
public final boolean getSubscriptAndSuperscriptConversion()
Gets ans sets allowance to convert subscript and superscript. This value is true by default.
Returns: boolean value
getUseImageHtmlTag
public final boolean getUseImageHtmlTag()
Gets and sets allowance to use of an img tag to insert images to the left and right of the text. In this case, in the markdown viewer, the text will wrap around the image.
Returns: boolean value
setAreaToExtract
Get or set an rectangle area to extract content to markdown.
setEmphasisStyle
public final void setEmphasisStyle(int value)
Gets or sets the style of emphasis for generated document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | EmphasisStyle element |
setExtractVectorGraphics
public final void setExtractVectorGraphics(boolean value)
Gets and sets a property indicating whether vector graphics should be extracted.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean value |
setHeadingLevels
Defines expected heading levels to use in FontSize recognition headers strategy. If this property value is set, then header recognition {@link HeadingRecognitionStrategy#Heuristic} strategy will be selected when set {@link HeadingRecognitionStrategy#Auto} strategies even if the document contains bookmarks.
setHeadingRecognitionStrategy
public final void setHeadingRecognitionStrategy(int value)
Gets or sets the heading recognition strategy.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | HeadingRecognitionStrategy element |
setHeadingStyle
public final void setHeadingStyle(int value)
Gets or sets the heading style for generated document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | HeadingStyle element |
setLineBreakStyle
public final void setLineBreakStyle(int value)
Gets or sets the line break style for generated document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LineBreakStyle element |
setResourcesDirectoryName
Gets and sets the directory name to save document resources such as images. If the value is not specified, then the images will be written to the same directory as the markdown file itself. This is not path, it is only name! This directory will be automatically created in the directory with the saved markdown file.
setResourcesDirectoryPath
Gets and sets the directory name to save document resources such as images. This directory will be automatically created in the directory with the saved markdown file.
setSubscriptAndSuperscriptConversion
public final void setSubscriptAndSuperscriptConversion(boolean value)
Gets ans sets allowance to convert subscript and superscript. This value is true by default.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean value |
setUseImageHtmlTag
public final void setUseImageHtmlTag(boolean value)
Gets and sets allowance to use of an img tag to insert images to the left and right of the text. In this case, in the markdown viewer, the text will wrap around the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean value |