com.aspose.tasks

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.

• 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.

• 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.

  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.

  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.

• getShowProjectSummaryTask

  @Deprecated
  public final boolean getShowProjectSummaryTask()

  Deprecated. This property is not used anymore and will be removed in version 20.11. Use project.Get(Prj.ShowProjectSummaryTask) and project.Set(Prj.ShowProjectSummaryTask, value) methods instead.

  Gets a value indicating whether project summary task if set to true.

  Returns:

  a value indicating whether project summary task if set to true.

• setShowProjectSummaryTask

  @Deprecated
  public final void setShowProjectSummaryTask(boolean value)

  Deprecated. This property is not used anymore and will be removed in version 20.11. Use project.Get(Prj.ShowProjectSummaryTask) and project.Set(Prj.ShowProjectSummaryTask, value) methods instead.

  Sets a value indicating whether project summary task if set to true.

  Parameters:

  value - a value indicating whether project summary task if set to true.

• 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.

• getTimescaleTier

  @Deprecated
  public final TimescaleTier getTimescaleTier()

  Deprecated. This property is not used anymore and will be removed in version 20.12. Use view's timescale settings (*TimescaleTier properties) or SaveOptions.Timescale property to control rendering of timescale tiers.

  Gets the timescale tier of the Gantt Chart view. The default value is null.

  Returns:

  the timescale tier of the Gantt Chart view.

• setTimescaleTier

  @Deprecated
  public final void setTimescaleTier(TimescaleTier value)

  Deprecated. This property is not used anymore and will be removed in version 20.12. Use view's timescale settings (*TimescaleTier properties) or SaveOptions.Timescale property to control rendering of timescale tiers.

  Sets the timescale tier of the Gantt Chart view. The default value is null.

  Parameters:

  value - the timescale tier of the Gantt Chart view.

• getUseGradientBrush

  public boolean getUseGradientBrush()

  Gets a value indicating whether gradient brush should be used when rendering Gantt Chart.

  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.

  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.

  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.

  Parameters:

  value - a list of the view columns to render (GanttChartColumn).