Skip to content

Commit 73daa7a

Browse files
committed
Update content 2026-11-09 02:53:16
1 parent af09566 commit 73daa7a

80 files changed

Lines changed: 261 additions & 114 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.

‎english/net/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 10
55
url: /net/
66
description: GroupDocs.Conversion 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: "26.10"
8+
version: "26.11"
99
---
1010

1111
## Namespaces

‎english/net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public interface IDocumentsContainerLoadOptions
2020
| --- | --- |
2121
| [ConvertOwned](../../groupdocs.conversion.contracts/idocumentscontainerloadoptions/convertowned) { get; } | Option to control whether the owned documents in the documents container must be converted |
2222
| [ConvertOwner](../../groupdocs.conversion.contracts/idocumentscontainerloadoptions/convertowner) { get; } | Option to control whether the documents container itself must be converted If this property is true the documents container will be the first converted document |
23-
| [Depth](../../groupdocs.conversion.contracts/idocumentscontainerloadoptions/depth) { get; } | Option to control how many levels in depth to perform conversion |
23+
| [Depth](../../groupdocs.conversion.contracts/idocumentscontainerloadoptions/depth) { get; } | How many levels of contained documents the conversion goes down, counted from the document the conversion starts from, which is level 0: 0 or a negative value converts no contained document, 1 converts the documents it contains directly, 2 also the documents those contain, and so on. The Depth of the load options of the document the conversion starts from is the limit for the whole conversion. When the load options callback returns load options for a contained document at level L, their Depth limits the documents it contains to level L + Depth, never deeper than that limit; a contained document the callback returns no load options for keeps the limit of its container. |
2424

2525
### See Also
2626

‎english/net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/depth/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Depth
33
second_title: GroupDocs.Conversion for .NET API Reference
4-
description: Option to control how many levels in depth to perform conversion
4+
description: How many levels of contained documents the conversion goes down counted from the document the conversion starts from which is level 0 0 or a negative value converts no contained document 1 converts the documents it contains directly 2 also the documents those contain and so on. The Depth of the load options of the document the conversion starts from is the limit for the whole conversion. When the load options callback returns load options for a contained document at level L their Depth limits the documents it contains to level L Depth never deeper than that limit a contained document the callback returns no load options for keeps the limit of its container.
55
type: docs
66
weight: 30
77
url: /net/groupdocs.conversion.contracts/idocumentscontainerloadoptions/depth/
88
---
99
## IDocumentsContainerLoadOptions.Depth property
1010

11-
Option to control how many levels in depth to perform conversion
11+
How many levels of contained documents the conversion goes down, counted from the document the conversion starts from, which is level 0: 0 or a negative value converts no contained document, 1 converts the documents it contains directly, 2 also the documents those contain, and so on. The Depth of the load options of the document the conversion starts from is the limit for the whole conversion. When the load options callback returns load options for a contained document at level L, their Depth limits the documents it contains to level L + Depth, never deeper than that limit; a contained document the callback returns no load options for keeps the limit of its container.
1212

1313
```csharp
1414
public int Depth { get; }

‎english/net/groupdocs.conversion.fluent/iconversionbypagehandlersstage/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public interface IConversionByPageHandlersStage : IConversionConvertOrCompress
1919
| Name | Description |
2020
| --- | --- |
2121
| [OnConversionCompleted](../../groupdocs.conversion.fluent/iconversionbypagehandlersstage/onconversioncompleted)(Action<ConvertedPageContext>) | Registers a callback to be invoked when a page conversion completes successfully. Re-invoking replaces any previously set handler. |
22-
| [OnConversionFailed](../../groupdocs.conversion.fluent/iconversionbypagehandlersstage/onconversionfailed)(Action<ConvertedPageContext, Exception>) | Registers a callback to be invoked when a page conversion fails. Re-invoking replaces any previously set handler. |
22+
| [OnConversionFailed](../../groupdocs.conversion.fluent/iconversionbypagehandlersstage/onconversionfailed)(Action<ConvertedPageContext, Exception>) | Registers a callback to be invoked when a page conversion fails. Re-invoking replaces any previously set handler. It reports the final outcome only: a document that loads after the load options provider was asked again is not reported. |
2323

2424
### See Also
2525

‎english/net/groupdocs.conversion.fluent/iconversionbypagehandlersstage/onconversionfailed/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: OnConversionFailed
33
second_title: GroupDocs.Conversion for .NET API Reference
4-
description: Registers a callback to be invoked when a page conversion fails. Reinvoking replaces any previously set handler.
4+
description: Registers a callback to be invoked when a page conversion fails. Reinvoking replaces any previously set handler. It reports the final outcome only a document that loads after the load options provider was asked again is not reported.
55
type: docs
66
weight: 20
77
url: /net/groupdocs.conversion.fluent/iconversionbypagehandlersstage/onconversionfailed/
88
---
99
## IConversionByPageHandlersStage.OnConversionFailed method
1010

11-
Registers a callback to be invoked when a page conversion fails. Re-invoking replaces any previously set handler.
11+
Registers a callback to be invoked when a page conversion fails. Re-invoking replaces any previously set handler. It reports the final outcome only: a document that loads after the load options provider was asked again is not reported.
1212

1313
```csharp
1414
public IConversionByPageHandlersStage OnConversionFailed(

‎english/net/groupdocs.conversion.fluent/iconversionhandlersstage/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public interface IConversionHandlersStage : IConversionConvertOrCompress
1919
| Name | Description |
2020
| --- | --- |
2121
| [OnConversionCompleted](../../groupdocs.conversion.fluent/iconversionhandlersstage/onconversioncompleted)(Action<ConvertedContext>) | Registers a callback to be invoked when a document conversion completes successfully. Re-invoking replaces any previously set handler. |
22-
| [OnConversionFailed](../../groupdocs.conversion.fluent/iconversionhandlersstage/onconversionfailed)(Action<ConvertedContext, Exception>) | Registers a callback to be invoked when a document conversion fails. Re-invoking replaces any previously set handler. |
22+
| [OnConversionFailed](../../groupdocs.conversion.fluent/iconversionhandlersstage/onconversionfailed)(Action<ConvertedContext, Exception>) | Registers a callback to be invoked when a document conversion fails. Re-invoking replaces any previously set handler. It reports the final outcome only: a document that loads after the load options provider was asked again is not reported. |
2323

2424
### See Also
2525

‎english/net/groupdocs.conversion.fluent/iconversionhandlersstage/onconversionfailed/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: OnConversionFailed
33
second_title: GroupDocs.Conversion for .NET API Reference
4-
description: Registers a callback to be invoked when a document conversion fails. Reinvoking replaces any previously set handler.
4+
description: Registers a callback to be invoked when a document conversion fails. Reinvoking replaces any previously set handler. It reports the final outcome only a document that loads after the load options provider was asked again is not reported.
55
type: docs
66
weight: 20
77
url: /net/groupdocs.conversion.fluent/iconversionhandlersstage/onconversionfailed/
88
---
99
## IConversionHandlersStage.OnConversionFailed method
1010

11-
Registers a callback to be invoked when a document conversion fails. Re-invoking replaces any previously set handler.
11+
Registers a callback to be invoked when a document conversion fails. Re-invoking replaces any previously set handler. It reports the final outcome only: a document that loads after the load options provider was asked again is not reported.
1212

1313
```csharp
1414
public IConversionHandlersStage OnConversionFailed(Action<ConvertedContext, Exception> onFailed)

‎english/net/groupdocs.conversion.fluent/iconversionloadoptions/withoptions/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public IConversionSourceDocumentLoaded WithOptions(LoadOptions loadOptions)
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| loadOptions | LoadOptions | Load options |
19+
| loadOptions | LoadOptions | Load options. The same options are used for every load attempt, so a document that fails to load is not loaded again; use [`WithOptions`](../withoptions) to supply other options, such as a password, after a failed attempt. |
2020

2121
### See Also
2222

@@ -39,7 +39,7 @@ public IConversionSourceDocumentLoaded WithOptions(
3939

4040
| Parameter | Type | Description |
4141
| --- | --- | --- |
42-
| loadOptionsProvider | Func`2 | Load options provider The load options context |
42+
| loadOptionsProvider | Func`2 | Load options provider. It is called once for every document that is loaded, the source document and every contained document, and [`SourceFormat`](../../../groupdocs.conversion/loadcontext/sourceformat) reports the document's format: the format its name gives, or the format its content shows when the name gives no known format or names an XML or HTML document. A format stated in the returned load options is the format the document is loaded as. When the load then fails because the document needs a password, the password is wrong, its content is damaged or its format cannot be read, the provider is called once more for that document, with [`Attempt`](../../../groupdocs.conversion/loadcontext/attempt) 2, the failure in [`LoadFailure`](../../../groupdocs.conversion/loadcontext/loadfailure) and a copy of the options that failed in [`FailedLoadOptions`](../../../groupdocs.conversion/loadcontext/failedloadoptions): options that differ from the failed ones load the document again, and `null` or equal options keep the failure. An archive entry that cannot be extracted is asked the same way, with no [`SourceStream`](../../../groupdocs.conversion/loadcontext/sourcestream) and a copy of the archive's options; a password returned in [`IPasswordLoadOptions`](../../../groupdocs.conversion.options.load/ipasswordloadoptions) extracts that entry again. The failure handlers report only the final outcome. |
4343

4444
### See Also
4545

‎english/net/groupdocs.conversion.options.load/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ The namespace provides classes to specify additional options for document loadin
7676
| [IMetadataLoadOptions](./imetadataloadoptions) | Options to control metadata in the converted document. |
7777
| [IPageLayoutOptions](./ipagelayoutoptions) | Options to control page layout scaling when loading documents. |
7878
| [IPageNumberingLoadOptions](./ipagenumberingloadoptions) | Options to control page numbering in the converted document. |
79+
| [IPasswordLoadOptions](./ipasswordloadoptions) | Represents load options that carry the password a protected document is opened with. |
7980
| [IResourceLoadingOptions](./iresourceloadingoptions) | Represents the options that control which external resources a document may load. |
8081

8182
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.conversion.dll -->

‎english/net/groupdocs.conversion.options.load/cadloadoptions/layoutnames/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public string[] LayoutNames { get; set; }
1616

1717
### Remarks
1818

19-
Not honoured when converting to PDF/UA-1. That target renders the drawing as a single tagged page, which cannot carry one sheet per selected layout, so the whole drawing is converted instead and nothing here applies to it. Every other target, PDF included, honours the selection. On those targets, names are matched exactly against the layouts the drawing carries, so a name that differs only in case is a different name. A name that matches nothing is dropped and costs the caller only that sheet; a list in which nothing matches fails the conversion with an [`InvalidLoadOptionsException`](../../../groupdocs.conversion.exceptions/invalidloadoptionsexception) naming the names that missed and the layouts the drawing does carry, rather than rendering sheets the caller did not ask for. A drawing that carries no layouts at all is exempt: there is nothing for a name to match, so none is refused.
19+
Not honoured when converting to PDF/UA-1. That target renders the drawing as a single tagged page, which cannot carry one sheet per selected layout, so the whole drawing is converted instead and nothing here applies to it. Every other target, PDF included, honours the selection. On those targets, names are matched exactly against the layouts the drawing carries, so a name that differs only in case is a different name. A name that matches nothing is dropped and costs the caller only that sheet; a list in which nothing matches fails the conversion with an [`InvalidLoadOptionsException`](../../../groupdocs.conversion.exceptions/invalidloadoptionsexception) naming the names that missed and the layouts the drawing does carry, rather than rendering sheets the caller did not ask for. A drawing that carries no layouts at all is exempt: there is nothing for a name to match, so none is refused. The list is checked when the drawing is loaded for its conversion. When nothing matches, the load options delegate is asked once more for that drawing, with that exception as [`LoadFailure`](../../../groupdocs.conversion/loadcontext/loadfailure); options with names that match load and convert it, and otherwise the conversion fails as described.
2020

2121
### See Also
2222

0 commit comments

Comments
 (0)