Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Java API reference to v.23.10. #39

Merged
merged 2 commits into from
Oct 19, 2023
Merged

Updated Java API reference to v.23.10. #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dad9c9d
Merge pull request #37 from aspose-tasks/python-23.10-api
achevyrov-aspose Oct 18, 2023
71adbfe
Updated Java API reference to v.23.10.
VadimYurko Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions english/java/com.aspose.tasks/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,7 @@ url: /java/com.aspose.tasks/
| [SaveOptions](../com.aspose.tasks/saveoptions) | This is an abstract base class for classes that allow the user to specify additional options when saving a project into a particular format. |
| [SaveTemplateOptions](../com.aspose.tasks/savetemplateoptions) | Allows to specify additional options when saving a project as a template. |
| [Shape](../com.aspose.tasks/shape) | Shape of a marker at the beginning or end of the bar style to be rendered when saving view data to some of [SaveFileFormat](../com.aspose.tasks/savefileformat). |
| [SimpleSaveOptions](../com.aspose.tasks/simplesaveoptions) | This is an abstract base class that allow the user to specify basic options when saving a project into a particular format. |
| [SplitPart](../com.aspose.tasks/splitpart) | Represents a task portion. |
| [SplitPartCollection](../com.aspose.tasks/splitpartcollection) | Collection that represents the portions of a task. |
| [Spreadsheet2003SaveOptions](../com.aspose.tasks/spreadsheet2003saveoptions) | Allows to specify additional options when rendering project pages to Spreadsheet2003. |
Expand Down
18 changes: 0 additions & 18 deletions english/java/com.aspose.tasks/asn/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,8 @@ Represents properties of [ResourceAssignment](../../com.aspose.tasks/resourceass
| [HYPERLINK_ADDRESS](#HYPERLINK-ADDRESS) | The address for a hyperlink associated with assignment. |
| [HYPERLINK_SUB_ADDRESS](#HYPERLINK-SUB-ADDRESS) | The specific location in a document in a hyperlink associated with an assignment. |
| [LEVELING_DELAY](#LEVELING-DELAY) | The delay caused by leveling. |
| [LEVELING_DELAY_FORMAT](#LEVELING-DELAY-FORMAT) | The duration format of a delay. |
| [LINKED_FIELDS](#LINKED-FIELDS) | Determines whether the Project is linked to another OLE object. |
| [MILESTONE](#MILESTONE) | Determines whether the assignment is a milestone. |
| [NOTES](#NOTES) | The text notes associated with an assignment. |
| [NOTES_RTF](#NOTES-RTF) | The text notes in RTF format. |
| [NOTES_TEXT](#NOTES-TEXT) | Notes' plain text extracted from RTF data. |
| [OVERALLOCATED](#OVERALLOCATED) | Determines whether the assignment is over-allocated. |
Expand Down Expand Up @@ -338,14 +336,6 @@ public static final Key<Duration,Byte> LEVELING_DELAY

The delay caused by leveling.

### LEVELING_DELAY_FORMAT {#LEVELING-DELAY-FORMAT}
```
public static final Key<Byte,Byte> LEVELING_DELAY_FORMAT
```


The duration format of a delay.

### LINKED_FIELDS {#LINKED-FIELDS}
```
public static final Key<Boolean,Byte> LINKED_FIELDS
Expand All @@ -362,14 +352,6 @@ public static final Key<Boolean,Byte> MILESTONE

Determines whether the assignment is a milestone.

### NOTES {#NOTES}
```
public static final Key<String,Byte> NOTES
```


The text notes associated with an assignment.

### NOTES_RTF {#NOTES-RTF}
```
public static final Key<String,Byte> NOTES_RTF
Expand Down
9 changes: 0 additions & 9 deletions english/java/com.aspose.tasks/asnkey/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ Represents a list of supported assignment fields.
| [HyperlinkAddress](#HyperlinkAddress) | Represents the HyperlinkAddress (ResourceAssignment) field. |
| [HyperlinkSubAddress](#HyperlinkSubAddress) | Represents the HyperlinkSubAddress (ResourceAssignment) field. |
| [LevelingDelay](#LevelingDelay) | Represents the LevelingDelay (ResourceAssignment) field. |
| [LevelingDelayFormat](#LevelingDelayFormat) | Represents the LevelingDelayFormat (ResourceAssignment) field. |
| [LinkedFields](#LinkedFields) | Represents the LinkedFields (ResourceAssignment) field. |
| [Milestone](#Milestone) | Represents the Milestone (ResourceAssignment) field. |
| [Notes](#Notes) | Represents the Notes (ResourceAssignment) field. |
Expand Down Expand Up @@ -341,14 +340,6 @@ public static final byte LevelingDelay

Represents the LevelingDelay (ResourceAssignment) field.

### LevelingDelayFormat {#LevelingDelayFormat}
```
public static final byte LevelingDelayFormat
```


Represents the LevelingDelayFormat (ResourceAssignment) field.

### LinkedFields {#LinkedFields}
```
public static final byte LinkedFields
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/assignmenttocolumntextconverter/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: AssignmentToColumnTextConverter
second_title: Aspose.Tasks for Java API Reference
description: ResourceAssignment data to columns string converter.
type: docs
weight: 349
weight: 350
url: /java/com.aspose.tasks/assignmenttocolumntextconverter/
---
```
Expand Down
29 changes: 27 additions & 2 deletions english/java/com.aspose.tasks/csvoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ url: /java/com.aspose.tasks/csvoptions/
---

**Inheritance:**
java.lang.Object, [com.aspose.tasks.SaveOptions](../../com.aspose.tasks/saveoptions)
java.lang.Object, [com.aspose.tasks.SimpleSaveOptions](../../com.aspose.tasks/simplesaveoptions)
```
public class CsvOptions extends SaveOptions
public class CsvOptions extends SimpleSaveOptions
```

Allows to specify additional options when saving project to CSV.
Expand All @@ -27,10 +27,12 @@ Allows to specify additional options when saving project to CSV.
| [getEncoding()](#getEncoding--) | Gets an encoding to save CSV with. |
| [getIncludeHeaders()](#getIncludeHeaders--) | Gets a value indicating whether to include headers or not (default value is TRUE). |
| [getTextDelimiter()](#getTextDelimiter--) | Gets a text delimiter. |
| [getView()](#getView--) | Gets a list of the view columns ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)) to save to XLSX format. |
| [setDataCategory(int value)](#setDataCategory-int-) | Sets a data category to be saved. |
| [setEncoding(Charset value)](#setEncoding-java.nio.charset.Charset-) | Sets an encoding to save CSV with. |
| [setIncludeHeaders(boolean value)](#setIncludeHeaders-boolean-) | Sets a value indicating whether to include headers or not (default value is TRUE). |
| [setTextDelimiter(int value)](#setTextDelimiter-int-) | Sets a text delimiter. |
| [setView(ProjectView value)](#setView-com.aspose.tasks.ProjectView-) | Sets a list of the view columns ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)) to save to XLSX format. |
### CsvOptions() {#CsvOptions--}
```
public CsvOptions()
Expand Down Expand Up @@ -79,6 +81,16 @@ Gets a text delimiter.

**Returns:**
int - a text delimiter.
### getView() {#getView--}
```
public final ProjectView getView()
```


Gets a list of the view columns ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)) to save to XLSX format. If not set then default columns are saved.

**Returns:**
[ProjectView](../../com.aspose.tasks/projectview) - a list of the view columns ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)) to save to XLSX format.
### setDataCategory(int value) {#setDataCategory-int-}
```
public final void setDataCategory(int value)
Expand Down Expand Up @@ -131,3 +143,16 @@ Sets a text delimiter.
| --- | --- | --- |
| value | int | a text delimiter. |

### setView(ProjectView value) {#setView-com.aspose.tasks.ProjectView-}
```
public final void setView(ProjectView value)
```


Sets a list of the view columns ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)) to save to XLSX format. If not set then default columns are saved.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [ProjectView](../../com.aspose.tasks/projectview) | a list of the view columns ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)) to save to XLSX format. |

2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/event/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Event
second_title: Aspose.Tasks for Java API Reference
description: An event.
type: docs
weight: 350
weight: 351
url: /java/com.aspose.tasks/event/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/htmlsaveoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ url: /java/com.aspose.tasks/htmlsaveoptions/
---

**Inheritance:**
java.lang.Object, [com.aspose.tasks.SaveOptions](../../com.aspose.tasks/saveoptions)
java.lang.Object, [com.aspose.tasks.SimpleSaveOptions](../../com.aspose.tasks/simplesaveoptions), [com.aspose.tasks.SaveOptions](../../com.aspose.tasks/saveoptions)

**All Implemented Interfaces:**
com.aspose.tasks.SaveOptions.IReduceBottomGap, com.aspose.tasks.SaveOptions.IFontCallbacks, com.aspose.tasks.ICloneableSaveOptions
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/ialgorithm/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IAlgorithm
second_title: Aspose.Tasks for Java API Reference
description: Represents an algorithm that can be applied to a list of objects T.
type: docs
weight: 351
weight: 352
url: /java/com.aspose.tasks/ialgorithm/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/icondition/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ICondition
second_title: Aspose.Tasks for Java API Reference
description: Represents a condition which can be used by filters or search methods.
type: docs
weight: 352
weight: 353
url: /java/com.aspose.tasks/icondition/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/icsssavingcallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ICssSavingCallback
second_title: Aspose.Tasks for Java API Reference
description: Represents a callback that is called to create resource to store CSS.
type: docs
weight: 353
weight: 354
url: /java/com.aspose.tasks/icsssavingcallback/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/ifontsavingcallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IFontSavingCallback
second_title: Aspose.Tasks for Java API Reference
description: Represents a callback that is called to create resource to store fonts.
type: docs
weight: 354
weight: 355
url: /java/com.aspose.tasks/ifontsavingcallback/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/iimagesavingcallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IImageSavingCallback
second_title: Aspose.Tasks for Java API Reference
description: Represents a callback that is called to create resource to store images.
type: docs
weight: 355
weight: 356
url: /java/com.aspose.tasks/iimagesavingcallback/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/imagesaveoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ url: /java/com.aspose.tasks/imagesaveoptions/
---

**Inheritance:**
java.lang.Object, [com.aspose.tasks.SaveOptions](../../com.aspose.tasks/saveoptions)
java.lang.Object, [com.aspose.tasks.SimpleSaveOptions](../../com.aspose.tasks/simplesaveoptions), [com.aspose.tasks.SaveOptions](../../com.aspose.tasks/saveoptions)

**All Implemented Interfaces:**
com.aspose.tasks.SaveOptions.IReduceBottomGap, com.aspose.tasks.SaveOptions.IFontCallbacks, com.aspose.tasks.ICloneableSaveOptions
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/ipagesavingcallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IPageSavingCallback
second_title: Aspose.Tasks for Java API Reference
description: Represents a callback that is called when each page in multi page document is saved to a separate stream.
type: docs
weight: 356
weight: 357
url: /java/com.aspose.tasks/ipagesavingcallback/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/itextstylemodificationcallback/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ITextStyleModificationCallback
second_title: Aspose.Tasks for Java API Reference
description: Represents a callback that is called before TextStyle is applied to a table cell.
type: docs
weight: 357
weight: 358
url: /java/com.aspose.tasks/itextstylemodificationcallback/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/itreealgorithm/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ITreeAlgorithm
second_title: Aspose.Tasks for Java API Reference
description: Represents an algorithm that can be applied to a tree of objects T.
type: docs
weight: 358
weight: 359
url: /java/com.aspose.tasks/itreealgorithm/
---
```
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/ivbamodule/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IVbaModule
second_title: Aspose.Tasks for Java API Reference
description: Represents a module with VBA code.
type: docs
weight: 359
weight: 360
url: /java/com.aspose.tasks/ivbamodule/
---
```
Expand Down
25 changes: 25 additions & 0 deletions english/java/com.aspose.tasks/loadoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ Allows to specify additional load parameters when loading a project from file or
| Method | Description |
| --- | --- |
| [getCancellationToken()](#getCancellationToken--) | Gets a token which can be used to cancel a project loading operation. |
| [getEncoding()](#getEncoding--) | Gets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. |
| [getErrorHandler()](#getErrorHandler--) | Gets a callback method to handle xml parse errors. |
| [getPassword()](#getPassword--) | Gets a protection password. |
| [getPrimaveraReadOptions()](#getPrimaveraReadOptions--) | Gets a specified instance of the [PrimaveraReadOptions](../../com.aspose.tasks/primaverareadoptions) class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml). |
| [setCancellationToken(CancellationToken value)](#setCancellationToken-com.aspose.tasks.CancellationToken-) | Sets a token which can be used to cancel a project loading operation. |
| [setEncoding(Charset value)](#setEncoding-java.nio.charset.Charset-) | Sets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. |
| [setErrorHandler(ParseErrorCallback value)](#setErrorHandler-com.aspose.tasks.ParseErrorCallback-) | Sets a callback method to handle xml parse errors. |
| [setPassword(String value)](#setPassword-java.lang.String-) | Sets a protection password. |
| [setPrimaveraReadOptions(PrimaveraReadOptions value)](#setPrimaveraReadOptions-com.aspose.tasks.PrimaveraReadOptions-) | Sets a specified instance of the [PrimaveraReadOptions](../../com.aspose.tasks/primaverareadoptions) class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml). |
Expand All @@ -49,6 +51,16 @@ Gets a token which can be used to cancel a project loading operation.

**Returns:**
[CancellationToken](../../com.aspose.tasks/cancellationtoken) - a token which can be used to cancel a project loading operation.
### getEncoding() {#getEncoding--}
```
public final Charset getEncoding()
```


Gets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. The default encoding is UTF8.

**Returns:**
java.nio.charset.Charset - encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats.
### getErrorHandler() {#getErrorHandler--}
```
public final ParseErrorCallback getErrorHandler()
Expand Down Expand Up @@ -92,6 +104,19 @@ Sets a token which can be used to cancel a project loading operation.
| --- | --- | --- |
| value | [CancellationToken](../../com.aspose.tasks/cancellationtoken) | a token which can be used to cancel a project loading operation. |

### setEncoding(Charset value) {#setEncoding-java.nio.charset.Charset-}
```
public final void setEncoding(Charset value)
```


Sets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. The default encoding is UTF8.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | java.nio.charset.Charset | encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. |

### setErrorHandler(ParseErrorCallback value) {#setErrorHandler-com.aspose.tasks.ParseErrorCallback-}
```
public final void setErrorHandler(ParseErrorCallback value)
Expand Down
8 changes: 5 additions & 3 deletions english/java/com.aspose.tasks/mppsaveoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ url: /java/com.aspose.tasks/mppsaveoptions/
---

**Inheritance:**
java.lang.Object
java.lang.Object, [com.aspose.tasks.SimpleSaveOptions](../../com.aspose.tasks/simplesaveoptions)
```
public class MPPSaveOptions
public class MPPSaveOptions extends SimpleSaveOptions
```

Allows to specify additional options when saving project data to MPP.
## Constructors

| Constructor | Description |
| --- | --- |
| [MPPSaveOptions()](#MPPSaveOptions--) | |
| [MPPSaveOptions()](#MPPSaveOptions--) | Initializes a new instance of the [MPPSaveOptions](../../com.aspose.tasks/mppsaveoptions) class. |
## Methods

| Method | Description |
Expand All @@ -35,6 +35,8 @@ public MPPSaveOptions()
```


Initializes a new instance of the [MPPSaveOptions](../../com.aspose.tasks/mppsaveoptions) class.

### getProtectionPassword() {#getProtectionPassword--}
```
public final String getProtectionPassword()
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.aspose.tasks/pdfsaveoptions/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ url: /java/com.aspose.tasks/pdfsaveoptions/
---

**Inheritance:**
java.lang.Object, [com.aspose.tasks.SaveOptions](../../com.aspose.tasks/saveoptions)
java.lang.Object, [com.aspose.tasks.SimpleSaveOptions](../../com.aspose.tasks/simplesaveoptions), [com.aspose.tasks.SaveOptions](../../com.aspose.tasks/saveoptions)

**All Implemented Interfaces:**
com.aspose.tasks.SaveOptions.IReduceBottomGap, com.aspose.tasks.SaveOptions.IFontCallbacks, com.aspose.tasks.ICloneableSaveOptions
Expand Down
22 changes: 22 additions & 0 deletions english/java/com.aspose.tasks/primaveraprojectproperties/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,32 @@ Represents Primavera-specific properties for a project read from Primavera files

| Method | Description |
| --- | --- |
| [getBaselineProjects()](#getBaselineProjects--) | Gets array of baseline projects of current project. |
| [getCurrentBaselineProjectId()](#getCurrentBaselineProjectId--) | Gets Id of the current baseline project. |
| [getIgnoreOtherProjectRelationships()](#getIgnoreOtherProjectRelationships--) | Gets a flag which defines whether to ignore activity relationships between projects. |
| [getMakeOpenEndedActivitiesCritical()](#getMakeOpenEndedActivitiesCritical--) | Gets a flag which defines whether activities should me marked as critical when scheduling the project. |
| [getRelationshipLagCalendar()](#getRelationshipLagCalendar--) | Gets an options which defines which calendar to use for scheduling Relationship Lag in Primavera projects |
| [getUseExpectedFinishDates()](#getUseExpectedFinishDates--) | Gets a flag which defines whether activity finish dates should be scheduled as the expected finish dates. |
### getBaselineProjects() {#getBaselineProjects--}
```
public final Project[] getBaselineProjects()
```


Gets array of baseline projects of current project. Is applicable to projects read from Primavera XML files containing exported baselines.

**Returns:**
com.aspose.tasks.Project[] - array of baseline projects of current project.
### getCurrentBaselineProjectId() {#getCurrentBaselineProjectId--}
```
public final int getCurrentBaselineProjectId()
```


Gets Id of the current baseline project. Is applicable to projects read from Primavera XML files containing exported baselines.

**Returns:**
int - Id of the current baseline project.
### getIgnoreOtherProjectRelationships() {#getIgnoreOtherProjectRelationships--}
```
public final boolean getIgnoreOtherProjectRelationships()
Expand Down
Loading