Skip to content

Commit 23bb545

Browse files
petrtetenkopetrtetenko
committed
Aspose.Slides for Android 24.12 API references
1 parent 6b7d7db commit 23bb545

File tree

26 files changed

+605
-125
lines changed

26 files changed

+605
-125
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ url: /com.aspose.slides/
163163
| [DocumentProperties](../com.aspose.slides/documentproperties) | Represents properties of a presentation. |
164164
| [DomObject<TParent>](../com.aspose.slides/domobject) | Base DOM object |
165165
| [DoubleChartValue](../com.aspose.slides/doublechartvalue) | Represent double value which can be stored in pptx presentation document in two ways: 1) in cell/cells of workbook related to chart; 2) as literal value. |
166+
| [DrawingGuide](../com.aspose.slides/drawingguide) | Represents an adjustable drawing guide. |
167+
| [DrawingGuidesCollection](../com.aspose.slides/drawingguidescollection) | Represents a collection of the adjustable drawing guides. |
166168
| [Duotone](../com.aspose.slides/duotone) | Represents a Duotone effect. |
167169
| [Effect](../com.aspose.slides/effect) | Represents animation effect. |
168170
| [EffectChartMajorGroupingType](../com.aspose.slides/effectchartmajorgroupingtype) | Represents the type of an animation effect for chart's element. |
@@ -775,6 +777,8 @@ url: /com.aspose.slides/
775777
| [IDigitalSignatureCollection](../com.aspose.slides/idigitalsignaturecollection) | Represents a collection of digital signatures attached to a document. |
776778
| [IDocumentProperties](../com.aspose.slides/idocumentproperties) | Represents properties of a presentation. |
777779
| [IDoubleChartValue](../com.aspose.slides/idoublechartvalue) | Represent double value which can be stored in pptx presentation document in two ways: 1) in cell/cells of workbook related to chart; 2) as literal value. |
780+
| [IDrawingGuide](../com.aspose.slides/idrawingguide) | Represents an adjustable drawing guide. |
781+
| [IDrawingGuidesCollection](../com.aspose.slides/idrawingguidescollection) | Represents a collection of the adjustable drawing guides. |
778782
| [IDuotone](../com.aspose.slides/iduotone) | Represents a Duotone effect. |
779783
| [IDuotoneEffectiveData](../com.aspose.slides/iduotoneeffectivedata) | Immutable object which represents a Duotone effect. |
780784
| [IEffect](../com.aspose.slides/ieffect) | Represents animation effect. |

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Represents common slide view properties.
4040
| [setScale(int value)](#setScale-int-) | Specifies the view scaling ratio in percentages. |
4141
| [getVariableScale()](#getVariableScale--) | Specifies that the view content should automatically scale to best fit the current window size. |
4242
| [setVariableScale(boolean value)](#setVariableScale-boolean-) | Specifies that the view content should automatically scale to best fit the current window size. |
43+
| [getDrawingGuides()](#getDrawingGuides--) | Returns the collection of the drawing guides. |
4344
### getScale() {#getScale--}
4445
```
4546
public final int getScale()
@@ -86,3 +87,34 @@ Specifies that the view content should automatically scale to best fit the curre
8687
| --- | --- | --- |
8788
| value | boolean | |
8889
90+
### getDrawingGuides() {#getDrawingGuides--}
91+
```
92+
public final IDrawingGuidesCollection getDrawingGuides()
93+
```
94+
95+
96+
Returns the collection of the drawing guides. Read-only [IDrawingGuidesCollection](../../com.aspose.slides/idrawingguidescollection)
97+
98+
--------------------
99+
100+
> ```
101+
> The following sample code shows how to add the new drawing guides in a PowerPoint presentation.
102+
>
103+
> Presentation pres = new Presentation();
104+
> try {
105+
> SizeF slideSize = pres.getSlideSize().getSize();
106+
>
107+
> IDrawingGuidesCollection guides = pres.getViewProperties().getSlideViewProperties().getDrawingGuides();
108+
> // Adding the new vertical drawing guide to the right of the slide center
109+
> guides.add(Orientation.Vertical, (float)(slideSize.getWidth()) / 2 + 12.5f);
110+
> // Adding the new horizontal drawing guide below the slide center
111+
> guides.add(Orientation.Horizontal, (float)(slideSize.getHeight() / 2) + 12.5f);
112+
>
113+
> pres.save("DrawingGuides_out.pptx", SaveFormat.Pptx);
114+
> } finally {
115+
> if (pres != null) pres.dispose();
116+
> }
117+
> ```
118+
119+
**Returns:**
120+
[IDrawingGuidesCollection](../../com.aspose.slides/idrawingguidescollection)

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: DrawingGuide
3+
second_title: Aspose.Slides for Android via Java API Reference
4+
description: Represents an adjustable drawing guide.
5+
type: docs
6+
url: /com.aspose.slides/drawingguide/
7+
---
8+
**Inheritance:**
9+
java.lang.Object
10+
11+
**All Implemented Interfaces:**
12+
[com.aspose.slides.IDrawingGuide](../../com.aspose.slides/idrawingguide)
13+
```
14+
public final class DrawingGuide implements IDrawingGuide
15+
```
16+
17+
Represents an adjustable drawing guide.
18+
## Methods
19+
20+
| Method | Description |
21+
| --- | --- |
22+
| [getOrientation()](#getOrientation--) | Returns or sets orientation of the drawing guide. |
23+
| [setOrientation(byte value)](#setOrientation-byte-) | Returns or sets orientation of the drawing guide. |
24+
| [getPosition()](#getPosition--) | Returns or sets position of the drawing guide in points from the top, left corner of the slide. |
25+
| [setPosition(float value)](#setPosition-float-) | Returns or sets position of the drawing guide in points from the top, left corner of the slide. |
26+
### getOrientation() {#getOrientation--}
27+
```
28+
public final byte getOrientation()
29+
```
30+
31+
32+
Returns or sets orientation of the drawing guide. Read/write [Orientation](../../com.aspose.slides/orientation).
33+
34+
**Returns:**
35+
byte
36+
### setOrientation(byte value) {#setOrientation-byte-}
37+
```
38+
public final void setOrientation(byte value)
39+
```
40+
41+
42+
Returns or sets orientation of the drawing guide. Read/write [Orientation](../../com.aspose.slides/orientation).
43+
44+
**Parameters:**
45+
| Parameter | Type | Description |
46+
| --- | --- | --- |
47+
| value | byte | |
48+
49+
### getPosition() {#getPosition--}
50+
```
51+
public final float getPosition()
52+
```
53+
54+
55+
Returns or sets position of the drawing guide in points from the top, left corner of the slide. Read/write float.
56+
57+
--------------------
58+
59+
The typical value range is from zero to slide height for a horizontal guide and from zero to slide width for a vertical guide.
60+
61+
**Returns:**
62+
float
63+
### setPosition(float value) {#setPosition-float-}
64+
```
65+
public final void setPosition(float value)
66+
```
67+
68+
69+
Returns or sets position of the drawing guide in points from the top, left corner of the slide. Read/write float.
70+
71+
--------------------
72+
73+
The typical value range is from zero to slide height for a horizontal guide and from zero to slide width for a vertical guide.
74+
75+
**Parameters:**
76+
| Parameter | Type | Description |
77+
| --- | --- | --- |
78+
| value | float | |
79+

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

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
title: DrawingGuidesCollection
3+
second_title: Aspose.Slides for Android via Java API Reference
4+
description: Represents a collection of the adjustable drawing guides.
5+
type: docs
6+
url: /com.aspose.slides/drawingguidescollection/
7+
---
8+
**Inheritance:**
9+
java.lang.Object
10+
11+
**All Implemented Interfaces:**
12+
[com.aspose.slides.IDrawingGuidesCollection](../../com.aspose.slides/idrawingguidescollection)
13+
```
14+
public final class DrawingGuidesCollection implements IDrawingGuidesCollection
15+
```
16+
17+
Represents a collection of the adjustable drawing guides.
18+
## Methods
19+
20+
| Method | Description |
21+
| --- | --- |
22+
| [get_Item(int index)](#get-Item-int-) | Returns the drawing guide by index. |
23+
| [add(byte orientation, float position)](#add-byte-float-) | Adds the drawing guide at the end of the collection. |
24+
| [removeAt(int index)](#removeAt-int-) | Removes the drawing guide at the specified index. |
25+
| [clear()](#clear--) | Removes all elements from the collection. |
26+
| [iterator()](#iterator--) | Returns an enumerator that iterates through the collection. |
27+
| [iteratorJava()](#iteratorJava--) | Returns a java iterator for the entire collection. |
28+
| [getCount()](#getCount--) | Returns the number of elements in the collection. |
29+
| [copyTo(IDrawingGuide[] array, int index)](#copyTo-com.aspose.slides.IDrawingGuide---int-) | Copies all elements from the collection to the specified array. |
30+
### get_Item(int index) {#get-Item-int-}
31+
```
32+
public final IDrawingGuide get_Item(int index)
33+
```
34+
35+
36+
Returns the drawing guide by index. Read-only [IDrawingGuide](../../com.aspose.slides/idrawingguide).
37+
38+
**Parameters:**
39+
| Parameter | Type | Description |
40+
| --- | --- | --- |
41+
| index | int | |
42+
43+
**Returns:**
44+
[IDrawingGuide](../../com.aspose.slides/idrawingguide)
45+
### add(byte orientation, float position) {#add-byte-float-}
46+
```
47+
public final IDrawingGuide add(byte orientation, float position)
48+
```
49+
50+
51+
Adds the drawing guide at the end of the collection.
52+
53+
**Parameters:**
54+
| Parameter | Type | Description |
55+
| --- | --- | --- |
56+
| orientation | byte | Orientation of the drawing guide. |
57+
| position | float | Position of the the drawing guide in points. |
58+
59+
**Returns:**
60+
[IDrawingGuide](../../com.aspose.slides/idrawingguide)
61+
### removeAt(int index) {#removeAt-int-}
62+
```
63+
public final void removeAt(int index)
64+
```
65+
66+
67+
Removes the drawing guide at the specified index.
68+
69+
**Parameters:**
70+
| Parameter | Type | Description |
71+
| --- | --- | --- |
72+
| index | int | Index of the drawing guide that should be deleted. |
73+
74+
### clear() {#clear--}
75+
```
76+
public final void clear()
77+
```
78+
79+
80+
Removes all elements from the collection.
81+
82+
### iterator() {#iterator--}
83+
```
84+
public final System.Collections.Generic.IGenericEnumerator<IDrawingGuide> iterator()
85+
```
86+
87+
88+
Returns an enumerator that iterates through the collection.
89+
90+
**Returns:**
91+
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.slides.IDrawingGuide> - A IGenericEnumerator that can be used to iterate through the collection.
92+
### iteratorJava() {#iteratorJava--}
93+
```
94+
public final System.Collections.Generic.IGenericEnumerator<IDrawingGuide> iteratorJava()
95+
```
96+
97+
98+
Returns a java iterator for the entire collection.
99+
100+
**Returns:**
101+
com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.slides.IDrawingGuide> - An java.util.Iterator for the entire collection.
102+
### getCount() {#getCount--}
103+
```
104+
public final int getCount()
105+
```
106+
107+
108+
Returns the number of elements in the collection. Read-only int.
109+
110+
**Returns:**
111+
int
112+
### copyTo(IDrawingGuide[] array, int index) {#copyTo-com.aspose.slides.IDrawingGuide---int-}
113+
```
114+
public final void copyTo(IDrawingGuide[] array, int index)
115+
```
116+
117+
118+
Copies all elements from the collection to the specified array.
119+
120+
**Parameters:**
121+
| Parameter | Type | Description |
122+
| --- | --- | --- |
123+
| array | [IDrawingGuide\[\]](../../com.aspose.slides/idrawingguide) | Target array. |
124+
| index | int | Starting index in the target array. |
125+

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Represents subtypes of animation effect.
2222
| [BottomLeft](#BottomLeft) | |
2323
| [BottomRight](#BottomRight) | |
2424
| [Center](#Center) | |
25+
| [ObjectCenter](#ObjectCenter) | |
26+
| [SlideCenter](#SlideCenter) | |
2527
| [Clockwise](#Clockwise) | |
2628
| [CounterClockwise](#CounterClockwise) | |
2729
| [GradualAndCycleClockwise](#GradualAndCycleClockwise) | |
@@ -114,6 +116,22 @@ public static final int Center
114116

115117

116118

119+
### ObjectCenter {#ObjectCenter}
120+
```
121+
public static final int ObjectCenter
122+
```
123+
124+
125+
126+
127+
### SlideCenter {#SlideCenter}
128+
```
129+
public static final int SlideCenter
130+
```
131+
132+
133+
134+
117135
### Clockwise {#Clockwise}
118136
```
119137
public static final int Clockwise

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Gets or sets frame size.
6767
6868
--------------------
6969
70-
If the size is empty then the value will be taken from ([IPresentation.getSlideSize](../../com.aspose.slides/ipresentation\#getSlideSize))
70+
If the size is empty then the value will be taken from [IPresentation.getSlideSize](../../com.aspose.slides/ipresentation\#getSlideSize)
7171
7272
**Returns:**
7373
[Size](../../com.aspose.slides.android/size)
@@ -81,7 +81,7 @@ Gets or sets frame size.
8181
8282
--------------------
8383
84-
If the size is empty then the value will be taken from ([IPresentation.getSlideSize](../../com.aspose.slides/ipresentation\#getSlideSize))
84+
If the size is empty then the value will be taken from [IPresentation.getSlideSize](../../com.aspose.slides/ipresentation\#getSlideSize)
8585
8686
**Parameters:**
8787
| Parameter | Type | Description |
@@ -192,7 +192,7 @@ public final int getDefaultDelay()
192192
```
193193
194194
195-
Gets or sets default delay time [ms]. This value will be used if ([ISlideShowTransition.getAdvanceAfterTime](../../com.aspose.slides/islideshowtransition\#getAdvanceAfterTime)/[ISlideShowTransition.setAdvanceAfterTime(long)](../../com.aspose.slides/islideshowtransition\#setAdvanceAfterTime-long-)) is not set. The default value is 1000.
195+
Gets or sets default delay time [ms]. This value will be used if [ISlideShowTransition.getAdvanceAfterTime](../../com.aspose.slides/islideshowtransition\#getAdvanceAfterTime)/[ISlideShowTransition.setAdvanceAfterTime(long)](../../com.aspose.slides/islideshowtransition\#setAdvanceAfterTime-long-) is not set. The default value is 1000.
196196
197197
--------------------
198198
@@ -215,7 +215,7 @@ public final void setDefaultDelay(int value)
215215
```
216216
217217
218-
Gets or sets default delay time [ms]. This value will be used if ([ISlideShowTransition.getAdvanceAfterTime](../../com.aspose.slides/islideshowtransition\#getAdvanceAfterTime)/[ISlideShowTransition.setAdvanceAfterTime(long)](../../com.aspose.slides/islideshowtransition\#setAdvanceAfterTime-long-)) is not set. The default value is 1000.
218+
Gets or sets default delay time [ms]. This value will be used if [ISlideShowTransition.getAdvanceAfterTime](../../com.aspose.slides/islideshowtransition\#getAdvanceAfterTime)/[ISlideShowTransition.setAdvanceAfterTime(long)](../../com.aspose.slides/islideshowtransition\#setAdvanceAfterTime-long-) is not set. The default value is 1000.
219219
220220
--------------------
221221

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

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ Represents a HTML exporting options.
2828
| [getSlidesLayoutOptions()](#getSlidesLayoutOptions--) | Gets or sets the mode in which slides are placed on the page when exporting a presentation [ISlidesLayoutOptions](../../com.aspose.slides/islideslayoutoptions). |
2929
| [setSlidesLayoutOptions(ISlidesLayoutOptions value)](#setSlidesLayoutOptions-com.aspose.slides.ISlidesLayoutOptions-) | Gets or sets the mode in which slides are placed on the page when exporting a presentation [ISlidesLayoutOptions](../../com.aspose.slides/islideslayoutoptions). |
3030
| [getInkOptions()](#getInkOptions--) | Provides options that control the look of Ink objects in exported document. |
31-
| [getNotesCommentsLayouting()](#getNotesCommentsLayouting--) | Provides options that control how notes and comments is placed in exported document. |
3231
| [getShowHiddenSlides()](#getShowHiddenSlides--) | Specifies whether the generated document should include hidden slides or not. |
3332
| [setShowHiddenSlides(boolean value)](#setShowHiddenSlides-boolean-) | Specifies whether the generated document should include hidden slides or not. |
3433
| [getHtmlFormatter()](#getHtmlFormatter--) | Returns or sets HTML template. |
@@ -133,16 +132,6 @@ Provides options that control the look of Ink objects in exported document. Read
133132
134133
**Returns:**
135134
[IInkOptions](../../com.aspose.slides/iinkoptions)
136-
### getNotesCommentsLayouting() {#getNotesCommentsLayouting--}
137-
```
138-
public final INotesCommentsLayoutingOptions getNotesCommentsLayouting()
139-
```
140-
141-
142-
Provides options that control how notes and comments is placed in exported document.
143-
144-
**Returns:**
145-
[INotesCommentsLayoutingOptions](../../com.aspose.slides/inotescommentslayoutingoptions)
146135
### getShowHiddenSlides() {#getShowHiddenSlides--}
147136
```
148137
public final boolean getShowHiddenSlides()

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Represents an AutoShape.
1717
| Method | Description |
1818
| --- | --- |
1919
| [getAutoShapeLock()](#getAutoShapeLock--) | Returns AutoShape's locks. |
20-
| [getTextFrame()](#getTextFrame--) | Returns TextFrameEx object for the AutoShapeEx. |
20+
| [getTextFrame()](#getTextFrame--) | Returns TextFrame object for the AutoShape. |
2121
| [getUseBackgroundFill()](#getUseBackgroundFill--) | Determines whether this autoshape should be filled with slide's background fill instead of specified by style or fill format. |
2222
| [setUseBackgroundFill(boolean value)](#setUseBackgroundFill-boolean-) | Determines whether this autoshape should be filled with slide's background fill instead of specified by style or fill format. |
23-
| [addTextFrame(String text)](#addTextFrame-java.lang.String-) | Adds a new TextFrameEx to a shape. |
23+
| [addTextFrame(String text)](#addTextFrame-java.lang.String-) | Adds a new TextFrame to a shape. |
2424
| [isTextBox()](#isTextBox--) | Specifies if the shape is a text box. |
2525
### getAutoShapeLock() {#getAutoShapeLock--}
2626
```
@@ -38,7 +38,7 @@ public abstract ITextFrame getTextFrame()
3838
```
3939

4040

41-
Returns TextFrameEx object for the AutoShapeEx. Read-only [ITextFrame](../../com.aspose.slides/itextframe).
41+
Returns TextFrame object for the AutoShape. Read-only [ITextFrame](../../com.aspose.slides/itextframe).
4242

4343
**Returns:**
4444
[ITextFrame](../../com.aspose.slides/itextframe)
@@ -71,7 +71,7 @@ public abstract ITextFrame addTextFrame(String text)
7171
```
7272

7373

74-
Adds a new TextFrameEx to a shape. If shape already has TextFrameEx then simply changes its text.
74+
Adds a new TextFrame to a shape. If shape already has TextFrame then simply changes its text.
7575

7676
**Parameters:**
7777
| Parameter | Type | Description |

0 commit comments

Comments
 (0)