SaveOptions - Aspose.Tasks for Java

java.lang.Object
- com.aspose.tasks.SaveOptions

Direct Known Subclasses:

CsvOptions, HtmlSaveOptions, ImageSaveOptions, PdfSaveOptions, PrimaveraSaveOptions, PrimaveraXmlSaveOptions, Spreadsheet2003SaveOptions, SvgOptions, XamlOptions, XlsxOptions, XpsOptions
```
public abstract class SaveOptions
extends Object
```
This is an abstract base class for classes that allow the user to specify additional options when saving a project into a particular format.
An instance of any derived class from SaveOptions class is passed to the stream Save or string Save overloads for the user to define custom options when saving a document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<BarStyle>`	`getBarStyles()`	Gets the list of the instances of the `BarStyle` class that appear in project view.
`Dimension2D`	`getCustomPageSize()`	Gets the custom page size in points (1 point = 1/72 of inch).
`boolean`	`getDrawNonWorkingTime()`	Gets a value indicating whether non-working time should be drawn (Default value is TRUE).
`Date`	`getEndDate()`	Gets a date to finish rendering to.
`boolean`	`getFitContent()`	Gets a value indicating whether row height should be increased to fit its content.
`List<Gridline>`	`getGridlines()`	Gets a list of `Gridline` that appear in project view.
`boolean`	`getLegendOnEachPage()`	Gets a value indicating whether legend should be shown on each page (Default value is TRUE).
`boolean`	`getMarkCriticalTasks()`	Gets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
`Color`	`getNonWorkingTimeColor()`	Gets the non-working time color.
`int`	`getPageCount()`	Gets the number of pages of project.
`int`	`getPageSize()`	Gets the size of page to be rendered (Default value is PageSize.A4).
`int`	`getPresentationFormat()`	Gets the `PresentationFormat`(`getPresentationFormat()`/`setPresentationFormat(int)`) in which the document will be saved.
`boolean`	`getRenderToSinglePage()`	Gets a value indicating whether a project should be rendered to a single page.
`boolean`	`getRollUpGanttBars()`	Gets a value indicating whether subtasks on the summary task bar should be marked.
`int`	`getSaveFormat()`	Gets the format in which the document will be saved if this save options object is used.
`Date`	`getStartDate()`	Gets the date to start rendering from.
`Comparator<Task>`	`getTasksComparer()`	Gets the comparer to sort tasks on Gantt chart and Task Sheet chart.
`ICondition<Task>`	`getTasksFilter()`	Gets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
`List<TextStyle>`	`getTextStyles()`	Gets the list of the instances of the `TextStyle` class that appear in project view.
`int`	`getTimescale()`	Gets the `Timescale`(`getTimescale()`/`setTimescale(int)`) value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
`boolean`	`getUseGradientBrush()`	Gets a value indicating whether gradient brush should be used when rendering Gantt Chart.
`ProjectView`	`getView()`	Gets a list of the view columns to render (`GanttChartColumn`).
`View`	`getViewSettings()`	Gets a view (`View`(`getView()`/`setView(ProjectView)`)) to render.
`void`	`setBarStyles(List<BarStyle> value)`	Sets the list of the instances of the `BarStyle` class that appear in project view.
`void`	`setCustomPageSize(Dimension2D value)`	Sets the custom page size in points (1 point = 1/72 of inch).
`void`	`setDrawNonWorkingTime(boolean value)`	Sets a value indicating whether non-working time should be drawn (Default value is TRUE).
`void`	`setEndDate(Date value)`	Sets a date to finish rendering to.
`void`	`setFitContent(boolean value)`	Sets a value indicating whether row height should be increased to fit its content.
`void`	`setGridlines(List<Gridline> value)`	Sets a list of `Gridline` that appear in project view.
`void`	`setLegendOnEachPage(boolean value)`	Sets a value indicating whether legend should be shown on each page (Default value is TRUE).
`void`	`setMarkCriticalTasks(boolean value)`	Sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
`void`	`setNonWorkingTimeColor(Color value)`	Sets the non-working time color.
`void`	`setPageSize(int value)`	Sets the size of page to be rendered (Default value is PageSize.A4).
`void`	`setPresentationFormat(int value)`	Sets the `PresentationFormat`(`getPresentationFormat()`/`setPresentationFormat(int)`) in which the document will be saved.
`void`	`setRenderToSinglePage(boolean value)`	Sets a value indicating whether a project should be rendered to a single page.
`void`	`setRollUpGanttBars(boolean value)`	Sets a value indicating whether subtasks on the summary task bar should be marked.
`void`	`setStartDate(Date value)`	Sets the date to start rendering from.
`void`	`setTasksComparer(Comparator<Task> value)`	Sets the comparer to sort tasks on Gantt chart and Task Sheet chart.
`void`	`setTasksFilter(ICondition<Task> value)`	Sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
`void`	`setTextStyles(List<TextStyle> value)`	Sets the list of the instances of the `TextStyle` class that appear in project view.
`void`	`setTimescale(int value)`	Sets the `Timescale`(`getTimescale()`/`setTimescale(int)`) value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
`void`	`setUseGradientBrush(boolean value)`	Sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
`void`	`setView(ProjectView value)`	Sets a list of the view columns to render (`GanttChartColumn`).
`void`	`setViewSettings(View value)`	Sets a view (`View`(`getView()`/`setView(ProjectView)`)) to render.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getBarStyles
```
public final List<BarStyle> getBarStyles()
```
    Gets the list of the instances of the BarStyle class that appear in project view.
    
    Returns:
    
    the list of the instances of the BarStyle class that appear in project view.
  - setBarStyles
```
public final void setBarStyles(List<BarStyle> value)
```
    Sets the list of the instances of the BarStyle class that appear in project view.
    
    Parameters:
    
    value - the list of the instances of the BarStyle class that appear in project view.
  - getCustomPageSize
```
public final Dimension2D getCustomPageSize()
```
    Gets the custom page size in points (1 point = 1/72 of inch).
    
    Returns:
    
    the custom page size in points (1 point = 1/72 of inch).
  - setCustomPageSize
```
public final void setCustomPageSize(Dimension2D value)
```
    Sets the custom page size in points (1 point = 1/72 of inch).
    
    Parameters:
    
    value - the custom page size in points (1 point = 1/72 of inch).
  - getDrawNonWorkingTime
```
public final boolean getDrawNonWorkingTime()
```
    Gets a value indicating whether non-working time should be drawn (Default value is TRUE).
    
    Returns:
    
    a value indicating whether non-working time should be drawn (Default value is TRUE).
  - setDrawNonWorkingTime
```
public final void setDrawNonWorkingTime(boolean value)
```
    Sets a value indicating whether non-working time should be drawn (Default value is TRUE).
    
    Parameters:
    
    value - a value indicating whether non-working time should be drawn (Default value is TRUE).
  - getEndDate
```
public final Date getEndDate()
```
    Gets a date to finish rendering to.
    
    Returns:
    
    a date to finish rendering to.
  - setEndDate
```
public final void setEndDate(Date value)
```
    Sets a date to finish rendering to.
    
    Parameters:
    
    value - a date to finish rendering to.
  - getFitContent
```
public final boolean getFitContent()
```
    Gets a value indicating whether row height should be increased to fit its content.
    
    Returns:
    
    a value indicating whether row height should be increased to fit its content.
  - setFitContent
```
public final void setFitContent(boolean value)
```
    Sets a value indicating whether row height should be increased to fit its content.
    
    Parameters:
    
    value - a value indicating whether row height should be increased to fit its content.
  - getGridlines
```
public final List<Gridline> getGridlines()
```
    Gets a list of Gridline that appear in project view.
    
    Returns:
    
    a list of Gridline that appear in project view.
  - setGridlines
```
public final void setGridlines(List<Gridline> value)
```
    Sets a list of Gridline that appear in project view.
    
    Parameters:
    
    value - a list of Gridline that appear in project view.
  - getLegendOnEachPage
```
public final boolean getLegendOnEachPage()
```
    Gets a value indicating whether legend should be shown on each page (Default value is TRUE).
    
    Returns:
    
    a value indicating whether legend should be shown on each page (Default value is TRUE).
  - setLegendOnEachPage
```
public final void setLegendOnEachPage(boolean value)
```
    Sets a value indicating whether legend should be shown on each page (Default value is TRUE).
    
    Parameters:
    
    value - a value indicating whether legend should be shown on each page (Default value is TRUE).
  - getMarkCriticalTasks
```
public final boolean getMarkCriticalTasks()
```
    Gets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
    
    Returns:
    
    a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
  - setMarkCriticalTasks
```
public final void setMarkCriticalTasks(boolean value)
```
    Sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
    
    Parameters:
    
    value - a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
  - getNonWorkingTimeColor
```
public final Color getNonWorkingTimeColor()
```
    Gets the non-working time color.
    
    Returns:
    
    the non-working time color.
  - setNonWorkingTimeColor
```
public final void setNonWorkingTimeColor(Color value)
```
    Sets the non-working time color.
    
    Parameters:
    
    value - the non-working time color.
  - getPageCount
```
public final int getPageCount()
```
    Gets the number of pages of project.
    
    Returns:
    
    the number of pages of project.
  - getPageSize
```
public final int getPageSize()
```
    Gets the size of page to be rendered (Default value is PageSize.A4).
    
    Returns:
    
    the size of page to be rendered (Default value is PageSize.
  - setPageSize
```
public final void setPageSize(int value)
```
    Sets the size of page to be rendered (Default value is PageSize.A4).
    
    Parameters:
    
    value - the size of page to be rendered (Default value is PageSize.
  - getPresentationFormat
```
public final int getPresentationFormat()
```
    Gets the PresentationFormat(getPresentationFormat()/setPresentationFormat(int)) in which the document will be saved.
    
    Returns:
    
    the PresentationFormat(getPresentationFormat()/setPresentationFormat(int)) in which the document will be saved.
  - setPresentationFormat
```
public final void setPresentationFormat(int value)
```
    Sets the PresentationFormat(getPresentationFormat()/setPresentationFormat(int)) in which the document will be saved.
    
    Parameters:
    
    value - the PresentationFormat(getPresentationFormat()/setPresentationFormat(int)) in which the document will be saved.
  - getRenderToSinglePage
```
public final boolean getRenderToSinglePage()
```
    Gets a value indicating whether a project should be rendered to a single page.
    
    Returns:
    
    a value indicating whether a project should be rendered to a single page.
  - setRenderToSinglePage
```
public final void setRenderToSinglePage(boolean value)
```
    Sets a value indicating whether a project should be rendered to a single page.
    
    Parameters:
    
    value - a value indicating whether a project should be rendered to a single page.
  - getRollUpGanttBars
```
public final boolean getRollUpGanttBars()
```
    Gets a value indicating whether subtasks on the summary task bar should be marked. For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar. For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars. You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them.
    Is only applicable when Gantt chart view is rendered.
    
    Returns:
    
    a value indicating whether subtasks on the summary task bar should be marked.
  - setRollUpGanttBars
```
public final void setRollUpGanttBars(boolean value)
```
    Sets a value indicating whether subtasks on the summary task bar should be marked. For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar. For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars. You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them.
    Is only applicable when Gantt chart view is rendered.
    
    Parameters:
    
    value - a value indicating whether subtasks on the summary task bar should be marked.
  - getSaveFormat
```
public final int getSaveFormat()
```
    Gets the format in which the document will be saved if this save options object is used.
    
    Returns:
    
    the format in which the document will be saved if this save options object is used.
  - getStartDate
```
public final Date getStartDate()
```
    Gets the date to start rendering from.
    
    Returns:
    
    the date to start rendering from.
  - setStartDate
```
public final void setStartDate(Date value)
```
    Sets the date to start rendering from.
    
    Parameters:
    
    value - the date to start rendering from.
  - getTasksComparer
```
public final Comparator<Task> getTasksComparer()
```
    Gets the comparer to sort tasks on Gantt chart and Task Sheet chart.
    
    Returns:
    
    the comparer to sort tasks on Gantt chart and Task Sheet chart.
  - setTasksComparer
```
public final void setTasksComparer(Comparator<Task> value)
```
    Sets the comparer to sort tasks on Gantt chart and Task Sheet chart.
    
    Parameters:
    
    value - the comparer to sort tasks on Gantt chart and Task Sheet chart.
  - getTasksFilter
```
public final ICondition<Task> getTasksFilter()
```
    Gets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
    If value is not specified the default filter is used which removes non-visible tasks -- i.e. descendant tasks of collapsed tasks.
    
    Returns:
    
    the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
  - setTasksFilter
```
public final void setTasksFilter(ICondition<Task> value)
```
    Sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
    If value is not specified the default filter is used which removes non-visible tasks -- i.e. descendant tasks of collapsed tasks.
    
    Parameters:
    
    value - the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
  - getTextStyles
```
public final List<TextStyle> getTextStyles()
```
    Gets the list of the instances of the TextStyle class that appear in project view.
    
    Returns:
    
    the list of the instances of the TextStyle class that appear in project view.
  - setTextStyles
```
public final void setTextStyles(List<TextStyle> value)
```
    Sets the list of the instances of the TextStyle class that appear in project view.
    
    Parameters:
    
    value - the list of the instances of the TextStyle class that appear in project view.
  - getTimescale
```
public final int getTimescale()
```
    Gets the Timescale(getTimescale()/setTimescale(int)) value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
    
    Returns:
    
    the Timescale(getTimescale()/setTimescale(int)) value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
  - setTimescale
```
public final void setTimescale(int value)
```
    Sets the Timescale(getTimescale()/setTimescale(int)) value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
    
    Parameters:
    
    value - the Timescale(getTimescale()/setTimescale(int)) value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
  - getUseGradientBrush
```
public boolean getUseGradientBrush()
```
    Gets a value indicating whether gradient brush should be used when rendering Gantt Chart.
    Is only applicable when Gantt chart view is rendered.
    
    Returns:
    
    a value indicating whether gradient brush should be used when rendering Gantt Chart.
  - setUseGradientBrush
```
public void setUseGradientBrush(boolean value)
```
    Sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
    Is only applicable when Gantt chart view is rendered.
    
    Parameters:
    
    value - a value indicating whether gradient brush should be used when rendering Gantt Chart.
  - getView
```
public final ProjectView getView()
```
    Gets a list of the view columns to render (GanttChartColumn). If not set then task ids, task names, start and finish are rendered only. If both View and ViewSettings(getViewSettings()/setViewSettings(View)) properties are set, columns from View overrides columns from ViewSettings.
    
    Returns:
    
    a list of the view columns to render (GanttChartColumn).
  - setView
```
public final void setView(ProjectView value)
```
    Sets a list of the view columns to render (GanttChartColumn). If not set then task ids, task names, start and finish are rendered only. If both View and ViewSettings(getViewSettings()/setViewSettings(View)) properties are set, columns from View overrides columns from ViewSettings.
    
    Parameters:
    
    value - a list of the view columns to render (GanttChartColumn).
  - getViewSettings
```
public final View getViewSettings()
```
    Gets a view (View(getView()/setView(ProjectView))) to render. You can use this options to explicitly specify which view should be saved to PDF, HTML or Image formats. If this property is set, PresentationFormat property is ignored when project is saved. View should be from one of the following screen ((Aspose.Tasks.View.Screen(View.getScreen()/View.setScreen(int)))): (Gantt, TaskSheet, TaskUsage, ResourceSheet, ResourceUsage)
    
    Returns:
    
    a view (View(getView()/setView(ProjectView))) to render.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - When set method is called and instance of View class with not supported value of Screen property is provided.
  - setViewSettings
```
public final void setViewSettings(View value)
```
    Sets a view (View(getView()/setView(ProjectView))) to render. You can use this options to explicitly specify which view should be saved to PDF, HTML or Image formats. If this property is set, PresentationFormat property is ignored when project is saved. View should be from one of the following screen ((Aspose.Tasks.View.Screen(View.getScreen()/View.setScreen(int)))): (Gantt, TaskSheet, TaskUsage, ResourceSheet, ResourceUsage)
    
    Parameters:
    
    value - a view (View(getView()/setView(ProjectView))) to render.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - When set method is called and instance of View class with not supported value of Screen property is provided.

com.aspose.tasks

Interfaces

Classes

Exceptions

Class SaveOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getBarStyles

setBarStyles

getCustomPageSize

setCustomPageSize

getDrawNonWorkingTime

setDrawNonWorkingTime

getEndDate

setEndDate

getFitContent

setFitContent

getGridlines

setGridlines

getLegendOnEachPage

setLegendOnEachPage

getMarkCriticalTasks

setMarkCriticalTasks

getNonWorkingTimeColor

setNonWorkingTimeColor

getPageCount

getPageSize

setPageSize

getPresentationFormat

setPresentationFormat

getRenderToSinglePage

setRenderToSinglePage

getRollUpGanttBars

setRollUpGanttBars

getSaveFormat

getStartDate

setStartDate

getTasksComparer

setTasksComparer

getTasksFilter

setTasksFilter

getTextStyles

setTextStyles

getTimescale

setTimescale

getUseGradientBrush

setUseGradientBrush

getView

setView

getViewSettings

setViewSettings