Skip to content

Commit

Permalink
Added files for new members introduced in Aspose.Tasks for .NET 23.10.
Browse files Browse the repository at this point in the history
  • Loading branch information
Vasiliy Sinitsyn committed Oct 17, 2023
1 parent ffe3b43 commit dc2d368
Show file tree
Hide file tree
Showing 16 changed files with 541 additions and 0 deletions.
24 changes: 24 additions & 0 deletions english/net/aspose.tasks.saving/csvoptions/view/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: View
second_title: Aspose.Tasks for .NET API Reference
description: Gets or sets a list of the view columns GanttChartColumnaspose.tasks.visualization/ganttchartcolumn to save to XLSX format. If not set then default columns are saved.
type: docs
weight: 60
url: /net/aspose.tasks.saving/csvoptions/view/
---
## CsvOptions.View property

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

```csharp
public ProjectView View { get; set; }
```

### See Also

* class [ProjectView](../../../aspose.tasks.visualization/projectview)
* class [CsvOptions](../../csvoptions)
* namespace [Aspose.Tasks.Saving](../../csvoptions)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
30 changes: 30 additions & 0 deletions english/net/aspose.tasks.saving/simplesaveoptions/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: SimpleSaveOptions
second_title: Aspose.Tasks for .NET API Reference
description: This is an abstract base class that allow the user to specify basic options when saving a project into a particular format.
type: docs
weight: 2010
url: /net/aspose.tasks.saving/simplesaveoptions/
---
## SimpleSaveOptions class

This is an abstract base class that allow the user to specify basic options when saving a project into a particular format.

```csharp
public abstract class SimpleSaveOptions
```

## Properties

| Name | Description |
| --- | --- |
| [SaveFormat](../../aspose.tasks.saving/simplesaveoptions/saveformat) { get; } | Gets or sets the format in which the document will be saved if this save options object is used. |
| [TasksComparer](../../aspose.tasks.saving/simplesaveoptions/taskscomparer) { getset; } | Gets or sets the comparer to sort tasks on Gantt chart and Task Sheet chart. |
| [TasksFilter](../../aspose.tasks.saving/simplesaveoptions/tasksfilter) { getset; } | Gets or sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts. |

### See Also

* namespace [Aspose.Tasks.Saving](../../aspose.tasks.saving)
* assembly [Aspose.Tasks](../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: SaveFormat
second_title: Aspose.Tasks for .NET API Reference
description: Gets or sets the format in which the document will be saved if this save options object is used.
type: docs
weight: 10
url: /net/aspose.tasks.saving/simplesaveoptions/saveformat/
---
## SimpleSaveOptions.SaveFormat property

Gets or sets the format in which the document will be saved if this save options object is used.

```csharp
public SaveFileFormat SaveFormat { get; }
```

### Examples

Shows how to use custom tasks filter while saving MS Project file.

```csharp
public void WorkWithTasksFilter()
{
var project = new Project(DataDir + "CreateProject2.mpp");

var options = new PdfSaveOptions
{
PresentationFormat = PresentationFormat.GanttChart,
PageSize = PageSize.A3,
StartDate = new DateTime(2010, 7, 1),
EndDate = new DateTime(2010, 9, 1),

// set a task filter to skip task 'Task5' and 'Task3'
TasksFilter = new CustomTasksFilter()
};

// lets check the save format
Console.WriteLine("The save format: " + options.SaveFormat);

// ...
// save the project as an image
project.Save(OutDir + "WorkWithTasksFilter_out.png", options);
}

/// <summary>
/// Example of custom task filter that can be used while saving MS Project file (for instance) in PDF format.
/// </summary>
/// <inheritdoc />
private class CustomTasksFilter : ICondition<Task>
{
public bool Check(Task el)
{
return el.Get(Tsk.Name) != "Task5" && el.Get(Tsk.Name) != "Task3";
}
}
```

### See Also

* enum [SaveFileFormat](../../savefileformat)
* class [SimpleSaveOptions](../../simplesaveoptions)
* namespace [Aspose.Tasks.Saving](../../simplesaveoptions)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: TasksComparer
second_title: Aspose.Tasks for .NET API Reference
description: Gets or sets the comparer to sort tasks on Gantt chart and Task Sheet chart.
type: docs
weight: 20
url: /net/aspose.tasks.saving/simplesaveoptions/taskscomparer/
---
## SimpleSaveOptions.TasksComparer property

Gets or sets the comparer to sort tasks on Gantt chart and Task Sheet chart.

```csharp
public IComparer<Task> TasksComparer { get; set; }
```

### Examples

Shows how to set a comparer to sort tasks on Gantt chart and/or Task Sheet chart.

```csharp
public void SortTasksByColumnInGanttChartExample()
{
var project = new Project(DataDir + "Project2.mpp");
SaveOptions options = new PdfSaveOptions
{
Timescale = Timescale.Months,
TasksComparer = new TasksNameComparer()
};
project.Save(OutDir + "SortedByNames_out.pdf", options);

options.TasksComparer = new TasksDurationComparer();
project.Save(OutDir + "SortedByDurations_out.pdf", options);
}

private class TasksNameComparer : IComparer<Task>
{
public int Compare(Task x, Task y)
{
// ReSharper disable once ConvertIfStatementToSwitchStatement
// ReSharper disable once ConvertIfStatementToSwitchExpression
if (x == null && y == null)
{
return 0;
}

if (x == null)
{
return -1;
}

return y == null ? 1 : string.Compare(x.Get(Tsk.Name), y.Get(Tsk.Name), StringComparison.Ordinal);
}
}

private class TasksDurationComparer : IComparer<Task>
{
public int Compare(Task x, Task y)
{
// ReSharper disable once ConvertIfStatementToSwitchStatement
if (x == null && y == null)
{
return 0;
}

if (x == null)
{
return -1;
}

if (y == null)
{
return 1;
}

var durX = x.Get(Tsk.Duration);
var durY = y.Get(Tsk.Duration);
return durX.TimeSpan.CompareTo(durY.TimeSpan);
}
}
```

### See Also

* class [Task](../../../aspose.tasks/task)
* class [SimpleSaveOptions](../../simplesaveoptions)
* namespace [Aspose.Tasks.Saving](../../simplesaveoptions)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: TasksFilter
second_title: Aspose.Tasks for .NET API Reference
description: Gets or sets the condition which is used to filter tasks rendered on Gantt Task Sheet and Task Usage charts.
type: docs
weight: 30
url: /net/aspose.tasks.saving/simplesaveoptions/tasksfilter/
---
## SimpleSaveOptions.TasksFilter property

Gets or sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.

```csharp
public ICondition<Task> TasksFilter { get; set; }
```

### Remarks

If value is not specified the default filter is used which removes non-visible tasks -- i.e. descendant tasks of collapsed tasks.

### Examples

Shows how to use custom tasks filter while saving MS Project file.

```csharp
public void WorkWithTasksFilter()
{
var project = new Project(DataDir + "CreateProject2.mpp");

var options = new PdfSaveOptions
{
PresentationFormat = PresentationFormat.GanttChart,
PageSize = PageSize.A3,
StartDate = new DateTime(2010, 7, 1),
EndDate = new DateTime(2010, 9, 1),

// set a task filter to skip task 'Task5' and 'Task3'
TasksFilter = new CustomTasksFilter()
};

// lets check the save format
Console.WriteLine("The save format: " + options.SaveFormat);

// ...
// save the project as an image
project.Save(OutDir + "WorkWithTasksFilter_out.png", options);
}

/// <summary>
/// Example of custom task filter that can be used while saving MS Project file (for instance) in PDF format.
/// </summary>
/// <inheritdoc />
private class CustomTasksFilter : ICondition<Task>
{
public bool Check(Task el)
{
return el.Get(Tsk.Name) != "Task5" && el.Get(Tsk.Name) != "Task3";
}
}
```

### See Also

* interface [ICondition&lt;T&gt;](../../../aspose.tasks.util/icondition-1)
* class [Task](../../../aspose.tasks/task)
* class [SimpleSaveOptions](../../simplesaveoptions)
* namespace [Aspose.Tasks.Saving](../../simplesaveoptions)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: View
second_title: Aspose.Tasks for .NET API Reference
description: Gets or sets a list of the view columns GanttChartColumnaspose.tasks.visualization/ganttchartcolumn to save. If not set then default columns are saved.
type: docs
weight: 40
url: /net/aspose.tasks.saving/spreadsheet2003saveoptions/view/
---
## Spreadsheet2003SaveOptions.View property

Gets or sets a list of the view columns ([`GanttChartColumn`](../../../aspose.tasks.visualization/ganttchartcolumn)) to save. If not set then default columns are saved.

```csharp
public ProjectView View { get; set; }
```

### See Also

* class [ProjectView](../../../aspose.tasks.visualization/projectview)
* class [Spreadsheet2003SaveOptions](../../spreadsheet2003saveoptions)
* namespace [Aspose.Tasks.Saving](../../spreadsheet2003saveoptions)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
24 changes: 24 additions & 0 deletions english/net/aspose.tasks.saving/xlsxoptions/view/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: View
second_title: Aspose.Tasks for .NET API Reference
description: Gets or sets a list of the view columns GanttChartColumnaspose.tasks.visualization/ganttchartcolumn to save to XLSX format. If not set then default columns are saved.
type: docs
weight: 50
url: /net/aspose.tasks.saving/xlsxoptions/view/
---
## XlsxOptions.View property

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

```csharp
public ProjectView View { get; set; }
```

### See Also

* class [ProjectView](../../../aspose.tasks.visualization/projectview)
* class [XlsxOptions](../../xlsxoptions)
* namespace [Aspose.Tasks.Saving](../../xlsxoptions)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
23 changes: 23 additions & 0 deletions english/net/aspose.tasks/loadoptions/encoding/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Encoding
second_title: Aspose.Tasks for .NET API Reference
description: Gets or sets encoding which is used to read a project from HTML MPX XER and Primavera XML formats. The default encoding is UTF8.
type: docs
weight: 30
url: /net/aspose.tasks/loadoptions/encoding/
---
## LoadOptions.Encoding property

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

```csharp
public Encoding Encoding { get; set; }
```

### See Also

* class [LoadOptions](../../loadoptions)
* namespace [Aspose.Tasks](../../loadoptions)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: BaselineProjects
second_title: Aspose.Tasks for .NET API Reference
description: Gets array of baseline projects of current project. Is applicable to projects read from Primavera XML files containing exported baselines.
type: docs
weight: 10
url: /net/aspose.tasks/primaveraprojectproperties/baselineprojects/
---
## PrimaveraProjectProperties.BaselineProjects property

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

```csharp
public Project[] BaselineProjects { get; }
```

### See Also

* class [Project](../../project)
* class [PrimaveraProjectProperties](../../primaveraprojectproperties)
* namespace [Aspose.Tasks](../../primaveraprojectproperties)
* assembly [Aspose.Tasks](../../../)

<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Tasks.dll -->
Loading

0 comments on commit dc2d368

Please sign in to comment.