Index (GroupDocs.Markdown (25.12) API Reference)

C D E F G H I L M S V

C

close() - Method in class com.groupdocs.markdown.MarkdownConverter: Close and release resources.
com.groupdocs.markdown - package com.groupdocs.markdown
convert() - Method in class com.groupdocs.markdown.MarkdownConverter: Convert to Markdown and return result string.
convert(OutputStream) - Method in class com.groupdocs.markdown.MarkdownConverter: Convert and write result to provided OutputStream.
convert(DocumentConverterOptions) - Method in class com.groupdocs.markdown.MarkdownConverter: Convert with explicit options and return markdown string.
convert(OutputStream, DocumentConverterOptions) - Method in class com.groupdocs.markdown.MarkdownConverter: Convert with explicit options to provided OutputStream.
convertToFile(String) - Method in class com.groupdocs.markdown.MarkdownConverter: Convert and save to file path.
convertToFile(String, DocumentConverterOptions) - Method in class com.groupdocs.markdown.MarkdownConverter: Convert with explicit options and save to a file path.
CustomImageSavingArgs - Class in com.groupdocs.markdown: User arguments for saving an image.
CustomImageSavingArgs(String, String, String) - Constructor for class com.groupdocs.markdown.CustomImageSavingArgs: Internal constructor.
CustomImagesStrategy - Class in com.groupdocs.markdown: Implements an image export strategy that allows the user to control how images are saved when a document is converted to Markdown format.
CustomImagesStrategy(String, CustomImagesStrategy.CustomImageSavingHandler) - Constructor for class com.groupdocs.markdown.CustomImagesStrategy: Initializes a new instance of the CustomImagesStrategy class.
CustomImagesStrategy.CustomImageSavingHandler - Interface in com.groupdocs.markdown: Functional interface representing a custom image-saving handler.

D

DocumentConverterOptions - Class in com.groupdocs.markdown: Provides options for customizing the document conversion process to Markdown format.
DocumentConverterOptions() - Constructor for class com.groupdocs.markdown.DocumentConverterOptions: Initializes a new instance of the DocumentConverterOptions class.
DocumentConverterResult - Class in com.groupdocs.markdown: Represents the result of a document conversion operation to Markdown format.
DocumentProtectedException - Exception in com.groupdocs.markdown: The exception that is thrown when a document is protected by a password.
DocumentProtectedException() - Constructor for exception com.groupdocs.markdown.DocumentProtectedException: Initializes a new instance of the DocumentProtectedException class.

E

ExportImagesAsBase64Strategy - Class in com.groupdocs.markdown: Implements an image export strategy that embeds images as Base64 strings directly in the Markdown.
ExportImagesAsBase64Strategy() - Constructor for class com.groupdocs.markdown.ExportImagesAsBase64Strategy
ExportImagesToFileSystemStrategy - Class in com.groupdocs.markdown: Implements an image export strategy that saves images to the file system during document conversion.
ExportImagesToFileSystemStrategy(String) - Constructor for class com.groupdocs.markdown.ExportImagesToFileSystemStrategy: Initializes a new instance of the ExportImagesToFileSystemStrategy class.
ExportImagesToFileSystemStrategy(String, String) - Constructor for class com.groupdocs.markdown.ExportImagesToFileSystemStrategy: Initializes a new instance of the ExportImagesToFileSystemStrategy class.

F

failure(String, Exception) - Static method in class com.groupdocs.markdown.DocumentConverterResult: Creates a failed conversion result with error information.
FileFormat - Enum in com.groupdocs.markdown: Represents the recognized format of a loaded file.

G

getConsumptionCredit() - Static method in class com.groupdocs.markdown.Metered: Gets the consumption credit.
getConsumptionQuantity() - Static method in class com.groupdocs.markdown.Metered: Gets the consumption file size.
getContent() - Method in class com.groupdocs.markdown.DocumentConverterResult: Gets the converted Markdown content.
getCustomHandler() - Method in class com.groupdocs.markdown.CustomImagesStrategy
getErrorMessage() - Method in class com.groupdocs.markdown.DocumentConverterResult: Gets the error message if the conversion failed.
getException() - Method in class com.groupdocs.markdown.DocumentConverterResult: Gets the exception that occurred during conversion, if any.
getExtension() - Method in class com.groupdocs.markdown.LoadOptions: Gets the file extension of the stream.
getFileFormat() - Method in class com.groupdocs.markdown.LoadOptions: Gets the exact type of the file that is to be loaded.
getImageExportStrategy() - Method in class com.groupdocs.markdown.DocumentConverterOptions: Gets the current image export strategy.
getImageFileName() - Method in class com.groupdocs.markdown.CustomImageSavingArgs: Gets the file name (without path) where the image will be saved to.
getImageFileName() - Method in class com.groupdocs.markdown.ImageExportContext: Gets the image file name.
getImageFileNameOutput() - Method in class com.groupdocs.markdown.CustomImageSavingArgs: Gets the override file name (without path) where the image will be saved to.
getImagesFolder() - Method in class com.groupdocs.markdown.CustomImagesStrategy: Gets the folder where images will be exported.
getImagesFolder() - Method in class com.groupdocs.markdown.ExportImagesAsBase64Strategy: Gets an empty string as this strategy does not use an images folder.
getImagesFolder() - Method in class com.groupdocs.markdown.ExportImagesToFileSystemStrategy: Gets the folder where images will be exported.
getImagesFolder() - Method in interface com.groupdocs.markdown.IImageExportStrategy: Gets the folder where exported images will be stored.
getImagesFolder() - Method in class com.groupdocs.markdown.SkipImagesStrategy: Gets an empty string as this strategy does not use an images folder.
getImageStream(ImageExportContext) - Method in class com.groupdocs.markdown.CustomImagesStrategy: Gets an output stream for writing the exported image to the file system.
getImageStream(ImageExportContext) - Method in class com.groupdocs.markdown.ExportImagesAsBase64Strategy: Returns null to indicate that the image should be embedded as Base64.
getImageStream(ImageExportContext) - Method in class com.groupdocs.markdown.ExportImagesToFileSystemStrategy: Gets a stream for writing the exported image to the file system.
getImageStream(ImageExportContext) - Method in interface com.groupdocs.markdown.IImageExportStrategy: Gets a stream for writing the exported image.
getImageStream(ImageExportContext) - Method in class com.groupdocs.markdown.SkipImagesStrategy: Returns null to indicate that the image should be skipped.
getMarkdownImagesFolder() - Method in class com.groupdocs.markdown.ExportImagesToFileSystemStrategy: Gets the image path for the Markdown file
getMeteredCounter() - Method in class com.groupdocs.markdown.MarkdownConverter: Expose meteredCounter for tests or callers (if needed).
getMimeType() - Method in class com.groupdocs.markdown.LoadOptions: Gets the MIME type of the stream.
getOutputDirectory() - Method in class com.groupdocs.markdown.CustomImageSavingArgs: Gets the output directory.
getOutputStream() - Method in class com.groupdocs.markdown.CustomImageSavingArgs: Gets the output stream.
getPageNumbers() - Method in class com.groupdocs.markdown.DocumentConverterOptions: Gets the array of page or worksheet numbers to convert.
getPassword() - Method in class com.groupdocs.markdown.LoadOptions: Gets the password for opening an encrypted document.
getShapeType() - Method in class com.groupdocs.markdown.CustomImageSavingArgs: Gets the shape type.
GroupDocsMarkdownException - Exception in com.groupdocs.markdown: Represents a product-specific exception that is thrown during file processing.
GroupDocsMarkdownException() - Constructor for exception com.groupdocs.markdown.GroupDocsMarkdownException: Initializes a new instance of the GroupDocsMarkdownException class.
GroupDocsMarkdownException(String) - Constructor for exception com.groupdocs.markdown.GroupDocsMarkdownException: Initializes a new instance of the GroupDocsMarkdownException class.
GroupDocsMarkdownException(String, Throwable) - Constructor for exception com.groupdocs.markdown.GroupDocsMarkdownException: Initializes a new instance of the GroupDocsMarkdownException class.
GroupDocsMarkdownException(Throwable) - Constructor for exception com.groupdocs.markdown.GroupDocsMarkdownException: Initializes a new instance of the GroupDocsMarkdownException class.

H

handle(CustomImageSavingArgs) - Method in interface com.groupdocs.markdown.CustomImagesStrategy.CustomImageSavingHandler

I

IImageExportStrategy - Interface in com.groupdocs.markdown: Defines the interface for handling image export during document conversion to Markdown.
ImageExportContext - Class in com.groupdocs.markdown: Represents the context for image handling during document conversion to Markdown.
ImageExportContext() - Constructor for class com.groupdocs.markdown.ImageExportContext
InvalidFormatException - Exception in com.groupdocs.markdown: The exception that is thrown when a file has an invalid format.
InvalidFormatException() - Constructor for exception com.groupdocs.markdown.InvalidFormatException: Initializes a new instance of the InvalidFormatException class.
InvalidFormatException(String) - Constructor for exception com.groupdocs.markdown.InvalidFormatException: Initializes a new instance of the InvalidFormatException class.
InvalidFormatException(String, Throwable) - Constructor for exception com.groupdocs.markdown.InvalidFormatException: Initializes a new instance of the InvalidFormatException class.
InvalidFormatException(Throwable) - Constructor for exception com.groupdocs.markdown.InvalidFormatException: Initializes a new instance of the InvalidFormatException class.
isSuccess() - Method in class com.groupdocs.markdown.DocumentConverterResult: Gets whether the conversion was successful.

L

License - Class in com.groupdocs.markdown: Provides methods for applying a license to the GroupDocs.Markdown library.
License() - Constructor for class com.groupdocs.markdown.License: Initializes a new instance of the License class.
LoadOptions - Class in com.groupdocs.markdown: Allows a developer to specify additional options (such as a password) when loading a file.
LoadOptions() - Constructor for class com.groupdocs.markdown.LoadOptions: Initializes a new instance of the LoadOptions class.
LoadOptions(FileFormat) - Constructor for class com.groupdocs.markdown.LoadOptions: Initializes a new instance of the LoadOptions class with a specific file format.

M

MarkdownConverter - Class in com.groupdocs.markdown: Converts various document formats to Markdown format.
MarkdownConverter(String) - Constructor for class com.groupdocs.markdown.MarkdownConverter: Create converter from a file path.
MarkdownConverter(String, LoadOptions) - Constructor for class com.groupdocs.markdown.MarkdownConverter: Create converter from a file path with explicit load options.
MarkdownConverter(InputStream) - Constructor for class com.groupdocs.markdown.MarkdownConverter: Create converter from an InputStream.
MarkdownConverter(InputStream, LoadOptions) - Constructor for class com.groupdocs.markdown.MarkdownConverter: Create converter from an InputStream + optional LoadOptions.
Metered - Class in com.groupdocs.markdown: Provides methods to set and retrieve metered licensing information for GroupDocs.Markdown.
Metered() - Constructor for class com.groupdocs.markdown.Metered

S

set(String) - Static method in class com.groupdocs.markdown.License: Sets the license from a file path (static version).
set(InputStream) - Static method in class com.groupdocs.markdown.License: Sets the license from a stream (static version).
setExtension(String) - Method in class com.groupdocs.markdown.LoadOptions: Sets the file extension of the stream.
setFileFormat(FileFormat) - Method in class com.groupdocs.markdown.LoadOptions: Sets the exact type of the file that is to be loaded.
setImageExportStrategy(IImageExportStrategy) - Method in class com.groupdocs.markdown.DocumentConverterOptions: Sets the image export strategy.
setImageFileName(String) - Method in class com.groupdocs.markdown.ImageExportContext: Sets the image file name.
setLicense(String) - Method in class com.groupdocs.markdown.License: Sets the license from a file path.
setLicense(InputStream) - Method in class com.groupdocs.markdown.License: Sets the license from a stream.
setMeteredKey(String, String) - Method in class com.groupdocs.markdown.Metered: Sets the metered public and private keys.
setMimeType(String) - Method in class com.groupdocs.markdown.LoadOptions: Sets the MIME type of the stream.
setOutputImageFileName(String) - Method in class com.groupdocs.markdown.CustomImageSavingArgs: Sets the file name (without path) where the image will be saved to.
setOutputStream(OutputStream) - Method in class com.groupdocs.markdown.CustomImageSavingArgs: Sets the output stream.
setPageNumbers(List<Integer>) - Method in class com.groupdocs.markdown.DocumentConverterOptions: Sets the array of page or worksheet numbers to convert.
setPassword(String) - Method in class com.groupdocs.markdown.LoadOptions: Sets the password for opening an encrypted document.
SkipImagesStrategy - Class in com.groupdocs.markdown: Implements an image export strategy that skips saving images during document conversion.
SkipImagesStrategy() - Constructor for class com.groupdocs.markdown.SkipImagesStrategy
success() - Static method in class com.groupdocs.markdown.DocumentConverterResult: Creates a successful conversion result without Markdown content.
success(String) - Static method in class com.groupdocs.markdown.DocumentConverterResult: Creates a successful conversion result with Markdown content.

V

valueOf(String) - Static method in enum com.groupdocs.markdown.FileFormat: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.groupdocs.markdown.FileFormat: Returns an array containing the constants of this enum type, in the order they are declared.

C D E F G H I L M S V