Skip to content

Commit b39dd89

Browse files
chore: sync markdown files from source repo
1 parent 608605b commit b39dd89

70 files changed

Lines changed: 3031 additions & 9 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/sites/groupdocs/markdown/english/net/_index.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,13 @@ weight: 10
55
url: /net/
66
description: GroupDocs.Markdown for .NET API References contain examples, code snippets, and API documentation. It provides namespaces, classes, interfaces, and other API details.
77
is_root: true
8-
version: "25.9"
9-
date: "2025-08-26"
10-
lastmod: "2025-08-26"
11-
categories: ["Document APIs"]
12-
tags: ["groupdocs", "markdown", "export", ".net"]
8+
version:
139
---
1410

15-
🚧 Coming Soon!
11+
## Namespaces
1612

17-
We’re preparing the first release of GroupDocs.Markdown for .NET.
18-
Very soon you’ll be able to download the library and start exporting documents to Markdown and to make your documents gen AI ready.
13+
| Namespace | Description |
14+
| --- | --- |
15+
| [GroupDocs.Markdown](./groupdocs.markdown) | The namespace contains some specific exceptions that are thrown by the library during file reading and updating. |
1916

20-
Stay tuned for updates, and check back shortly to get access to the first version! ✨
17+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: GroupDocs.Markdown
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: The namespace contains some specific exceptions that are thrown by the library during file reading and updating.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown/
8+
---
9+
The namespace contains some specific exceptions that are thrown by the library during file reading and updating.
10+
11+
## Classes
12+
13+
| Class | Description |
14+
| --- | --- |
15+
| [CustomImageSavingArgs](./customimagesavingargs) | User arguments for saving item. |
16+
| [CustomImagesStrategy.CustomImageSavingHandler](./customimagesstrategy.customimagesavinghandler) | Delegate through which you can define the mechanism for saving images when creating a .md file |
17+
| [CustomImagesStrategy](./customimagesstrategy) | Implements an image export strategy that user control how images are saved when a document is saved to Markdown format. |
18+
| [DocumentConverterOptions](./documentconverteroptions) | Provides options for customizing the document conversion process to Markdown format. |
19+
| [DocumentConverterResult](./documentconverterresult) | Represents the result of a document conversion operation to Markdown format. |
20+
| [DocumentProtectedException](./documentprotectedexception) | The exception that is thrown when document is protected by password. |
21+
| [ExportImagesAsBase64Strategy](./exportimagesasbase64strategy) | Implements an image export strategy that embeds images as Base64 strings directly in the Markdown. |
22+
| [ExportImagesToFileSystemStrategy](./exportimagestofilesystemstrategy) | Implements an image export strategy that saves images to the file system during document conversion. |
23+
| [GroupDocsMarkdownException](./groupdocsmarkdownexception) | Represents a product-specific exception that is thrown during file processing. |
24+
| [ImageExportContext](./imageexportcontext) | Represents the context for image handling during document conversion to Markdown. This context is provided by the library during conversion and contains information about the image being processed. |
25+
| [InvalidFormatException](./invalidformatexception) | The exception that is thrown when a file has an invalid format. |
26+
| [License](./license) | Provides methods for applying license to the GroupDocs.Markdown library. |
27+
| [LoadOptions](./loadoptions) | Allows a developer to specify additional options (such as a password) when loading a file. |
28+
| [MarkdownConverter](./markdownconverter) | Converts various document formats to Markdown format. |
29+
| [Metered](./metered) | Provides methods to set a metered key. |
30+
| [SkipImagesStrategy](./skipimagesstrategy) | Implements an image export strategy that skips saving images during document conversion. |
31+
## Interfaces
32+
33+
| Interface | Description |
34+
| --- | --- |
35+
| [IImageExportStrategy](./iimageexportstrategy) | Defines the interface for handling image export during document conversion to Markdown. Implement this interface to customize how images are exported from source documents. |
36+
## Enumeration
37+
38+
| Enumeration | Description |
39+
| --- | --- |
40+
| [FileFormat](./fileformat) | Represents the recognized format of a loaded file. |
41+
42+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: CustomImageSavingArgs
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: User arguments for saving item.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown/customimagesavingargs/
8+
---
9+
## CustomImageSavingArgs class
10+
11+
User arguments for saving item.
12+
13+
```csharp
14+
public class CustomImageSavingArgs
15+
```
16+
17+
## Properties
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [ImageFileName](../../groupdocs.markdown/customimagesavingargs/imagefilename) { get; } | Gets the file name (without path) where the image will be saved to. |
22+
| [ImageFileNameOutput](../../groupdocs.markdown/customimagesavingargs/imagefilenameoutput) { get; } | Gets the override file name (without path) where the image will be saved to. |
23+
| [OutputDirectory](../../groupdocs.markdown/customimagesavingargs/outputdirectory) { get; } | Get the Output Directory |
24+
| [OutputStream](../../groupdocs.markdown/customimagesavingargs/outputstream) { get; } | Gets the Output Stream |
25+
| [ShapeType](../../groupdocs.markdown/customimagesavingargs/shapetype) { get; } | Gets the shape type. |
26+
27+
## Methods
28+
29+
| Name | Description |
30+
| --- | --- |
31+
| [SetOutputImageFileName](../../groupdocs.markdown/customimagesavingargs/setoutputimagefilename)(string) | Set the file name (without path) where the image will be saved to. |
32+
| [SetOutputStream](../../groupdocs.markdown/customimagesavingargs/setoutputstream)(Stream) | Set the Output Stream |
33+
34+
### See Also
35+
36+
* namespace [GroupDocs.Markdown](../../groupdocs.markdown)
37+
* assembly [GroupDocs.Markdown](../../)
38+
39+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: ImageFileName
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets the file name without path where the image will be saved to.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown/customimagesavingargs/imagefilename/
8+
---
9+
## CustomImageSavingArgs.ImageFileName property
10+
11+
Gets the file name (without path) where the image will be saved to.
12+
13+
```csharp
14+
public string ImageFileName { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [CustomImageSavingArgs](../../customimagesavingargs)
20+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
21+
* assembly [GroupDocs.Markdown](../../../)
22+
23+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: ImageFileNameOutput
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets the override file name without path where the image will be saved to.
5+
type: docs
6+
weight: 20
7+
url: /net/groupdocs.markdown/customimagesavingargs/imagefilenameoutput/
8+
---
9+
## CustomImageSavingArgs.ImageFileNameOutput property
10+
11+
Gets the override file name (without path) where the image will be saved to.
12+
13+
```csharp
14+
public string ImageFileNameOutput { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [CustomImageSavingArgs](../../customimagesavingargs)
20+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
21+
* assembly [GroupDocs.Markdown](../../../)
22+
23+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: OutputDirectory
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Get the Output Directory
5+
type: docs
6+
weight: 30
7+
url: /net/groupdocs.markdown/customimagesavingargs/outputdirectory/
8+
---
9+
## CustomImageSavingArgs.OutputDirectory property
10+
11+
Get the Output Directory
12+
13+
```csharp
14+
public string OutputDirectory { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [CustomImageSavingArgs](../../customimagesavingargs)
20+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
21+
* assembly [GroupDocs.Markdown](../../../)
22+
23+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: OutputStream
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets the Output Stream
5+
type: docs
6+
weight: 40
7+
url: /net/groupdocs.markdown/customimagesavingargs/outputstream/
8+
---
9+
## CustomImageSavingArgs.OutputStream property
10+
11+
Gets the Output Stream
12+
13+
```csharp
14+
public Stream OutputStream { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [CustomImageSavingArgs](../../customimagesavingargs)
20+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
21+
* assembly [GroupDocs.Markdown](../../../)
22+
23+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: SetOutputImageFileName
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Set the file name without path where the image will be saved to.
5+
type: docs
6+
weight: 60
7+
url: /net/groupdocs.markdown/customimagesavingargs/setoutputimagefilename/
8+
---
9+
## CustomImageSavingArgs.SetOutputImageFileName method
10+
11+
Set the file name (without path) where the image will be saved to.
12+
13+
```csharp
14+
public void SetOutputImageFileName(string fileName)
15+
```
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| fileName | String | File name |
20+
21+
### See Also
22+
23+
* class [CustomImageSavingArgs](../../customimagesavingargs)
24+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
25+
* assembly [GroupDocs.Markdown](../../../)
26+
27+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: SetOutputStream
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Set the Output Stream
5+
type: docs
6+
weight: 70
7+
url: /net/groupdocs.markdown/customimagesavingargs/setoutputstream/
8+
---
9+
## CustomImageSavingArgs.SetOutputStream method
10+
11+
Set the Output Stream
12+
13+
```csharp
14+
public void SetOutputStream(Stream stream)
15+
```
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| stream | Stream | Output Stream |
20+
21+
### Exceptions
22+
23+
| exception | condition |
24+
| --- | --- |
25+
| ArgumentNullException | Thrown when *stream* is null. |
26+
27+
### See Also
28+
29+
* class [CustomImageSavingArgs](../../customimagesavingargs)
30+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
31+
* assembly [GroupDocs.Markdown](../../../)
32+
33+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: ShapeType
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets the shape type.
5+
type: docs
6+
weight: 50
7+
url: /net/groupdocs.markdown/customimagesavingargs/shapetype/
8+
---
9+
## CustomImageSavingArgs.ShapeType property
10+
11+
Gets the shape type.
12+
13+
```csharp
14+
public string ShapeType { get; }
15+
```
16+
17+
### See Also
18+
19+
* class [CustomImageSavingArgs](../../customimagesavingargs)
20+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
21+
* assembly [GroupDocs.Markdown](../../../)
22+
23+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

0 commit comments

Comments
 (0)