Skip to content

Commit 3df79cc

Browse files
valentynlukianets-asposevalentynlukianets-aspose
committed
Aspose.Slides for C++ 24.9 API Reference
1 parent 4ccb4f3 commit 3df79cc

File tree

15 files changed

+311
-208
lines changed

15 files changed

+311
-208
lines changed

‎content/cpp/english/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Aspose.Slides for C++ API Reference (version 24.8)
2+
title: Aspose.Slides for C++ API Reference (version 24.9)
33
type: docs
44
weight: 12
55
url: /

‎content/cpp/english/aspose.slides.animation/effectpresetclasstype/_index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ enum class EffectPresetClassType
1919
2020
| Name | Value | Description |
2121
| --- | --- | --- |
22-
| Entrance | 0 | |
23-
| Exit | 1 | |
24-
| Emphasis | 2 | |
25-
| Path | 3 | |
26-
| MediaCall | 4 | |
27-
| OLEActionVerbs | 5 | |
22+
| Entrance | 0 | Entrance effects class.<br>Target shape types: All |
23+
| Exit | 1 | Exit effects class.<br>Target shape types: All |
24+
| Emphasis | 2 | Emphasis effects class.<br>Target shape types: All |
25+
| Path | 3 | Motion Paths class.<br>Target shape types: All |
26+
| MediaCall | 4 | Media effects class.<br>Target shape types: [IVideoFrame](../../aspose.slides/ivideoframe/), [IAudioFrame](../../aspose.slides/iaudioframe/) |
27+
| OLEActionVerbs | 5 | OLE Action Verbs class.<br>Target shape types: [IOleObjectFrame](../../aspose.slides/ioleobjectframe/) |
2828
2929
## See Also
3030

‎content/cpp/english/aspose.slides.animation/effecttype/_index.md‎

Lines changed: 157 additions & 155 deletions
Large diffs are not rendered by default.

‎content/cpp/english/aspose.slides/idocumentproperties/get_appversion/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ Returns the app version. Read-only [System::String](../../../system/string/).
1515
virtual System::String Aspose::Slides::IDocumentProperties::get_AppVersion()=0
1616
```
1717

18+
## Remarks
19+
20+
21+
The content of this element shall be in the form XX.YYYY, where X and Y represent numerical values; otherwise, the document shall be considered non-conformant. [Aspose.Slides](../../) represents its version in the format XX.YYZZ, where: XX - major version YY - minor version ZZ - patch version For example, the value 23.0105 means [Aspose.Slides](../../) version 23.1.5.
1822
## See Also
1923

2024
* Class [String](../../../system/string/)

‎content/cpp/english/aspose.slides/ipicturefillformat/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ class IPictureFillFormat : public Aspose::Slides::IFillParamSource
1919
2020
| Method | Description |
2121
| --- | --- |
22+
| virtual **bool** [CompressImage](./compressimage/)(**bool**, **float**) | Compresses the image by reducing its size based on the shape size and specified resolution. Optionally, it also deletes cropped areas. |
2223
| virtual [System::SharedPtr](../../system/sharedptr/)\<[IPPImage](../ippimage/)\> [DeletePictureCroppedAreas](./deletepicturecroppedareas/)() | Delete cropped areas of the fill [Picture](../picture/). |
2324
| virtual **bool** [Equals](../../system/object/equals/)([ptr](../../system/object/ptr/)) | Compares objects using C# [Object.Equals](../../system/object/equals/) semantics. |
2425
| static std::enable_if\<[IsSmartPtr](../../system/issmartptr/)\<T1\>::value\&&[IsSmartPtr](../../system/issmartptr/)\<T2\>::value, **bool**\>::type [Equals](../../system/object/equals/)(T1 const\&, T2 const\&) | Compares reference type objects in C# style. |

‎content/cpp/english/aspose.slides/ipicturefillformat/compressimage/_index.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: CompressImage()
3+
second_title: Aspose.Slides for C++ API Reference
4+
description: Compresses the image by reducing its size based on the shape size and specified resolution. Optionally, it also deletes cropped areas.
5+
type: docs
6+
weight: 443
7+
url: /aspose.slides/ipicturefillformat/compressimage/
8+
---
9+
## IPictureFillFormat::CompressImage(bool, float) method
10+
11+
12+
Compresses the image by reducing its size based on the shape size and specified resolution. Optionally, it also deletes cropped areas.
13+
14+
```cpp
15+
virtual bool Aspose::Slides::IPictureFillFormat::CompressImage(bool deleteCroppedAreasOfImage, float resolution)=0
16+
```
17+
18+
19+
### Arguments
20+
21+
| Parameter | Type | Description |
22+
| --- | --- | --- |
23+
| deleteCroppedAreasOfImage | **bool** | If true, the method will remove the cropped areas of the image, potentially further reducing its size. |
24+
| resolution | **float** | The target resolution in DPI. This value must be positive and defines how the image will be resized. |
25+
26+
### Return Value
27+
28+
A **bool** indicating whether the image was successfully compressed. Returns ****true****
29+
## Remarks
30+
31+
32+
This method changes the image's size and resolution similar to PowerPoint's \"Picture Format -> Compress Pictures\" feature.
33+
34+
35+
if the image was resized or cropped, otherwise ****false****
36+
37+
.
38+
39+
40+
The following example demonstrates how to use the **CompressImage** method to reduce the size of an image in a presentation by setting a target resolution and removing cropped areas:
41+
```cpp
42+
System::SharedPtr<Presentation> presentation = System::MakeObject<Presentation>(u"demo.pptx");
43+
System::SharedPtr<ISlide> slide = presentation->get_Slide(0);
44+
45+
// Gets the PictureFrame
46+
System::SharedPtr<IPictureFrame> picFrame = System::AsCast<IPictureFrame>(slide->get_Shape(0));
47+
48+
// Compress the image with a target resolution of 150 DPI (Web resolution) and remove cropped areas
49+
bool result = picFrame->get_PictureFormat()->CompressImage(true, 150.0f); // Web resolution
50+
```
51+
52+
## See Also
53+
54+
* Class [IPictureFillFormat](../)
55+
* Namespace [Aspose::Slides](../../)
56+
* Library [Aspose.Slides](../../../)

‎content/cpp/english/aspose.slides/islidetext/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ class ISlideText : public virtual System::Object
2525
| static **bool** [Equals](../../system/object/equals/)(**float** const\&, **float** const\&) | Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. |
2626
| static **bool** [Equals](../../system/object/equals/)(**double** const\&, **double** const\&) | Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. |
2727
| virtual **bool** [FastCast](../../system/object/fastcast/)(const Details::FastRttiBase\&, void **) const | For internal purposes only. |
28+
| virtual [System::String](../../system/string/) [get_CommentsText](./get_commentstext/)() | The text of the slide comments |
2829
| virtual [System::String](../../system/string/) [get_LayoutText](./get_layouttext/)() | The text on the layout page's shapes for this slide |
2930
| virtual [System::String](../../system/string/) [get_MasterText](./get_mastertext/)() | The text on the master page's shapes for this slide |
3031
| virtual [System::String](../../system/string/) [get_NotesText](./get_notestext/)() | The text on the notes page's shapes for this slide |

‎content/cpp/english/aspose.slides/islidetext/get_commentstext/_index.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: get_CommentsText()
3+
second_title: Aspose.Slides for C++ API Reference
4+
description: The text of the slide comments
5+
type: docs
6+
weight: 53
7+
url: /aspose.slides/islidetext/get_commentstext/
8+
---
9+
## ISlideText::get_CommentsText() method
10+
11+
12+
The text of the slide comments
13+
14+
```cpp
15+
virtual System::String Aspose::Slides::ISlideText::get_CommentsText()=0
16+
```
17+
18+
## Remarks
19+
20+
21+
This field is empty when the text is extracted using the Arranged mode.
22+
## See Also
23+
24+
* Class [String](../../../system/string/)
25+
* Class [ISlideText](../)
26+
* Namespace [Aspose::Slides](../../)
27+
* Library [Aspose.Slides](../../../)

‎content/cpp/english/aspose.slides/ivideocollection/_index.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ class IVideoCollection : public Aspose::Slides::IGenericCollection<System::Share
2020
| Method | Description |
2121
| --- | --- |
2222
| virtual [System::SharedPtr](../../system/sharedptr/)\<[IVideo](../ivideo/)\> [AddVideo](./addvideo/)([System::SharedPtr](../../system/sharedptr/)\<[IVideo](../ivideo/)\>) | Adds a copy of an video file from an another presentation. |
23-
| virtual [System::SharedPtr](../../system/sharedptr/)\<[IVideo](../ivideo/)\> [AddVideo](./addvideo/)([System::SharedPtr](../../system/sharedptr/)\<[System::IO::Stream](../../system.io/stream/)\>) | Creates and adds a video to a presentation from stream. |
2423
| virtual [System::SharedPtr](../../system/sharedptr/)\<[IVideo](../ivideo/)\> [AddVideo](./addvideo/)([System::SharedPtr](../../system/sharedptr/)\<[System::IO::Stream](../../system.io/stream/)\>, [LoadingStreamBehavior](../loadingstreambehavior/)) | Creates and adds a video to a presentation from stream. |
2524
| virtual [System::SharedPtr](../../system/sharedptr/)\<[IVideo](../ivideo/)\> [AddVideo](./addvideo/)([System::ArrayPtr](../../system/arrayptr/)\<**uint8_t**\>) | Creates and adds a video to a presentation from byte array. |
2625
| [iterator](../../system.collections.generic/ienumerable/iterator/) [begin](../../system.collections.generic/ienumerable/begin/)() | Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because [GetEnumerator()](../../system.collections.generic/ienumerable/getenumerator/) returns a copy-object of T. |

‎content/cpp/english/aspose.slides/ivideocollection/addvideo/_index.md‎

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -26,29 +26,6 @@ virtual System::SharedPtr<IVideo> Aspose::Slides::IVideoCollection::AddVideo(Sys
2626
2727
Added video.
2828
29-
## IVideoCollection::AddVideo(System::SharedPtr\<System::IO::Stream\>) method
30-
31-
32-
Creates and adds a video to a presentation from stream.
33-
34-
```cpp
35-
virtual System::SharedPtr<IVideo> Aspose::Slides::IVideoCollection::AddVideo(System::SharedPtr<System::IO::Stream> stream)=0
36-
```
37-
38-
39-
### Arguments
40-
41-
| Parameter | Type | Description |
42-
| --- | --- | --- |
43-
| stream | [System::SharedPtr](../../../system/sharedptr/)\<[System::IO::Stream](../../../system.io/stream/)\> | Stream to add video file from. |
44-
45-
### Return Value
46-
47-
Added [IVideo](../../ivideo/).
48-
49-
Deprecated
50-
: Use AddVideo(Stream stream, LoadingStreamBehavior loadingStreamBehavior). The method will be removed in version 17.10.
51-
5229
## IVideoCollection::AddVideo(System::SharedPtr\<System::IO::Stream\>, LoadingStreamBehavior) method
5330
5431

0 commit comments

Comments
 (0)