Skip to content

Commit c03566b

Browse files
petrtetenkopetrtetenko
committed
Aspose.Slides for Java 24.6 API references
1 parent 7a6f848 commit c03566b

File tree

12 files changed

+889
-1
lines changed

12 files changed

+889
-1
lines changed

‎content/java/english/com.aspose.slides/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,7 @@ url: /com.aspose.slides/
236236
| [GradientStopCollection](../com.aspose.slides/gradientstopcollection) | Represnts a collection of gradient stops. |
237237
| [GradientStopCollectionEffectiveData](../com.aspose.slides/gradientstopcollectioneffectivedata) | Represents a collection of GradientStopData objects. |
238238
| [GradientStopEffectiveData](../com.aspose.slides/gradientstopeffectivedata) | Immutable object which represents a gradient stop. |
239+
| [GradientStyle](../com.aspose.slides/gradientstyle) | Represents the styles available for a gradient. |
239240
| [GraphicalObject](../com.aspose.slides/graphicalobject) | Represents abstract graphical object. |
240241
| [GraphicalObjectLock](../com.aspose.slides/graphicalobjectlock) | Determines which operations are disabled on the parent GraphicalObject. |
241242
| [GrayScale](../com.aspose.slides/grayscale) | Represents a Gray Scale effect. |
@@ -580,6 +581,7 @@ url: /com.aspose.slides/
580581
| [TextFrameFormat](../com.aspose.slides/textframeformat) | Contains the TextFrame's formatTextFrameFormatting properties. |
581582
| [TextHighlightingOptions](../com.aspose.slides/texthighlightingoptions) | Represents options which can be used to highlight text in text frame. |
582583
| [TextInheritanceLimit](../com.aspose.slides/textinheritancelimit) | Controls the depth of the text properties inheritance. |
584+
| [TextSearchOptions](../com.aspose.slides/textsearchoptions) | Represents options which can be used to find text in Presentation, Slide or TextFrame. |
583585
| [TextShapeType](../com.aspose.slides/textshapetype) | Represents text wrapping shape. |
584586
| [TextStrikethroughType](../com.aspose.slides/textstrikethroughtype) | Represents the type of text strikethrough. |
585587
| [TextStyle](../com.aspose.slides/textstyle) | This class contains the text style formatting properties. |
@@ -801,6 +803,7 @@ url: /com.aspose.slides/
801803
| [IFillOverlayEffectiveData](../com.aspose.slides/ifilloverlayeffectivedata) | Immutable object which represents a Fill Overlay effect. |
802804
| [IFillParamSource](../com.aspose.slides/ifillparamsource) | Auxiliary fill parameters interface. |
803805
| [IFilterEffect](../com.aspose.slides/ifiltereffect) | Represent filter effect of behavior. |
806+
| [IFindResultCallback](../com.aspose.slides/ifindresultcallback) | Callback interface used to getting search text result. |
804807
| [IFlyThroughTransition](../com.aspose.slides/iflythroughtransition) | Fly-through slide transition effect. |
805808
| [IFontData](../com.aspose.slides/ifontdata) | Represents a font definition. |
806809
| [IFontDataFactory](../com.aspose.slides/ifontdatafactory) | FontData factory interface |
@@ -1099,6 +1102,7 @@ url: /com.aspose.slides/
10991102
| [ITextFrameFormat](../com.aspose.slides/itextframeformat) | Contains the TextFrame's formatting properties. |
11001103
| [ITextFrameFormatEffectiveData](../com.aspose.slides/itextframeformateffectivedata) | Immutable object which contains effective text frame formatting properties. |
11011104
| [ITextHighlightingOptions](../com.aspose.slides/itexthighlightingoptions) | Represents options which can be used to highlight text in text frame. |
1105+
| [ITextSearchOptions](../com.aspose.slides/itextsearchoptions) | Represents options which can be used to find text in Presentation, Slide or TextFrame. |
11021106
| [ITextStyle](../com.aspose.slides/itextstyle) | Text style formatting properties. |
11031107
| [ITextStyleEffectiveData](../com.aspose.slides/itextstyleeffectivedata) | Immutable object which contains effective text style properties. |
11041108
| [ITextToHtmlConversionOptions](../com.aspose.slides/itexttohtmlconversionoptions) | Options for extracting HTML from the Pptx text. |

‎content/java/english/com.aspose.slides/gradientstyle/_index.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: GradientStyle
3+
second_title: Aspose.Slides for Java API Reference
4+
description: Represents the styles available for a gradient.
5+
type: docs
6+
url: /com.aspose.slides/gradientstyle/
7+
---
8+
**Inheritance:**
9+
java.lang.Object, com.aspose.ms.System.ValueType, com.aspose.ms.System.Enum
10+
```
11+
public final class GradientStyle extends System.Enum
12+
```
13+
14+
Represents the styles available for a gradient. This determines the visual gradient effect applied to graphical elements.
15+
## Fields
16+
17+
| Field | Description |
18+
| --- | --- |
19+
| [Default](#Default) | The default gradient style |
20+
| [PowerPointUI](#PowerPointUI) | A gradient style as it appears in the PowerPoint UI |
21+
### Default {#Default}
22+
```
23+
public static final int Default
24+
```
25+
26+
27+
The default gradient style
28+
29+
### PowerPointUI {#PowerPointUI}
30+
```
31+
public static final int PowerPointUI
32+
```
33+
34+
35+
A gradient style as it appears in the PowerPoint UI
36+

‎content/java/english/com.aspose.slides/ifindresultcallback/_index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: IFindResultCallback
3+
second_title: Aspose.Slides for Java API Reference
4+
description: Callback interface used to getting search text result.
5+
type: docs
6+
url: /com.aspose.slides/ifindresultcallback/
7+
---```
8+
public interface IFindResultCallback
9+
```
10+
11+
Callback interface used to getting search text result.
12+
## Methods
13+
14+
| Method | Description |
15+
| --- | --- |
16+
| [foundResult(ITextFrame textFrame, String sourceText, String foundText, int textPosition)](#foundResult-com.aspose.slides.ITextFrame-java.lang.String-java.lang.String-int-) | Callback method which receives data about found text. |
17+
### foundResult(ITextFrame textFrame, String sourceText, String foundText, int textPosition) {#foundResult-com.aspose.slides.ITextFrame-java.lang.String-java.lang.String-int-}
18+
```
19+
public abstract void foundResult(ITextFrame textFrame, String sourceText, String foundText, int textPosition)
20+
```
21+
22+
23+
Callback method which receives data about found text.
24+
25+
**Parameters:**
26+
| Parameter | Type | Description |
27+
| --- | --- | --- |
28+
| textFrame | [ITextFrame](../../com.aspose.slides/itextframe) | [ITextFrame](../../com.aspose.slides/itextframe) where serching text was found. |
29+
| sourceText | java.lang.String | Source text of TextFrame where text was found. |
30+
| foundText | java.lang.String | Found text. |
31+
| textPosition | int | Position of found text in source text. |
32+

‎content/java/english/com.aspose.slides/ipresentation/_index.md

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,11 @@ Presentation document
6969
| [getImages(IRenderingOptions options, int[] slides, Dimension imageSize)](#getImages-com.aspose.slides.IRenderingOptions-int---java.awt.Dimension-) | Returns a Thumbnail Image objects for specified slides of a presentation with specified size. |
7070
| [getSlideById(long id)](#getSlideById-long-) | Returns a Slide, MasterSlide or LayoutSlide by Id. |
7171
| [joinPortionsWithSameFormatting()](#joinPortionsWithSameFormatting--) | Joins runs with same formatting in all paragraphs in all acceptable shapes in all slides. |
72+
| [highlightText(String text, Color highlightColor)](#highlightText-java.lang.String-java.awt.Color-) | Highlight all matches of sample in text frame text using specified color. |
73+
| [highlightText(String text, Color highlightColor, ITextSearchOptions options, IFindResultCallback callback)](#highlightText-java.lang.String-java.awt.Color-com.aspose.slides.ITextSearchOptions-com.aspose.slides.IFindResultCallback-) | Highlight all matches of sample text in presentation using specified color. |
74+
| [highlightRegex(Pattern regex, Color highlightColor, IFindResultCallback callback)](#highlightRegex-java.util.regex.Pattern-java.awt.Color-com.aspose.slides.IFindResultCallback-) | Highlight all matches of regular expression in presentation using specified color. |
75+
| [replaceText(String oldText, String newText, ITextSearchOptions options, IFindResultCallback callback)](#replaceText-java.lang.String-java.lang.String-com.aspose.slides.ITextSearchOptions-com.aspose.slides.IFindResultCallback-) | Replaces all occurrences of the specified text with another specified text. |
76+
| [replaceRegex(Pattern regex, String newText, IFindResultCallback callback)](#replaceRegex-java.util.regex.Pattern-java.lang.String-com.aspose.slides.IFindResultCallback-) | Replaces all matches of regular expression in presentation with specified string. |
7277
### getCurrentDateTime() {#getCurrentDateTime--}
7378
```
7479
public abstract Date getCurrentDateTime()
@@ -776,3 +781,160 @@ public abstract void joinPortionsWithSameFormatting()
776781
777782
Joins runs with same formatting in all paragraphs in all acceptable shapes in all slides.
778783
784+
### highlightText(String text, Color highlightColor) {#highlightText-java.lang.String-java.awt.Color-}
785+
```
786+
public abstract void highlightText(String text, Color highlightColor)
787+
```
788+
789+
790+
Highlight all matches of sample in text frame text using specified color.
791+
792+
--------------------
793+
794+
> ```
795+
> The following sample code shows how to Highlight Text in a PowerPoint Presentation.
796+
>
797+
> Presentation presentation = new Presentation("SomePresentation.pptx");
798+
> try {
799+
> // highlighting all separate 'the' occurrences
800+
> presentation.highlightText("the", Color.MAGENTA);
801+
> presentation.save("SomePresentation-out2.pptx", SaveFormat.Pptx);
802+
> } finally {
803+
> if (presentation != null) presentation.dispose();
804+
> }
805+
> ```
806+
807+
**Parameters:**
808+
| Parameter | Type | Description |
809+
| --- | --- | --- |
810+
| text | java.lang.String | Text sample to highlight. |
811+
| highlightColor | java.awt.Color | Highlighting color. |
812+
813+
### highlightText(String text, Color highlightColor, ITextSearchOptions options, IFindResultCallback callback) {#highlightText-java.lang.String-java.awt.Color-com.aspose.slides.ITextSearchOptions-com.aspose.slides.IFindResultCallback-}
814+
```
815+
public abstract void highlightText(String text, Color highlightColor, ITextSearchOptions options, IFindResultCallback callback)
816+
```
817+
818+
819+
Highlight all matches of sample text in presentation using specified color.
820+
821+
--------------------
822+
823+
> ```
824+
> The following sample code shows how to Highlight Text in a PowerPoint Presentation.
825+
>
826+
> Presentation presentation = new Presentation("SomePresentation.pptx");
827+
> try {
828+
> TextSearchOptions textSearchOptions = new TextSearchOptions();
829+
> textSearchOptions.setWholeWordsOnly(true);
830+
> // highlighting all separate 'the' occurrences
831+
> presentation.highlightText("the", Color.MAGENTA, textSearchOptions, null);
832+
> presentation.save("SomePresentation-out2.pptx", SaveFormat.Pptx);
833+
> } finally {
834+
> if (presentation != null) presentation.dispose();
835+
> }
836+
> ```
837+
838+
**Parameters:**
839+
| Parameter | Type | Description |
840+
| --- | --- | --- |
841+
| text | java.lang.String | Text sample to highlight. |
842+
| highlightColor | java.awt.Color | Highlighting color. |
843+
| options | [ITextSearchOptions](../../com.aspose.slides/itextsearchoptions) | Text search options [ITextSearchOptions](../../com.aspose.slides/itextsearchoptions). |
844+
| callback | [IFindResultCallback](../../com.aspose.slides/ifindresultcallback) | Callback object for saving replacement operation result [IFindResultCallback](../../com.aspose.slides/ifindresultcallback). |
845+
846+
### highlightRegex(Pattern regex, Color highlightColor, IFindResultCallback callback) {#highlightRegex-java.util.regex.Pattern-java.awt.Color-com.aspose.slides.IFindResultCallback-}
847+
```
848+
public abstract void highlightRegex(Pattern regex, Color highlightColor, IFindResultCallback callback)
849+
```
850+
851+
852+
Highlight all matches of regular expression in presentation using specified color.
853+
854+
--------------------
855+
856+
> ```
857+
> The following sample code shows how to Highlight Text using regular expression in a PowerPoint Presentation.
858+
>
859+
> Presentation presentation = new Presentation("SomePresentation.pptx");
860+
> try {
861+
> Pattern regex = Pattern.compile("\\b[^\\s]{10,}\\b");
862+
> // highlighting all words with 10 symbols or longer
863+
> presentation.highlightRegex(regex, Color.BLUE, null);
864+
> presentation.save("SomePresentation-out.pptx", SaveFormat.Pptx);
865+
> } finally {
866+
> if (presentation != null) presentation.dispose();
867+
> }
868+
> ```
869+
870+
**Parameters:**
871+
| Parameter | Type | Description |
872+
| --- | --- | --- |
873+
| regex | java.util.regex.Pattern | The regular expression java.util.regex.Pattern to get strings to be replaced. |
874+
| highlightColor | java.awt.Color | Highlighting color. |
875+
| callback | [IFindResultCallback](../../com.aspose.slides/ifindresultcallback) | Callback object for saving replacement operation result [IFindResultCallback](../../com.aspose.slides/ifindresultcallback). |
876+
877+
### replaceText(String oldText, String newText, ITextSearchOptions options, IFindResultCallback callback) {#replaceText-java.lang.String-java.lang.String-com.aspose.slides.ITextSearchOptions-com.aspose.slides.IFindResultCallback-}
878+
```
879+
public abstract void replaceText(String oldText, String newText, ITextSearchOptions options, IFindResultCallback callback)
880+
```
881+
882+
883+
Replaces all occurrences of the specified text with another specified text.
884+
885+
--------------------
886+
887+
> ```
888+
> The following sample code shows how to replace one speified string with another speified string.
889+
>
890+
> Presentation presentation = new Presentation("SomePresentation.pptx")
891+
> try {
892+
> TextSearchOptions textSearchOptions = new TextSearchOptions();
893+
> textSearchOptions.setWholeWordsOnly(true);
894+
> // Replace all separate 'the' occurrences with '***'
895+
> presentation.replaceText("the", "***", textSearchOptions, null);
896+
> presentation.save("SomePresentation-out2.pptx", SaveFormat.Pptx);
897+
> } finally {
898+
> if (presentation != null) presentation.dispose();
899+
> }
900+
> ```
901+
902+
**Parameters:**
903+
| Parameter | Type | Description |
904+
| --- | --- | --- |
905+
| oldText | java.lang.String | The string to be replaced. |
906+
| newText | java.lang.String | The string to replace all occurrences of oldText. |
907+
| options | [ITextSearchOptions](../../com.aspose.slides/itextsearchoptions) | Text search options [ITextSearchOptions](../../com.aspose.slides/itextsearchoptions). |
908+
| callback | [IFindResultCallback](../../com.aspose.slides/ifindresultcallback) | Callback object for saving replacement operation result [IFindResultCallback](../../com.aspose.slides/ifindresultcallback). |
909+
910+
### replaceRegex(Pattern regex, String newText, IFindResultCallback callback) {#replaceRegex-java.util.regex.Pattern-java.lang.String-com.aspose.slides.IFindResultCallback-}
911+
```
912+
public abstract void replaceRegex(Pattern regex, String newText, IFindResultCallback callback)
913+
```
914+
915+
916+
Replaces all matches of regular expression in presentation with specified string.
917+
918+
--------------------
919+
920+
> ```
921+
> The following sample code shows how to replace text using regular expression with specified string.
922+
>
923+
> Presentation presentation = new Presentation("SomePresentation.pptx");
924+
> try {
925+
> Pattern regex = Pattern.compile("\\b[^\\s]{10,}\\b");
926+
> // Replace all words with 10 symbols or longer with '***'
927+
> presentation.replaceRegex(regex, "***", null);
928+
> presentation.save("SomePresentation-out.pptx", SaveFormat.Pptx);
929+
> } finally {
930+
> if (presentation != null) presentation.dispose();
931+
> }
932+
> ```
933+
934+
**Parameters:**
935+
| Parameter | Type | Description |
936+
| --- | --- | --- |
937+
| regex | java.util.regex.Pattern | The regular expression java.util.regex.Pattern to get strings to be replaced. |
938+
| newText | java.lang.String | The string to replace all occurrences of strings to be replaced. |
939+
| callback | [IFindResultCallback](../../com.aspose.slides/ifindresultcallback) | Callback object for saving replacement operation result [IFindResultCallback](../../com.aspose.slides/ifindresultcallback). |
940+

‎content/java/english/com.aspose.slides/isaveoptions/_index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Options that control how a presentation is saved.
1919
| [setProgressCallback(IProgressCallback value)](#setProgressCallback-com.aspose.slides.IProgressCallback-) | Represents a callback object for saving progress updates in percentage. |
2020
| [getDefaultRegularFont()](#getDefaultRegularFont--) | Returns or sets font used in case source font is not found. |
2121
| [setDefaultRegularFont(String value)](#setDefaultRegularFont-java.lang.String-) | Returns or sets font used in case source font is not found. |
22+
| [getGradientStyle()](#getGradientStyle--) | Gets or sets the gradient style to be used for a gradient. |
23+
| [setGradientStyle(int value)](#setGradientStyle-int-) | Gets or sets the gradient style to be used for a gradient. |
2224
### getWarningCallback() {#getWarningCallback--}
2325
```
2426
public abstract IWarningCallback getWarningCallback()
@@ -126,3 +128,26 @@ Returns or sets font used in case source font is not found. Read-write String.
126128
| --- | --- | --- |
127129
| value | java.lang.String | |
128130

131+
### getGradientStyle() {#getGradientStyle--}
132+
```
133+
public abstract int getGradientStyle()
134+
```
135+
136+
137+
Gets or sets the gradient style to be used for a gradient. This property allows the selection of predefined gradient styles which can affect the appearance of graphical elements.
138+
139+
**Returns:**
140+
int
141+
### setGradientStyle(int value) {#setGradientStyle-int-}
142+
```
143+
public abstract void setGradientStyle(int value)
144+
```
145+
146+
147+
Gets or sets the gradient style to be used for a gradient. This property allows the selection of predefined gradient styles which can affect the appearance of graphical elements.
148+
149+
**Parameters:**
150+
| Parameter | Type | Description |
151+
| --- | --- | --- |
152+
| value | int | |
153+

0 commit comments

Comments
 (0)