Merge pull request #60 from aspose-tasks/python-24.4-api

Updated API reference for Aspose.Tasks for Python via .NET 24.4
aspose-tasks · Apr 27, 2024 · 31caf05 · 31caf05
2 parents f861501 + 751b7d9
commit 31caf05
Show file tree

Hide file tree

Showing 24 changed files with 51 additions and 17 deletions.
diff --git a/english/python-net/aspose.tasks.saving/_index.md b/english/python-net/aspose.tasks.saving/_index.md
@@ -38,6 +38,7 @@ Contains classes for saving a project to different formats.
 | :- | :- |
 |[CsvTextDelimiter](/tasks/python-net/aspose.tasks.saving/csvtextdelimiter/)|Text delimiter for CSV format.|
 |[DataCategory](/tasks/python-net/aspose.tasks.saving/datacategory/)|The category of data used when saving to CSV.|
+|[LegendDrawingOptions](/tasks/python-net/aspose.tasks.saving/legenddrawingoptions/)|Specifies the possible options used when rendering view's legend.|
 |[PdfCompliance](/tasks/python-net/aspose.tasks.saving/pdfcompliance/)|Specifies the PDF compliance level to output file.|
 |[PdfDigitalSignatureHashAlgorithm](/tasks/python-net/aspose.tasks.saving/pdfdigitalsignaturehashalgorithm/)|Specifies digital hash algorithm used by digital signature.|
 |[PdfEncryptionAlgorithm](/tasks/python-net/aspose.tasks.saving/pdfencryptionalgorithm/)|Specifies the encryption algorithm to use for encrypting a PDF document.|

diff --git a/english/python-net/aspose.tasks.saving/htmlsaveoptions/_index.md b/english/python-net/aspose.tasks.saving/htmlsaveoptions/_index.md
@@ -27,6 +27,7 @@ The HtmlSaveOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.saving/imagesaveoptions/_index.md b/english/python-net/aspose.tasks.saving/imagesaveoptions/_index.md
@@ -27,6 +27,7 @@ The ImageSaveOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.saving/legenddrawingoptions/_index.md b/english/python-net/aspose.tasks.saving/legenddrawingoptions/_index.md
@@ -0,0 +1,26 @@
+---
+title: LegendDrawingOptions
+second_title: Aspose.Tasks for Python via .NET API Reference
+description: 
+type: docs
+weight: 230
+url: /python-net/aspose.tasks.saving/legenddrawingoptions/
+---
+
+## LegendDrawingOptions enumeration
+
+Specifies the possible options used when rendering view's legend.
+
+## Members
+| Member name | Description |
+| :- | :- |
+|NO_LEGEND|No legend is rendered.|
+|AFTER_LAST_PAGE|The legend is rendered on a separate page after the last page of the project's pages.|
+|ON_EVERY_PAGE|The legend is rendered on every page.|
+|DEFINED_IN_VIEW|The legend is rendered according to View.PageInfo.Legend.LegendOn property of the rendered View.|
+
+### See Also
+
+* namespace [aspose.tasks.saving](/tasks/python-net/aspose.tasks.saving/)
+* assembly [Aspose.Tasks](/tasks/python-net/)
+
diff --git a/english/python-net/aspose.tasks.saving/pdfcompliance/_index.md b/english/python-net/aspose.tasks.saving/pdfcompliance/_index.md
@@ -3,7 +3,7 @@ title: PdfCompliance
 second_title: Aspose.Tasks for Python via .NET API Reference
 description: 
 type: docs
-weight: 230
+weight: 240
 url: /python-net/aspose.tasks.saving/pdfcompliance/
 ---
 

diff --git a/english/python-net/aspose.tasks.saving/pdfdigitalsignaturehashalgorithm/_index.md b/english/python-net/aspose.tasks.saving/pdfdigitalsignaturehashalgorithm/_index.md
@@ -3,7 +3,7 @@ title: PdfDigitalSignatureHashAlgorithm
 second_title: Aspose.Tasks for Python via .NET API Reference
 description: 
 type: docs
-weight: 240
+weight: 250
 url: /python-net/aspose.tasks.saving/pdfdigitalsignaturehashalgorithm/
 ---
 

diff --git a/english/python-net/aspose.tasks.saving/pdfencryptionalgorithm/_index.md b/english/python-net/aspose.tasks.saving/pdfencryptionalgorithm/_index.md
@@ -3,7 +3,7 @@ title: PdfEncryptionAlgorithm
 second_title: Aspose.Tasks for Python via .NET API Reference
 description: 
 type: docs
-weight: 250
+weight: 260
 url: /python-net/aspose.tasks.saving/pdfencryptionalgorithm/
 ---
 

diff --git a/english/python-net/aspose.tasks.saving/pdfpermissions/_index.md b/english/python-net/aspose.tasks.saving/pdfpermissions/_index.md
@@ -3,7 +3,7 @@ title: PdfPermissions
 second_title: Aspose.Tasks for Python via .NET API Reference
 description: 
 type: docs
-weight: 260
+weight: 270
 url: /python-net/aspose.tasks.saving/pdfpermissions/
 ---
 

diff --git a/english/python-net/aspose.tasks.saving/pdfsaveoptions/_index.md b/english/python-net/aspose.tasks.saving/pdfsaveoptions/_index.md
@@ -27,6 +27,7 @@ The PdfSaveOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.saving/pdftextcompression/_index.md b/english/python-net/aspose.tasks.saving/pdftextcompression/_index.md
@@ -3,7 +3,7 @@ title: PdfTextCompression
 second_title: Aspose.Tasks for Python via .NET API Reference
 description: 
 type: docs
-weight: 270
+weight: 280
 url: /python-net/aspose.tasks.saving/pdftextcompression/
 ---
 

diff --git a/english/python-net/aspose.tasks.saving/printoptions/_index.md b/english/python-net/aspose.tasks.saving/printoptions/_index.md
@@ -27,6 +27,7 @@ The PrintOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.saving/savefileformat/_index.md b/english/python-net/aspose.tasks.saving/savefileformat/_index.md
@@ -3,7 +3,7 @@ title: SaveFileFormat
 second_title: Aspose.Tasks for Python via .NET API Reference
 description: 
 type: docs
-weight: 280
+weight: 290
 url: /python-net/aspose.tasks.saving/savefileformat/
 ---
 

diff --git a/english/python-net/aspose.tasks.saving/saveoptions/_index.md b/english/python-net/aspose.tasks.saving/saveoptions/_index.md
@@ -23,6 +23,7 @@ The SaveOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.saving/svgoptions/_index.md b/english/python-net/aspose.tasks.saving/svgoptions/_index.md
@@ -27,6 +27,7 @@ The SvgOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.saving/tiffcompression/_index.md b/english/python-net/aspose.tasks.saving/tiffcompression/_index.md
@@ -3,7 +3,7 @@ title: TiffCompression
 second_title: Aspose.Tasks for Python via .NET API Reference
 description: 
 type: docs
-weight: 290
+weight: 300
 url: /python-net/aspose.tasks.saving/tiffcompression/
 ---
 

diff --git a/english/python-net/aspose.tasks.saving/xamloptions/_index.md b/english/python-net/aspose.tasks.saving/xamloptions/_index.md
@@ -27,6 +27,7 @@ The XamlOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.saving/xpsoptions/_index.md b/english/python-net/aspose.tasks.saving/xpsoptions/_index.md
@@ -27,6 +27,7 @@ The XpsOptions type exposes the following members:
 |fit_content|Gets or sets a value indicating whether row height should be increased to fit its content.|
 |gridlines|Gets or sets a list of|
 |legend_on_each_page|Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).|
+|legend_drawing_options|Gets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.|
 |mark_critical_tasks|Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).|
 |non_working_time_color|Gets or sets the non-working time color.|
 |page_count|Gets or sets the number of pages of project.|

diff --git a/english/python-net/aspose.tasks.util/fieldhelper/_index.md b/english/python-net/aspose.tasks.util/fieldhelper/_index.md
@@ -16,6 +16,7 @@ The FieldHelper type exposes the following members:
 | Name | Description |
 | :- | :- |
 |get_default_task_field_title(task_key)|Returns a default title of the specific task field.|
+|get_default_field_title(field)|Returns a default title of the specific field.|
 
 ### See Also
 

diff --git a/english/python-net/aspose.tasks.visualization/_index.md b/english/python-net/aspose.tasks.visualization/_index.md
@@ -55,7 +55,7 @@ Contains helper classes for rendering.
 |[HorizontalAlignment](/tasks/python-net/aspose.tasks.visualization/horizontalalignment/)|Specifies how an object or text is horizontally aligned relative to another object.|
 |[HorizontalStringAlignment](/tasks/python-net/aspose.tasks.visualization/horizontalstringalignment/)|Specifies the alignment of a text string relative to its layout rectangle.|
 |[Interval](/tasks/python-net/aspose.tasks.visualization/interval/)|Specifies recurring intervals to display progress lines at.|
-|[Legend](/tasks/python-net/aspose.tasks.visualization/legend/)|Specifies the pages on which the legend appears.|
+|[Legend](/tasks/python-net/aspose.tasks.visualization/legend/)|Specifies the possible options used when rendering view's legend.|
 |[LinePattern](/tasks/python-net/aspose.tasks.visualization/linepattern/)|Line pattern.|
 |[PageSize](/tasks/python-net/aspose.tasks.visualization/pagesize/)|Specifies page size.|
 |[PresentationFormat](/tasks/python-net/aspose.tasks.visualization/presentationformat/)|Enumeration for presentation format.|

diff --git a/english/python-net/aspose.tasks.visualization/legend/_index.md b/english/python-net/aspose.tasks.visualization/legend/_index.md
@@ -9,14 +9,14 @@ url: /python-net/aspose.tasks.visualization/legend/
 
 ## Legend enumeration
 
-Specifies the pages on which the legend appears.
+Specifies the possible options used when rendering view's legend.
 
 ## Members
 | Member name | Description |
 | :- | :- |
-|NO_LEGEND|No legend.|
-|AFTER_LAST_PAGE|Legend appears after the last page.|
-|ON_EVERY_PAGE|Legend appears on every page.|
+|NO_LEGEND|No legend is rendered.|
+|AFTER_LAST_PAGE|The legend is rendered on a separate page after the last page of the project's pages.|
+|ON_EVERY_PAGE|The legend is rendered on every page.|
 
 ### See Also
 

diff --git a/english/python-net/aspose.tasks/calendar/_index.md b/english/python-net/aspose.tasks/calendar/_index.md
@@ -23,7 +23,7 @@ The Calendar type exposes the following members:
 |is_base_calendar|Gets a value indicating whether the calendar is a base calendar.|
 |base_calendar|Gets or sets the base calendar on which this calendar depends.<br/>            Only applicable if the calendar is not a base calendar.|
 |is_baseline_calendar|Gets or sets a value indicating whether the calendar is a baseline calendar.|
-|guid|Gets or sets calendar's Guid.|
+|guid|Gets calendar's Guid.|
 ## Methods
 | Name | Description |
 | :- | :- |

diff --git a/english/python-net/aspose.tasks/field/_index.md b/english/python-net/aspose.tasks/field/_index.md
@@ -708,7 +708,6 @@ Specifies a field in the Microsoft Office Project.
 |TASK_DATE8|Represents the Date8 (Task) field.|
 |TASK_DATE9|Represents the Date9 (Task) field.|
 |TASK_DEADLINE|Represents the Deadline (Task) field.|
-|TASK_DELAY|Represents the Delay (Task) field.|
 |TASK_DELIVERABLE_FINISH|Represents the Deliverable Finish (Task) field.|
 |TASK_DELIVERABLE_GUID|Represents the Deliverable GUID (Task) field.|
 |TASK_DELIVERABLE_NAME|Represents the Deliverable Start (Task) field.|

diff --git a/english/python-net/aspose.tasks/project/_index.md b/english/python-net/aspose.tasks/project/_index.md
@@ -138,11 +138,9 @@ The Project type exposes the following members:
 |get_project_file_info(stream)|Gets project file info from the stream.|
 |recalculate()|Recalculates Start and Finish of resources.|
 |recalculate(validate)|Reschedules all project tasks ids, outline levels, start/finish dates, sets early/late dates, calculates slacks, work and cost fields with optional validation.|
-|save(filename, options)|Saves the document to mpp file format using the specified save options.|
 |save(filename, options)|Saves the document to a file using the specified save options.|
 |save(filename, format)|Saves the project data to the file.|
-|save(filename)|Saves the document to mpp file format using the specified save options.|
-|save(stream, options)|Saves the project to a stream using the specified save options.|
+|save(filename)|Saves the document to a file using the specified save options.|
 |save(stream, options)|Saves the project to a stream using the specified save options.|
 |save(stream, format)|Saves the project data to the stream.|
 |save_report(stream)|Saves the project overview report to the stream.|

diff --git a/english/python-net/aspose.tasks/resourceassignment/_index.md b/english/python-net/aspose.tasks/resourceassignment/_index.md
@@ -94,6 +94,7 @@ The ResourceAssignment type exposes the following members:
 |timephased_data_from_task_duration(calendar)|Generates list of time phased data based on the task duration and the scheduled start date.|
 |make_t_ps(start, time, calendar, list, is_working, type)|Generates a list of time phased data.|
 |split_task(start, finish, calendar)|Splits task into two parts.|
+|set_material_resource_units(units, rate_scale_type)|Sets units for assignment of a material resource with variable material consumption.<br/>            The variable material consumption means that as the assignment duration changes, the quantity of materials used changes proportionally.|
 
 ### See Also