From bc96b80ac350fa90a485dcf4e33616e3d67723d2 Mon Sep 17 00:00:00 2001 From: Vadim Yurko Date: Wed, 27 Nov 2024 14:53:27 +0300 Subject: [PATCH] Updated Aspose.Tasks for Java API reference to v.24.11. --- .../extendedattributedefinition/_index.md | 4 +- english/java/com.aspose.tasks/group/_index.md | 25 ++++++ .../com.aspose.tasks/mppsaveoptions/_index.md | 82 ++++++++++++++++--- .../com.aspose.tasks/saveoptions/_index.md | 20 +++-- .../java/com.aspose.tasks/tasklink/_index.md | 2 +- .../vbamoduleattribute/_index.md | 2 +- 6 files changed, 113 insertions(+), 22 deletions(-) diff --git a/english/java/com.aspose.tasks/extendedattributedefinition/_index.md b/english/java/com.aspose.tasks/extendedattributedefinition/_index.md index 031f81c89..2871e831e 100644 --- a/english/java/com.aspose.tasks/extendedattributedefinition/_index.md +++ b/english/java/com.aspose.tasks/extendedattributedefinition/_index.md @@ -670,7 +670,7 @@ public final GraphicalIndicatorsInfo getGraphicalIndicator() ``` -Gets a graphical indicators info associated with the extended attribute. +Gets a graphical indicators info associated with the extended attribute. Applicable to MPP format. **Returns:** [GraphicalIndicatorsInfo](../../com.aspose.tasks/graphicalindicatorsinfo) - a graphical indicators info associated with the extended attribute. @@ -1010,7 +1010,7 @@ public final void setGraphicalIndicator(GraphicalIndicatorsInfo value) ``` -Sets a graphical indicators info associated with the extended attribute. +Sets a graphical indicators info associated with the extended attribute. Applicable to MPP format. **Parameters:** | Parameter | Type | Description | diff --git a/english/java/com.aspose.tasks/group/_index.md b/english/java/com.aspose.tasks/group/_index.md index 4d847e65a..35f637e7d 100644 --- a/english/java/com.aspose.tasks/group/_index.md +++ b/english/java/com.aspose.tasks/group/_index.md @@ -23,6 +23,7 @@ Represents a group definition. A Group object is a member of the ResourceGroups | Method | Description | | --- | --- | +| [getGroupAssignments()](#getGroupAssignments--) | Gets a value indicating whether assignments should be grouped instead of tasks. | | [getGroupCriteria()](#getGroupCriteria--) | Gets a GroupCriteria collection representing the fields in a group definition. | | [getIndex()](#getIndex--) | Gets the index of a [Group](../../com.aspose.tasks/group) object in the Groups containing object. | | [getMaintainHierarchy()](#getMaintainHierarchy--) | Gets a value indicating whether to show all the levels of summary tasks for subtasks within group. | @@ -30,6 +31,7 @@ Represents a group definition. A Group object is a member of the ResourceGroups | [getShowInMenu()](#getShowInMenu--) | Gets a value indicating whether Project shows the group name in the Group drop-down list in the Ribbon. | | [getShowSummary()](#getShowSummary--) | Gets a value indicating whether summary rows are displayed for the group. | | [getUid()](#getUid--) | Gets a unique identifier of a group. | +| [setGroupAssignments(boolean value)](#setGroupAssignments-boolean-) | Sets a value indicating whether assignments should be grouped instead of tasks. | | [setGroupCriteria(GroupCriterionCollection value)](#setGroupCriteria-com.aspose.tasks.GroupCriterionCollection-) | Sets a GroupCriteria collection representing the fields in a group definition. | | [setMaintainHierarchy(boolean value)](#setMaintainHierarchy-boolean-) | Sets a value indicating whether to show all the levels of summary tasks for subtasks within group. | | [setName(String value)](#setName-java.lang.String-) | Sets a name of a Group object. | @@ -43,6 +45,16 @@ public Group() Initializes a new instance of the [Group](../../com.aspose.tasks/group) class. +### getGroupAssignments() {#getGroupAssignments--} +``` +public final boolean getGroupAssignments() +``` + + +Gets a value indicating whether assignments should be grouped instead of tasks. + +**Returns:** +boolean - a value indicating whether assignments should be grouped instead of tasks. ### getGroupCriteria() {#getGroupCriteria--} ``` public final GroupCriterionCollection getGroupCriteria() @@ -113,6 +125,19 @@ Gets a unique identifier of a group. **Returns:** int - a unique identifier of a group. +### setGroupAssignments(boolean value) {#setGroupAssignments-boolean-} +``` +public final void setGroupAssignments(boolean value) +``` + + +Sets a value indicating whether assignments should be grouped instead of tasks. + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| value | boolean | a value indicating whether assignments should be grouped instead of tasks. | + ### setGroupCriteria(GroupCriterionCollection value) {#setGroupCriteria-com.aspose.tasks.GroupCriterionCollection-} ``` public final void setGroupCriteria(GroupCriterionCollection value) diff --git a/english/java/com.aspose.tasks/mppsaveoptions/_index.md b/english/java/com.aspose.tasks/mppsaveoptions/_index.md index 4a5f3b5f2..d398d5e89 100644 --- a/english/java/com.aspose.tasks/mppsaveoptions/_index.md +++ b/english/java/com.aspose.tasks/mppsaveoptions/_index.md @@ -23,14 +23,18 @@ Allows to specify additional options when saving project data to MPP. | Method | Description | | --- | --- | +| [getClearVba()](#getClearVba--) | Gets a value indicating whether to remove existing VBA macros data when saving a project to MPP format. | | [getProtectionPassword()](#getProtectionPassword--) | Gets a password which is used to protect a resulting MPP file. | | [getRemoveInvalidAssignments()](#getRemoveInvalidAssignments--) | Gets a value indicating whether to remove invalid resource assignments when saving to MPP. | -| [getWriteFilters()](#getWriteFilters--) | Gets a value indicating whether to write filter data when saving to MPP. | -| [getWriteViewData()](#getWriteViewData--) | Gets a value indicating whether to write view data when saving to MPP. | +| [getWriteFilters()](#getWriteFilters--) | Gets a value indicating whether to write filter data when saving a project to MPP for format. | +| [getWriteGroups()](#getWriteGroups--) | Gets a value indicating whether to write groups data when saving a project to MPP for format. | +| [getWriteViewData()](#getWriteViewData--) | Gets a value indicating whether to write view data when saving a project to MPP format. | +| [setClearVba(boolean value)](#setClearVba-boolean-) | Sets a value indicating whether to remove existing VBA macros data when saving a project to MPP format. | | [setProtectionPassword(String value)](#setProtectionPassword-java.lang.String-) | Sets a password which is used to protect a resulting MPP file. | | [setRemoveInvalidAssignments(boolean value)](#setRemoveInvalidAssignments-boolean-) | Sets a value indicating whether to remove invalid resource assignments when saving to MPP. | -| [setWriteFilters(boolean value)](#setWriteFilters-boolean-) | Sets a value indicating whether to write filter data when saving to MPP. | -| [setWriteViewData(boolean value)](#setWriteViewData-boolean-) | Sets a value indicating whether to write view data when saving to MPP. | +| [setWriteFilters(boolean value)](#setWriteFilters-boolean-) | Sets a value indicating whether to write filter data when saving a project to MPP for format. | +| [setWriteGroups(boolean value)](#setWriteGroups-boolean-) | Sets a value indicating whether to write groups data when saving a project to MPP for format. | +| [setWriteViewData(boolean value)](#setWriteViewData-boolean-) | Sets a value indicating whether to write view data when saving a project to MPP format. | ### MPPSaveOptions() {#MPPSaveOptions--} ``` public MPPSaveOptions() @@ -39,6 +43,16 @@ public MPPSaveOptions() Initializes a new instance of the [MPPSaveOptions](../../com.aspose.tasks/mppsaveoptions) class. +### getClearVba() {#getClearVba--} +``` +public final boolean getClearVba() +``` + + +Gets a value indicating whether to remove existing VBA macros data when saving a project to MPP format. + +**Returns:** +boolean - a value indicating whether to remove existing VBA macros data when saving a project to MPP format. ### getProtectionPassword() {#getProtectionPassword--} ``` public final String getProtectionPassword() @@ -73,7 +87,7 @@ public final boolean getWriteFilters() ``` -Gets a value indicating whether to write filter data when saving to MPP. +Gets a value indicating whether to write filter data when saving a project to MPP for format. -------------------- @@ -84,21 +98,48 @@ Filter data includes Project.TaskFilters and Project.ResourceFilters collections Currently supported for MSP 2010 or newer formats. **Returns:** -boolean - a value indicating whether to write filter data when saving to MPP. +boolean - a value indicating whether to write filter data when saving a project to MPP for format. +### getWriteGroups() {#getWriteGroups--} +``` +public final boolean getWriteGroups() +``` + + +Gets a value indicating whether to write groups data when saving a project to MPP for format. + +-------------------- + +Group data includes Project.TaskGroups and Project.ResourceGroups collections. + +**Returns:** +boolean - a value indicating whether to write groups data when saving a project to MPP for format. ### getWriteViewData() {#getWriteViewData--} ``` public final boolean getWriteViewData() ``` -Gets a value indicating whether to write view data when saving to MPP. +Gets a value indicating whether to write view data when saving a project to MPP format. -------------------- View data includes Project.Views, Filters and Tables collections. **Returns:** -boolean - a value indicating whether to write view data when saving to MPP. +boolean - a value indicating whether to write view data when saving a project to MPP format. +### setClearVba(boolean value) {#setClearVba-boolean-} +``` +public final void setClearVba(boolean value) +``` + + +Sets a value indicating whether to remove existing VBA macros data when saving a project to MPP format. + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| value | boolean | a value indicating whether to remove existing VBA macros data when saving a project to MPP format. | + ### setProtectionPassword(String value) {#setProtectionPassword-java.lang.String-} ``` public final void setProtectionPassword(String value) @@ -139,7 +180,7 @@ public final void setWriteFilters(boolean value) ``` -Sets a value indicating whether to write filter data when saving to MPP. +Sets a value indicating whether to write filter data when saving a project to MPP for format. -------------------- @@ -152,7 +193,24 @@ Currently supported for MSP 2010 or newer formats. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | a value indicating whether to write filter data when saving to MPP. | +| value | boolean | a value indicating whether to write filter data when saving a project to MPP for format. | + +### setWriteGroups(boolean value) {#setWriteGroups-boolean-} +``` +public final void setWriteGroups(boolean value) +``` + + +Sets a value indicating whether to write groups data when saving a project to MPP for format. + +-------------------- + +Group data includes Project.TaskGroups and Project.ResourceGroups collections. + +**Parameters:** +| Parameter | Type | Description | +| --- | --- | --- | +| value | boolean | a value indicating whether to write groups data when saving a project to MPP for format. | ### setWriteViewData(boolean value) {#setWriteViewData-boolean-} ``` @@ -160,7 +218,7 @@ public final void setWriteViewData(boolean value) ``` -Sets a value indicating whether to write view data when saving to MPP. +Sets a value indicating whether to write view data when saving a project to MPP format. -------------------- @@ -169,5 +227,5 @@ View data includes Project.Views, Filters and Tables collections. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | boolean | a value indicating whether to write view data when saving to MPP. | +| value | boolean | a value indicating whether to write view data when saving a project to MPP format. | diff --git a/english/java/com.aspose.tasks/saveoptions/_index.md b/english/java/com.aspose.tasks/saveoptions/_index.md index 73719e55f..f7d982bb8 100644 --- a/english/java/com.aspose.tasks/saveoptions/_index.md +++ b/english/java/com.aspose.tasks/saveoptions/_index.md @@ -39,7 +39,7 @@ An instance of any derived class from SaveOptions class is passed to the stream | [getRenderToSinglePage()](#getRenderToSinglePage--) | Gets a value indicating whether a project should be rendered to a single page when project is saved in graphical format. | | [getRollUpGanttBars()](#getRollUpGanttBars--) | Gets a value indicating whether subtasks on the summary task bar should be marked. | | [getStartDate()](#getStartDate--) | Gets the date to start rendering from. | -| [getTextStyles()](#getTextStyles--) | Gets the list of the instances of the [TextStyle](../../com.aspose.tasks/textstyle) class that appear in project view. | +| [getTextStyles()](#getTextStyles--) | Gets the list of text styles that applied during rendering of a project view. | | [getTimescale()](#getTimescale--) | Gets the `Timescale`([getTimescale()](../../com.aspose.tasks/saveoptions\#getTimescale--)/[setTimescale(int)](../../com.aspose.tasks/saveoptions\#setTimescale-int-)) value which is used to control how timescale (if present) is rendered when project is saved to graphical format. | | [getUseGradientBrush()](#getUseGradientBrush--) | Gets a value indicating whether gradient brush should be used when rendering Gantt Chart. | | [getView()](#getView--) | Gets a list of the view columns to render ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)). | @@ -62,7 +62,7 @@ An instance of any derived class from SaveOptions class is passed to the stream | [setRenderToSinglePage(boolean value)](#setRenderToSinglePage-boolean-) | Sets a value indicating whether a project should be rendered to a single page when project is saved in graphical format. | | [setRollUpGanttBars(boolean value)](#setRollUpGanttBars-boolean-) | Sets a value indicating whether subtasks on the summary task bar should be marked. | | [setStartDate(Date value)](#setStartDate-java.util.Date-) | Sets the date to start rendering from. | -| [setTextStyles(List<TextStyle> value)](#setTextStyles-java.util.List-com.aspose.tasks.TextStyle--) | Sets the list of the instances of the [TextStyle](../../com.aspose.tasks/textstyle) class that appear in project view. | +| [setTextStyles(List<TextStyle> value)](#setTextStyles-java.util.List-com.aspose.tasks.TextStyle--) | Sets the list of text styles that applied during rendering of a project view. | | [setTimescale(int value)](#setTimescale-int-) | Sets the `Timescale`([getTimescale()](../../com.aspose.tasks/saveoptions\#getTimescale--)/[setTimescale(int)](../../com.aspose.tasks/saveoptions\#setTimescale-int-)) value which is used to control how timescale (if present) is rendered when project is saved to graphical format. | | [setUseGradientBrush(boolean value)](#setUseGradientBrush-boolean-) | Sets a value indicating whether gradient brush should be used when rendering Gantt Chart. | | [setView(ProjectView value)](#setView-com.aspose.tasks.ProjectView-) | Sets a list of the view columns to render ([GanttChartColumn](../../com.aspose.tasks/ganttchartcolumn)). | @@ -247,10 +247,14 @@ public final List getTextStyles() ``` -Gets the list of the instances of the [TextStyle](../../com.aspose.tasks/textstyle) class that appear in project view. +Gets the list of text styles that applied during rendering of a project view. + +-------------------- + +These styles override styles defined with GanttCharView.setTextStyles. **Returns:** -java.util.List<com.aspose.tasks.TextStyle> - the list of the instances of the [TextStyle](../../com.aspose.tasks/textstyle) class that appear in project view. +java.util.List<com.aspose.tasks.TextStyle> - the list of text styles that applied during rendering of a project view. ### getTimescale() {#getTimescale--} ``` public final int getTimescale() @@ -544,12 +548,16 @@ public final void setTextStyles(List value) ``` -Sets the list of the instances of the [TextStyle](../../com.aspose.tasks/textstyle) class that appear in project view. +Sets the list of text styles that applied during rendering of a project view. + +-------------------- + +These styles override styles defined with GanttCharView.setTextStyles. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | -| value | java.util.List<com.aspose.tasks.TextStyle> | the list of the instances of the [TextStyle](../../com.aspose.tasks/textstyle) class that appear in project view. | +| value | java.util.List<com.aspose.tasks.TextStyle> | the list of text styles that applied during rendering of a project view. | ### setTimescale(int value) {#setTimescale-int-} ``` diff --git a/english/java/com.aspose.tasks/tasklink/_index.md b/english/java/com.aspose.tasks/tasklink/_index.md index e5a1267bf..fe5d93383 100644 --- a/english/java/com.aspose.tasks/tasklink/_index.md +++ b/english/java/com.aspose.tasks/tasklink/_index.md @@ -13,7 +13,7 @@ java.lang.Object **All Implemented Interfaces:** com.aspose.ms.System.IEquatable ``` -public class TaskLink implements System.IEquatable +public final class TaskLink implements System.IEquatable ``` Represents a predecessor link. diff --git a/english/java/com.aspose.tasks/vbamoduleattribute/_index.md b/english/java/com.aspose.tasks/vbamoduleattribute/_index.md index 949cee8b9..9f88843fd 100644 --- a/english/java/com.aspose.tasks/vbamoduleattribute/_index.md +++ b/english/java/com.aspose.tasks/vbamoduleattribute/_index.md @@ -13,7 +13,7 @@ java.lang.Object **All Implemented Interfaces:** com.aspose.ms.System.IEquatable ``` -public class VbaModuleAttribute implements System.IEquatable +public final class VbaModuleAttribute implements System.IEquatable ``` The attribute of the [VbaModule](../../com.aspose.tasks/vbamodule) object