public class MarkdownSaveOptions extends UnifiedSaveOptions
Represents the document save option class in the markdown format.
UnifiedSaveOptions.ConversionProgressEventHandler, UnifiedSaveOptions.ProgressEventHandlerInfo
SaveOptions.BorderInfo, SaveOptions.BorderPartStyle, SaveOptions.HtmlBorderLineType, SaveOptions.MarginInfo, SaveOptions.MarginPartStyle, SaveOptions.NodeLevelResourceType, SaveOptions.ResourceSavingInfo
IsMultiThreading
Constructor and Description |
---|
MarkdownSaveOptions()
Creates an instance option to save a document in markdown format.
|
Modifier and Type | Method and Description |
---|---|
Rectangle |
getAreaToExtract()
Get or set an rectangle area to extract content to markdown.
|
int |
getEmphasisStyle()
Gets or sets the style of emphasis for generated document.
|
boolean |
getExtractVectorGraphics()
Gets and sets a property indicating whether vector graphics should be extracted.
|
HeadingLevels |
getHeadingLevels()
Defines expected heading levels to use in FontSize recognition headers strategy.
|
int |
getHeadingRecognitionStrategy()
Gets or sets the heading recognition strategy.
|
int |
getHeadingStyle()
Gets or sets the heading style for generated document.
|
int |
getLineBreakStyle()
Gets or sets the line break style for generated document.
|
String |
getResourcesDirectoryName()
Gets and sets the directory name to save document resources such as images.
|
String |
getResourcesDirectoryPath()
Gets and sets the directory name to save document resources such as images.
|
boolean |
getSubscriptAndSuperscriptConversion()
Gets ans sets allowance to convert subscript and superscript.
|
boolean |
getUseImageHtmlTag()
Gets and sets allowance to use of an img tag to insert images to the left and right of the text.
|
void |
setAreaToExtract(Rectangle value)
Get or set an rectangle area to extract content to markdown.
|
void |
setEmphasisStyle(int value)
Gets or sets the style of emphasis for generated document.
|
void |
setExtractVectorGraphics(boolean value)
Gets and sets a property indicating whether vector graphics should be extracted.
|
void |
setHeadingLevels(HeadingLevels value)
Defines expected heading levels to use in FontSize recognition headers strategy.
|
void |
setHeadingRecognitionStrategy(int value)
Gets or sets the heading recognition strategy.
|
void |
setHeadingStyle(int value)
Gets or sets the heading style for generated document.
|
void |
setLineBreakStyle(int value)
Gets or sets the line break style for generated document.
|
void |
setResourcesDirectoryName(String value)
Gets and sets the directory name to save document resources such as images.
|
void |
setResourcesDirectoryPath(String value)
Gets and sets the directory name to save document resources such as images.
|
void |
setSubscriptAndSuperscriptConversion(boolean value)
Gets ans sets allowance to convert subscript and superscript.
|
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.
|
getProgressEventsRetranslator, isExtractOcrSublayerOnly, isTryMergeAdjacentSameBackgroundImages, setExtractOcrSublayerOnly, setProgressEventsRetranslator, setTryMergeAdjacentSameBackgroundImages
getSaveFormat, getWarningHandler, isCacheGlyphs, isCloseResponse, setCacheGlyphs, setCloseResponse, setWarningHandler
public MarkdownSaveOptions()
Creates an instance option to save a document in markdown format.
public final boolean getExtractVectorGraphics()
Gets and sets a property indicating whether vector graphics should be extracted.
public final void setExtractVectorGraphics(boolean value)
Gets and sets a property indicating whether vector graphics should be extracted.
value
- boolean valuepublic final Rectangle getAreaToExtract()
Get or set an rectangle area to extract content to markdown.
public final void setAreaToExtract(Rectangle value)
Get or set an rectangle area to extract content to markdown.
value
- Rectangle instancepublic final boolean getSubscriptAndSuperscriptConversion()
Gets ans sets allowance to convert subscript and superscript. This value is true by default.
public final void setSubscriptAndSuperscriptConversion(boolean value)
Gets ans sets allowance to convert subscript and superscript. This value is true by default.
value
- boolean valuepublic 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.
public final void setResourcesDirectoryName(String value)
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.
value
- String valuepublic 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.
public final void setResourcesDirectoryPath(String value)
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.
value
- String valuepublic 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.
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.
value
- boolean valuepublic final int getLineBreakStyle()
Gets or sets the line break style for generated document.
public final void setLineBreakStyle(int value)
Gets or sets the line break style for generated document.
value
- LineBreakStyle elementpublic final int getEmphasisStyle()
Gets or sets the style of emphasis for generated document.
public final void setEmphasisStyle(int value)
Gets or sets the style of emphasis for generated document.
value
- EmphasisStyle elementpublic final int getHeadingStyle()
Gets or sets the heading style for generated document.
public final void setHeadingStyle(int value)
Gets or sets the heading style for generated document.
value
- HeadingStyle elementpublic final HeadingLevels getHeadingLevels()
Defines expected heading levels to use in FontSize recognition headers strategy.
If this property value is set, then header recognition HeadingRecognitionStrategy.Heuristic
strategy will be selected when set HeadingRecognitionStrategy.Auto
strategies even if the document contains bookmarks.
public final void setHeadingLevels(HeadingLevels value)
Defines expected heading levels to use in FontSize recognition headers strategy.
If this property value is set, then header recognition HeadingRecognitionStrategy.Heuristic
strategy will be selected when set HeadingRecognitionStrategy.Auto
strategies even if the document contains bookmarks.
value
- HeadingLevels instancepublic final int getHeadingRecognitionStrategy()
Gets or sets the heading recognition strategy.
public final void setHeadingRecognitionStrategy(int value)
Gets or sets the heading recognition strategy.
value
- HeadingRecognitionStrategy elementCopyright © 2025 Aspose. All Rights Reserved.