Skip to content

Commit 4e0cc5c

Browse files
aspose-evgeny-vasilevaspose-evgeny-vasilev
committed
Update API Reference for Aspose.Words for C++ 25.6
1 parent e4ef896 commit 4e0cc5c

File tree

24 files changed

+444
-109
lines changed

24 files changed

+444
-109
lines changed

‎english/cpp/aspose.words.saving/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ The **Aspose.Words.Saving** namespace provides classes and enumerations that all
3030
| [ImageSavingArgs](./imagesavingargs/) | Provides data for the [ImageSaving()](./iimagesavingcallback/imagesaving/) event. To learn more, visit the [Save a Document](https://docs.aspose.com/words/cpp/save-a-document/) documentation article. |
3131
| [MarkdownSaveOptions](./markdownsaveoptions/) | Class to specify additional options when saving a document into the [Markdown](../aspose.words/saveformat/) format. To learn more, visit the [Specify Save Options](https://docs.aspose.com/words/cpp/specify-save-options/) documentation article. |
3232
| [MetafileRenderingOptions](./metafilerenderingoptions/) | Allows to specify additional metafile rendering options. To learn more, visit the [Handling Windows Metafiles](https://docs.aspose.com/words/cpp/handling-windows-metafiles/) documentation article. |
33+
| [MultiPageLayout](./multipagelayout/) | Defines a layout for rendering multiple pages into a single output. |
3334
| [OdtSaveOptions](./odtsaveoptions/) | Can be used to specify additional options when saving a document into the [Odt](../aspose.words/saveformat/) or [Ott](../aspose.words/saveformat/) format. To learn more, visit the [Specify Save Options](https://docs.aspose.com/words/cpp/specify-save-options/) documentation article. |
3435
| [OoxmlSaveOptions](./ooxmlsaveoptions/) | Can be used to specify additional options when saving a document into the [Docx](../aspose.words/saveformat/), [Docm](../aspose.words/saveformat/), [Dotx](../aspose.words/saveformat/), [Dotm](../aspose.words/saveformat/) or [FlatOpc](../aspose.words/saveformat/) format. To learn more, visit the [Specify Save Options](https://docs.aspose.com/words/cpp/specify-save-options/) documentation article. |
3536
| [OutlineOptions](./outlineoptions/) | Allows to specify outline options. To learn more, visit the [Save a Document](https://docs.aspose.com/words/cpp/save-a-document/) documentation article. |

‎english/cpp/aspose.words.saving/imagesaveoptions/_index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ class ImageSaveOptions : public Aspose::Words::Saving::FixedPageSaveOptions
4646
| [get_MetafileRenderingOptions](../fixedpagesaveoptions/get_metafilerenderingoptions/)() const | Allows to specify metafile rendering options. |
4747
| [get_NumeralFormat](../fixedpagesaveoptions/get_numeralformat/)() const | Gets or sets [NumeralFormat](../numeralformat/) used for rendering of numerals. European numerals are used by default. |
4848
| virtual [get_OptimizeOutput](../fixedpagesaveoptions/get_optimizeoutput/)() | Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to **true**. Default is **false**. |
49+
| [get_PageLayout](./get_pagelayout/)() const | Gets or sets the layout used when rendering multiple pages into a single output. |
4950
| [get_PageSavingCallback](../fixedpagesaveoptions/get_pagesavingcallback/)() const | Allows to control how separate pages are saved when a document is exported to fixed page format. |
5051
| [get_PageSet](./get_pageset/)() | Gets or sets the pages to render. Default is all the pages in the document. |
5152
| [get_PageSet](../fixedpagesaveoptions/get_pageset/)() const | Gets or sets the pages to render. Default is all the pages in the document. |
@@ -91,6 +92,7 @@ class ImageSaveOptions : public Aspose::Words::Saving::FixedPageSaveOptions
9192
| [set_MetafileRenderingOptions](../fixedpagesaveoptions/set_metafilerenderingoptions/)(const System::SharedPtr\<Aspose::Words::Saving::MetafileRenderingOptions\>\&) | Setter for [Aspose::Words::Saving::FixedPageSaveOptions::get_MetafileRenderingOptions](../fixedpagesaveoptions/get_metafilerenderingoptions/). |
9293
| [set_NumeralFormat](../fixedpagesaveoptions/set_numeralformat/)(Aspose::Words::Saving::NumeralFormat) | Setter for [Aspose::Words::Saving::FixedPageSaveOptions::get_NumeralFormat](../fixedpagesaveoptions/get_numeralformat/). |
9394
| virtual [set_OptimizeOutput](../fixedpagesaveoptions/set_optimizeoutput/)(bool) | Setter for [Aspose::Words::Saving::FixedPageSaveOptions::get_OptimizeOutput](../fixedpagesaveoptions/get_optimizeoutput/). |
95+
| [set_PageLayout](./set_pagelayout/)(const System::SharedPtr\<Aspose::Words::Saving::MultiPageLayout\>\&) | Setter for [Aspose::Words::Saving::ImageSaveOptions::get_PageLayout](./get_pagelayout/). |
9496
| [set_PageSavingCallback](../fixedpagesaveoptions/set_pagesavingcallback/)(const System::SharedPtr\<Aspose::Words::Saving::IPageSavingCallback\>\&) | Setter for [Aspose::Words::Saving::FixedPageSaveOptions::get_PageSavingCallback](../fixedpagesaveoptions/get_pagesavingcallback/). |
9597
| [set_PageSet](./set_pageset/)(const System::SharedPtr\<Aspose::Words::Saving::PageSet\>\&) | Setter for [Aspose::Words::Saving::ImageSaveOptions::get_PageSet](./get_pageset/). |
9698
| [set_PaperColor](./set_papercolor/)(System::Drawing::Color) | Setter for [Aspose::Words::Saving::ImageSaveOptions::get_PaperColor](./get_papercolor/). |

‎english/cpp/aspose.words.saving/imagesaveoptions/get_pagelayout/_index.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Aspose::Words::Saving::ImageSaveOptions::get_PageLayout method
3+
linktitle: get_PageLayout
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'Aspose::Words::Saving::ImageSaveOptions::get_PageLayout method. Gets or sets the layout used when rendering multiple pages into a single output in C++.'
6+
type: docs
7+
weight: 9500
8+
url: /cpp/aspose.words.saving/imagesaveoptions/get_pagelayout/
9+
---
10+
## ImageSaveOptions::get_PageLayout method
11+
12+
13+
Gets or sets the layout used when rendering multiple pages into a single output.
14+
15+
```cpp
16+
System::SharedPtr<Aspose::Words::Saving::MultiPageLayout> Aspose::Words::Saving::ImageSaveOptions::get_PageLayout() const
17+
```
18+
19+
## Remarks
20+
21+
22+
Use one of the factory methods of [MultiPageLayout](../../multipagelayout/) to configure this property.
23+
24+
For [Tiff](../../../aspose.words/saveformat/) the default value is [TiffFrames](../../multipagelayout/tiffframes/). For other formats the default value is [SinglePage](../../multipagelayout/singlepage/).
25+
26+
This property has effect only when saving to the following formats: [Jpeg](../../../aspose.words/saveformat/), [Gif](../../../aspose.words/saveformat/), [Png](../../../aspose.words/saveformat/), [Bmp](../../../aspose.words/saveformat/), [Tiff](../../../aspose.words/saveformat/), [WebP](../)
27+
## See Also
28+
29+
* Class [MultiPageLayout](../../multipagelayout/)
30+
* Class [ImageSaveOptions](../)
31+
* Namespace [Aspose::Words::Saving](../../)
32+
* Library [Aspose.Words for C++](../../../)

‎english/cpp/aspose.words.saving/imagesaveoptions/set_pagelayout/_index.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Aspose::Words::Saving::ImageSaveOptions::set_PageLayout method
3+
linktitle: set_PageLayout
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'Aspose::Words::Saving::ImageSaveOptions::set_PageLayout method. Setter for Aspose::Words::Saving::ImageSaveOptions::get_PageLayout in C++.'
6+
type: docs
7+
weight: 26500
8+
url: /cpp/aspose.words.saving/imagesaveoptions/set_pagelayout/
9+
---
10+
## ImageSaveOptions::set_PageLayout method
11+
12+
13+
Setter for [Aspose::Words::Saving::ImageSaveOptions::get_PageLayout](../get_pagelayout/).
14+
15+
```cpp
16+
void Aspose::Words::Saving::ImageSaveOptions::set_PageLayout(const System::SharedPtr<Aspose::Words::Saving::MultiPageLayout> &value)
17+
```
18+
19+
## See Also
20+
21+
* Class [MultiPageLayout](../../multipagelayout/)
22+
* Class [ImageSaveOptions](../)
23+
* Namespace [Aspose::Words::Saving](../../)
24+
* Library [Aspose.Words for C++](../../../)

‎english/cpp/aspose.words.saving/multipagelayout/_index.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Aspose::Words::Saving::MultiPageLayout class
3+
linktitle: MultiPageLayout
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'Aspose::Words::Saving::MultiPageLayout class. Defines a layout for rendering multiple pages into a single output in C++.'
6+
type: docs
7+
weight: 14500
8+
url: /cpp/aspose.words.saving/multipagelayout/
9+
---
10+
## MultiPageLayout class
11+
12+
13+
Defines a layout for rendering multiple pages into a single output.
14+
15+
```cpp
16+
class MultiPageLayout : public System::Object
17+
```
18+
19+
## Methods
20+
21+
| Method | Description |
22+
| --- | --- |
23+
| [get_BackColor](./get_backcolor/)() | Gets the background color of the output. The default is **Empty**. |
24+
| [get_BorderColor](./get_bordercolor/)() | Gets the color of the pages border. The default is **Empty**. |
25+
| [get_BorderWidth](./get_borderwidth/)() const | Gets the width of the pages border. The default is 0. |
26+
| [GetType](./gettype/)() const override | |
27+
| static [Grid](./grid/)(int32_t, float, float) | Creates a layout in which pages are rendered left-to-right, top-to-bottom, in a grid with the specified number of columns. |
28+
| static [Horizontal](./horizontal/)(float) | Creates a layout in which all specified pages are rendered horizontally side by side, left to right, in a single output. |
29+
| [Is](./is/)(const System::TypeInfo\&) const override | |
30+
| [set_BackColor](./set_backcolor/)(System::Drawing::Color) | Sets the background color of the output. The default is **Empty**. |
31+
| [set_BorderColor](./set_bordercolor/)(System::Drawing::Color) | Sets the color of the pages border. The default is **Empty**. |
32+
| [set_BorderWidth](./set_borderwidth/)(float) | Sets the width of the pages border. The default is 0. |
33+
| static [SinglePage](./singlepage/)() | Creates a layout that renders only the first of specified pages. |
34+
| static [TiffFrames](./tiffframes/)() | Creates a layout where each page is rendered as a separate frame in a multi-frame TIFF image. Applicable only to TIFF image formats. |
35+
| static [Type](./type/)() | |
36+
| static [Vertical](./vertical/)(float) | Creates a layout where all specified pages are rendered vertically one below the other in a single output. |
37+
## See Also
38+
39+
* Namespace [Aspose::Words::Saving](../)
40+
* Library [Aspose.Words for C++](../../)

‎english/cpp/aspose.words.saving/multipagelayout/get_backcolor/_index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Aspose::Words::Saving::MultiPageLayout::get_BackColor method
3+
linktitle: get_BackColor
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'Aspose::Words::Saving::MultiPageLayout::get_BackColor method. Gets the background color of the output. The default is Empty in C++.'
6+
type: docs
7+
weight: 7000
8+
url: /cpp/aspose.words.saving/multipagelayout/get_backcolor/
9+
---
10+
## MultiPageLayout::get_BackColor method
11+
12+
13+
Gets the background color of the output. The default is **Empty**.
14+
15+
```cpp
16+
System::Drawing::Color Aspose::Words::Saving::MultiPageLayout::get_BackColor()
17+
```
18+
19+
## See Also
20+
21+
* Class [MultiPageLayout](../)
22+
* Namespace [Aspose::Words::Saving](../../)
23+
* Library [Aspose.Words for C++](../../../)

‎english/cpp/aspose.words.saving/multipagelayout/get_bordercolor/_index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Aspose::Words::Saving::MultiPageLayout::get_BorderColor method
3+
linktitle: get_BorderColor
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'Aspose::Words::Saving::MultiPageLayout::get_BorderColor method. Gets the color of the pages border. The default is Empty in C++.'
6+
type: docs
7+
weight: 8000
8+
url: /cpp/aspose.words.saving/multipagelayout/get_bordercolor/
9+
---
10+
## MultiPageLayout::get_BorderColor method
11+
12+
13+
Gets the color of the pages border. The default is **Empty**.
14+
15+
```cpp
16+
System::Drawing::Color Aspose::Words::Saving::MultiPageLayout::get_BorderColor()
17+
```
18+
19+
## See Also
20+
21+
* Class [MultiPageLayout](../)
22+
* Namespace [Aspose::Words::Saving](../../)
23+
* Library [Aspose.Words for C++](../../../)

‎english/cpp/aspose.words.saving/multipagelayout/get_borderwidth/_index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Aspose::Words::Saving::MultiPageLayout::get_BorderWidth method
3+
linktitle: get_BorderWidth
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'Aspose::Words::Saving::MultiPageLayout::get_BorderWidth method. Gets the width of the pages border. The default is 0 in C++.'
6+
type: docs
7+
weight: 9000
8+
url: /cpp/aspose.words.saving/multipagelayout/get_borderwidth/
9+
---
10+
## MultiPageLayout::get_BorderWidth method
11+
12+
13+
Gets the width of the pages border. The default is 0.
14+
15+
```cpp
16+
float Aspose::Words::Saving::MultiPageLayout::get_BorderWidth() const
17+
```
18+
19+
## See Also
20+
21+
* Class [MultiPageLayout](../)
22+
* Namespace [Aspose::Words::Saving](../../)
23+
* Library [Aspose.Words for C++](../../../)

‎english/cpp/aspose.words.saving/multipagelayout/gettype/_index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Aspose::Words::Saving::MultiPageLayout::GetType method
3+
linktitle: GetType
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'How to use GetType method of Aspose::Words::Saving::MultiPageLayout class in C++.'
6+
type: docs
7+
weight: 10000
8+
url: /cpp/aspose.words.saving/multipagelayout/gettype/
9+
---
10+
## MultiPageLayout::GetType method
11+
12+
13+
14+
15+
```cpp
16+
virtual const System::TypeInfo & Aspose::Words::Saving::MultiPageLayout::GetType() const override
17+
```
18+
19+
## See Also
20+
21+
* Class [MultiPageLayout](../)
22+
* Namespace [Aspose::Words::Saving](../../)
23+
* Library [Aspose.Words for C++](../../../)

‎english/cpp/aspose.words.saving/multipagelayout/grid/_index.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Aspose::Words::Saving::MultiPageLayout::Grid method
3+
linktitle: Grid
4+
second_title: Aspose.Words for C++ API Reference
5+
description: 'Aspose::Words::Saving::MultiPageLayout::Grid method. Creates a layout in which pages are rendered left-to-right, top-to-bottom, in a grid with the specified number of columns in C++.'
6+
type: docs
7+
weight: 1000
8+
url: /cpp/aspose.words.saving/multipagelayout/grid/
9+
---
10+
## MultiPageLayout::Grid method
11+
12+
13+
Creates a layout in which pages are rendered left-to-right, top-to-bottom, in a grid with the specified number of columns.
14+
15+
```cpp
16+
static System::SharedPtr<Aspose::Words::Saving::MultiPageLayout> Aspose::Words::Saving::MultiPageLayout::Grid(int32_t columns, float horizontalGap, float verticalGap)
17+
```
18+
19+
20+
| Parameter | Type | Description |
21+
| --- | --- | --- |
22+
| columns | int32_t | The number of columns in the layout. Must be greater than zero. |
23+
| horizontalGap | float | The horizontal gap between columns in points. |
24+
| verticalGap | float | The vertical gap between rows in points. |
25+
26+
## See Also
27+
28+
* Class [MultiPageLayout](../)
29+
* Class [MultiPageLayout](../)
30+
* Namespace [Aspose::Words::Saving](../../)
31+
* Library [Aspose.Words for C++](../../../)

0 commit comments

Comments
 (0)