Skip to content

Commit 2259b49

Browse files
petrtetenkopetrtetenko
committed
Aspose.Slides for Android 24.9 API references
1 parent 6dc38f6 commit 2259b49

File tree

10 files changed

+131
-654
lines changed

10 files changed

+131
-654
lines changed

‎content/androidjava/english/com.aspose.slides/effecttype/_index.md

Lines changed: 20 additions & 610 deletions
Large diffs are not rendered by default.

‎content/androidjava/english/com.aspose.slides/idocumentproperties/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ public abstract String getAppVersion()
8484

8585
Returns the app version. Read-only String.
8686

87+
--------------------
88+
89+
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.YY.ZZ, where: XX - major version YY - minor version ZZ - patch version For example, the value 23.0105 means Aspose.Slides version 23.1.5.
90+
8791
**Returns:**
8892
java.lang.String
8993
### getNameOfApplication() {#getNameOfApplication--}

‎content/androidjava/english/com.aspose.slides/ifontsmanager/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ Retrieves the byte array representing the font data for a specified font style a
278278
**Parameters:**
279279
| Parameter | Type | Description |
280280
| --- | --- | --- |
281-
| fontData | [IFontData](../../com.aspose.slides/ifontdata) | The font data object containing the information about the font [FontData](../../com.aspose.slides/fontdata). |
281+
| fontData | [IFontData](../../com.aspose.slides/ifontdata) | The font data object containing the information about the font [IFontData](../../com.aspose.slides/ifontdata). |
282282
| fontStyle | int | The style of the font for which the data is to be retrieved [FontStyle](../../com.aspose.slides/fontstyle). |
283283

284284
**Returns:**

‎content/androidjava/english/com.aspose.slides/ipicturefillformat/_index.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Represents a picture fill style.
3838
| [getStretchOffsetBottom()](#getStretchOffsetBottom--) | Returns or sets bottom edge of the fill rectangle that is defined by a percentage offset from the bottom edge of the shape's bounding box. |
3939
| [setStretchOffsetBottom(float value)](#setStretchOffsetBottom-float-) | Returns or sets bottom edge of the fill rectangle that is defined by a percentage offset from the bottom edge of the shape's bounding box. |
4040
| [deletePictureCroppedAreas()](#deletePictureCroppedAreas--) | Delete cropped areas of the fill Picture. |
41+
| [compressImage(boolean deleteCroppedAreasOfImage, float resolution)](#compressImage-boolean-float-) | Compresses the image by reducing its size based on the shape size and specified resolution. |
4142
| [getTileOffsetX()](#getTileOffsetX--) | Returns or sets the horizontal offset of the texture from the shape's origin in points. |
4243
| [setTileOffsetX(float value)](#setTileOffsetX-float-) | Returns or sets the horizontal offset of the texture from the shape's origin in points. |
4344
| [getTileOffsetY()](#getTileOffsetY--) | Returns or sets the vertical offset of the texture from the shape's origin in points. |
@@ -319,6 +320,45 @@ Delete cropped areas of the fill Picture.
319320
--------------------
320321
321322
This method converts WMF/EMF metafiles to raster PNG image while cropping.
323+
### compressImage(boolean deleteCroppedAreasOfImage, float resolution) {#compressImage-boolean-float-}
324+
```
325+
public abstract boolean compressImage(boolean deleteCroppedAreasOfImage, float resolution)
326+
```
327+
328+
329+
Compresses the image by reducing its size based on the shape size and specified resolution. Optionally, it also deletes cropped areas.
330+
331+
--------------------
332+
333+
> ```
334+
> The following example demonstrates how to use the ```
335+
> CompressImage
336+
> ``` method to reduce the size of an image in a presentation by setting a target resolution and removing cropped areas:
337+
>
338+
> Presentation presentation = new Presentation("demo.pptx");
339+
> try {
340+
> ISlide slide = presentation.getSlides().get_Item(0);
341+
> // Gets the PictureFrame
342+
> IPictureFrame picFrame = (IPictureFrame)slide.getShapes().get_Item(0);
343+
> // Compress the image with a target resolution of 150 DPI (Web resolution) and remove cropped areas
344+
> boolean result = picFrame.getPictureFormat().compressImage(true, 150f); // Web resolution
345+
> } finally {
346+
> if (presentation != null) presentation.dispose();
347+
> }
348+
> ```
349+
350+
**Parameters:**
351+
| Parameter | Type | Description |
352+
| --- | --- | --- |
353+
| deleteCroppedAreasOfImage | boolean | If true, the method will remove the cropped areas of the image, potentially further reducing its size. |
354+
| resolution | float | The target resolution in DPI. This value must be positive and defines how the image will be resized.
355+
356+
--------------------
357+
358+
This method changes the image's size and resolution similar to PowerPoint's "Picture Format -> Compress Pictures" feature. |
359+
360+
**Returns:**
361+
boolean - A boolean indicating whether the image was successfully compressed. Returns true if the image was resized or cropped, otherwise false.
322362
### getTileOffsetX() {#getTileOffsetX--}
323363
```
324364
public abstract float getTileOffsetX()
@@ -618,7 +658,7 @@ public abstract int getTileFlip()
618658
```
619659
620660
621-
Flips the texture tile around its horizontal, vertical or both axis. Read/write TileFlip (\#getTileFlip.getTileFlip/\#setTileFlip(int).setTileFlip(int)).
661+
Flips the texture tile around its horizontal, vertical or both axis. Read/write [TileFlip](../../com.aspose.slides/tileflip).
622662
623663
--------------------
624664
@@ -649,7 +689,7 @@ public abstract void setTileFlip(int value)
649689
```
650690
651691
652-
Flips the texture tile around its horizontal, vertical or both axis. Read/write TileFlip (\#getTileFlip.getTileFlip/\#setTileFlip(int).setTileFlip(int)).
692+
Flips the texture tile around its horizontal, vertical or both axis. Read/write [TileFlip](../../com.aspose.slides/tileflip).
653693
654694
--------------------
655695

‎content/androidjava/english/com.aspose.slides/islidetext/_index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Represents the text extracted from the slide
1717
| [getMasterText()](#getMasterText--) | The text on the master page's shapes for this slide |
1818
| [getLayoutText()](#getLayoutText--) | The text on the layout page's shapes for this slide |
1919
| [getNotesText()](#getNotesText--) | The text on the notes page's shapes for this slide |
20+
| [getCommentsText()](#getCommentsText--) | The text of the slide comments |
2021
### getText() {#getText--}
2122
```
2223
public abstract String getText()
@@ -57,3 +58,17 @@ The text on the notes page's shapes for this slide
5758

5859
**Returns:**
5960
java.lang.String
61+
### getCommentsText() {#getCommentsText--}
62+
```
63+
public abstract String getCommentsText()
64+
```
65+
66+
67+
The text of the slide comments
68+
69+
--------------------
70+
71+
This field is empty when the text is extracted using the Arranged mode.
72+
73+
**Returns:**
74+
java.lang.String

‎content/androidjava/english/com.aspose.slides/ivideocollection/_index.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Represents a collection of Video objects.
1818
| --- | --- |
1919
| [get_Item(int index)](#get-Item-int-) | Gets the element at the specified index. |
2020
| [addVideo(IVideo video)](#addVideo-com.aspose.slides.IVideo-) | Adds a copy of an video file from an another presentation. |
21-
| [addVideo(InputStream stream)](#addVideo-java.io.InputStream-) | Creates and adds a video to a presentation from stream. |
2221
| [addVideo(InputStream stream, int loadingStreamBehavior)](#addVideo-java.io.InputStream-int-) | Creates and adds a video to a presentation from stream. |
2322
| [addVideo(byte[] videoData)](#addVideo-byte---) | Creates and adds a video to a presentation from byte array. |
2423
### get_Item(int index) {#get-Item-int-}
@@ -51,21 +50,6 @@ Adds a copy of an video file from an another presentation.
5150

5251
**Returns:**
5352
[IVideo](../../com.aspose.slides/ivideo) - Added video.
54-
### addVideo(InputStream stream) {#addVideo-java.io.InputStream-}
55-
```
56-
public abstract IVideo addVideo(InputStream stream)
57-
```
58-
59-
60-
Creates and adds a video to a presentation from stream.
61-
62-
**Parameters:**
63-
| Parameter | Type | Description |
64-
| --- | --- | --- |
65-
| stream | java.io.InputStream | Stream to add video file from. |
66-
67-
**Returns:**
68-
[IVideo](../../com.aspose.slides/ivideo) - Added [IVideo](../../com.aspose.slides/ivideo).
6953
### addVideo(InputStream stream, int loadingStreamBehavior) {#addVideo-java.io.InputStream-int-}
7054
```
7155
public abstract IVideo addVideo(InputStream stream, int loadingStreamBehavior)

‎content/androidjava/english/com.aspose.slides/masterslidecollection/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Removes unused master slides.
9797
**Parameters:**
9898
| Parameter | Type | Description |
9999
| --- | --- | --- |
100-
| ignorePreserveField | boolean | Determines, whether this method should remove unused master even if its ([MasterSlide.getPreserve](../../com.aspose.slides/masterslide\#getPreserve)/[MasterSlide.setPreserve(boolean)](../../com.aspose.slides/masterslide\#setPreserve-boolean-)) property is set to true. |
100+
| ignorePreserveField | boolean | Determines, whether this method should remove unused master even if its [MasterSlide.getPreserve](../../com.aspose.slides/masterslide\#getPreserve)/[MasterSlide.setPreserve(boolean)](../../com.aspose.slides/masterslide\#setPreserve-boolean-) property is set to true. |
101101

102102
### addClone(IMasterSlide sourceMaster) {#addClone-com.aspose.slides.IMasterSlide-}
103103
```

‎content/androidjava/english/com.aspose.slides/picturefillformat/_index.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Represents a picture fill style.
3434
| [getCropBottom()](#getCropBottom--) | Returns or sets the number of percents of real image height that are cropped off the bottom of the picture. |
3535
| [setCropBottom(float value)](#setCropBottom-float-) | Returns or sets the number of percents of real image height that are cropped off the bottom of the picture. |
3636
| [deletePictureCroppedAreas()](#deletePictureCroppedAreas--) | Delete cropped areas of the fill Picture. |
37+
| [compressImage(boolean deleteCroppedAreasOfImage, float resolution)](#compressImage-boolean-float-) | Compresses the image by reducing its size based on the shape size and specified resolution. |
3738
| [getStretchOffsetLeft()](#getStretchOffsetLeft--) | Returns or sets left edge of the fill rectangle that is defined by a percentage offset from the left edge of the shape's bounding box. |
3839
| [setStretchOffsetLeft(float value)](#setStretchOffsetLeft-float-) | Returns or sets left edge of the fill rectangle that is defined by a percentage offset from the left edge of the shape's bounding box. |
3940
| [getStretchOffsetTop()](#getStretchOffsetTop--) | Returns or sets top edge of the fill rectangle that is defined by a percentage offset from the top edge of the shape's bounding box. |
@@ -241,6 +242,45 @@ Delete cropped areas of the fill Picture.
241242
--------------------
242243
243244
This method converts WMF/EMF metafiles to raster PNG image while cropping.
245+
### compressImage(boolean deleteCroppedAreasOfImage, float resolution) {#compressImage-boolean-float-}
246+
```
247+
public final boolean compressImage(boolean deleteCroppedAreasOfImage, float resolution)
248+
```
249+
250+
251+
Compresses the image by reducing its size based on the shape size and specified resolution. Optionally, it also deletes cropped areas.
252+
253+
--------------------
254+
255+
> ```
256+
> The following example demonstrates how to use the ```
257+
> CompressImage
258+
> ``` method to reduce the size of an image in a presentation by setting a target resolution and removing cropped areas:
259+
>
260+
> Presentation presentation = new Presentation("demo.pptx");
261+
> try {
262+
> ISlide slide = presentation.getSlides().get_Item(0);
263+
> // Gets the PictureFrame
264+
> IPictureFrame picFrame = (IPictureFrame)slide.getShapes().get_Item(0);
265+
> // Compress the image with a target resolution of 150 DPI (Web resolution) and remove cropped areas
266+
> boolean result = picFrame.getPictureFormat().compressImage(true, 150f); // Web resolution
267+
> } finally {
268+
> if (presentation != null) presentation.dispose();
269+
> }
270+
> ```
271+
272+
**Parameters:**
273+
| Parameter | Type | Description |
274+
| --- | --- | --- |
275+
| deleteCroppedAreasOfImage | boolean | If true, the method will remove the cropped areas of the image, potentially further reducing its size. |
276+
| resolution | float | The target resolution in DPI. This value must be positive and defines how the image will be resized.
277+
278+
--------------------
279+
280+
This method changes the image's size and resolution similar to PowerPoint's "Picture Format -> Compress Pictures" feature. |
281+
282+
**Returns:**
283+
boolean - A boolean indicating whether the image was successfully compressed. Returns if the image was resized or cropped, otherwise .
244284
### getStretchOffsetLeft() {#getStretchOffsetLeft--}
245285
```
246286
public final float getStretchOffsetLeft()
@@ -632,7 +672,7 @@ public final int getTileFlip()
632672
```
633673
634674
635-
Flips the texture tile around its horizontal, vertical or both axis. Read/write TileFlip (\#getTileFlip.getTileFlip/\#setTileFlip(int).setTileFlip(int)).
675+
Flips the texture tile around its horizontal, vertical or both axis. Read/write [TileFlip](../../com.aspose.slides/tileflip).
636676
637677
--------------------
638678
@@ -663,7 +703,7 @@ public final void setTileFlip(int value)
663703
```
664704
665705
666-
Flips the texture tile around its horizontal, vertical or both axis. Read/write TileFlip (\#getTileFlip.getTileFlip/\#setTileFlip(int).setTileFlip(int)).
706+
Flips the texture tile around its horizontal, vertical or both axis. Read/write [TileFlip](../../com.aspose.slides/tileflip).
667707
668708
--------------------
669709

‎content/androidjava/english/com.aspose.slides/shape/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Adds a new placeholder if there is no and sets placeholder properties to a speci
169169
| placeholderToCopyFrom | [IPlaceholder](../../com.aspose.slides/iplaceholder) | Placeholder to copy content from. |
170170
171171
**Returns:**
172-
[IPlaceholder](../../com.aspose.slides/iplaceholder) - New [Placeholder](../../com.aspose.slides/placeholder)(\#getPlaceholder.getPlaceholder).
172+
[IPlaceholder](../../com.aspose.slides/iplaceholder) - New \#getPlaceholder.getPlaceholder.
173173
### getBasePlaceholder() {#getBasePlaceholder--}
174174
```
175175
public final IShape getBasePlaceholder()
@@ -811,7 +811,7 @@ public final long getUniqueId()
811811
```
812812
813813
814-
Gets unique shape identifier in presentation scope. Read-only long. See also (\#getOfficeInteropShapeId.getOfficeInteropShapeId) for getting unique shape identifier in slide scope.
814+
Gets unique shape identifier in presentation scope. Read-only long. See also \#getOfficeInteropShapeId.getOfficeInteropShapeId for getting unique shape identifier in slide scope.
815815
816816
**Returns:**
817817
long
@@ -821,7 +821,7 @@ public final long getOfficeInteropShapeId()
821821
```
822822
823823
824-
Gets unique shape identifier in slide scope. Read-only long. See also (\#getUniqueId.getUniqueId) for getting unique shape identifier in presentation scope.
824+
Gets unique shape identifier in slide scope. Read-only long. See also \#getUniqueId.getUniqueId for getting unique shape identifier in presentation scope.
825825
826826
**Returns:**
827827
long
@@ -955,11 +955,11 @@ public final boolean isGrouped()
955955
```
956956
957957
958-
Determines whether the shape is grouped. Read-only boolean .
958+
Determines whether the shape is grouped. Read-only boolean.
959959
960960
--------------------
961961
962-
Property (\#getParentGroup.getParentGroup) returns parent GroupShape object if shape is grouped.
962+
Property \#getParentGroup.getParentGroup returns parent GroupShape object if shape is grouped.
963963
964964
**Returns:**
965965
boolean
@@ -973,7 +973,7 @@ Returns parent GroupShape object if shape is grouped. Otherwise returns null. Re
973973
974974
--------------------
975975
976-
Property (\#isGrouped.isGrouped) determines whether the shape is grouped.
976+
Property \#isGrouped.isGrouped determines whether the shape is grouped.
977977
978978
**Returns:**
979979
[IGroupShape](../../com.aspose.slides/igroupshape)

‎content/androidjava/english/com.aspose.slides/videocollection/_index.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ Represents a collection of Video objects.
2222
| [size()](#size--) | Returns a number of video files in the collection. |
2323
| [get_Item(int index)](#get-Item-int-) | Gets the element at the specified index. |
2424
| [addVideo(IVideo video)](#addVideo-com.aspose.slides.IVideo-) | Adds a copy of an video file from an another presentation. |
25-
| [addVideo(InputStream stream)](#addVideo-java.io.InputStream-) | Creates and adds a video to a presentation from stream. |
2625
| [addVideo(InputStream stream, int loadingStreamBehavior)](#addVideo-java.io.InputStream-int-) | Creates and adds a video to a presentation from stream. |
2726
| [addVideo(byte[] videoData)](#addVideo-byte---) | Creates and adds a video to a presentation from byte array. |
2827
| [copyTo(System.Array array, int index)](#copyTo-com.aspose.ms.System.Array-int-) | Copies videos to specified array starting from specified index. |
@@ -70,21 +69,6 @@ Adds a copy of an video file from an another presentation.
7069

7170
**Returns:**
7271
[IVideo](../../com.aspose.slides/ivideo) - Added video.
73-
### addVideo(InputStream stream) {#addVideo-java.io.InputStream-}
74-
```
75-
public final IVideo addVideo(InputStream stream)
76-
```
77-
78-
79-
Creates and adds a video to a presentation from stream.
80-
81-
**Parameters:**
82-
| Parameter | Type | Description |
83-
| --- | --- | --- |
84-
| stream | java.io.InputStream | Stream to add video file from. |
85-
86-
**Returns:**
87-
[IVideo](../../com.aspose.slides/ivideo) - Added [Video](../../com.aspose.slides/video).
8872
### addVideo(InputStream stream, int loadingStreamBehavior) {#addVideo-java.io.InputStream-int-}
8973
```
9074
public final IVideo addVideo(InputStream stream, int loadingStreamBehavior)

0 commit comments

Comments
 (0)