Aspose.Tasks for C++
Aspose::Tasks::Visualization::GanttBarStyle Class Reference

Represents a bar style used by MSP in Gantt Chart view. More...

#include <GanttBarStyle.h>

Inherits System::Object.

Public Member Functions

Field get_BottomField () const
 Gets data to be displayed on the bottom of the bar. Field. More...
 
void set_BottomField (Field value)
 Sets data to be displayed on the bottom of the bar. Field. More...
 
GanttBarEndShape get_EndShape () const
 Gets an end shape of the bar. More...
 
void set_EndShape (GanttBarEndShape value)
 Sets an end shape of the bar. More...
 
System::Drawing::Color get_EndShapeColor () const
 Gets a color of the end shape. More...
 
void set_EndShapeColor (System::Drawing::Color value)
 Sets a color of the end shape. More...
 
GanttBarType get_EndShapeType () const
 Gets a type of the end shape. GanttBarType. More...
 
void set_EndShapeType (GanttBarType value)
 Sets a type of the end shape. GanttBarType. More...
 
Field get_From () const
 Gets a start point position of the gantt bar. Field. More...
 
void set_From (Field value)
 Sets a start point position of the gantt bar. Field. More...
 
Field get_InsideField () const
 Gets data to be displayed inside of the bar. Field. More...
 
void set_InsideField (Field value)
 Sets data to be displayed inside of the bar. Field. More...
 
Field get_LeftField () const
 Gets data to be displayed on the left of the bar. Field. More...
 
void set_LeftField (Field value)
 Sets data to be displayed on the left of the bar. Field. More...
 
GanttBarFillPattern get_MiddleFillPattern () const
 Gets a fill pattern of the gantt bar. More...
 
void set_MiddleFillPattern (GanttBarFillPattern value)
 Sets a fill pattern of the gantt bar. More...
 
GanttBarMiddleShape get_MiddleShape () const
 Gets a middle shape of the bar. More...
 
void set_MiddleShape (GanttBarMiddleShape value)
 Sets a middle shape of the bar. More...
 
System::Drawing::Color get_MiddleShapeColor () const
 Gets a color of the middle shape. More...
 
void set_MiddleShapeColor (System::Drawing::Color value)
 Sets a color of the middle shape. More...
 
System::String get_Name () const
 Gets a name of the style. More...
 
void set_Name (const System::String &value)
 Sets a name of the style. More...
 
Field get_RightField () const
 Gets data to be displayed on the right of the bar. Field. More...
 
void set_RightField (Field value)
 Sets data to be displayed on the right of the bar. Field. More...
 
TaskBarTextConverter get_LeftBarTextConverter () const
 Gets user-defined converter to get text to render on the left of the task's bar. Overrides the value of LeftField property. More...
 
void set_LeftBarTextConverter (TaskBarTextConverter value)
 Sets user-defined converter to get text to render on the left of the task's bar. Overrides the value of LeftField property. More...
 
TaskBarTextConverter get_TopBarTextConverter () const
 Gets user-defined converter to get text to render on the top of the task's bar. Overrides the value of TopField property. More...
 
void set_TopBarTextConverter (TaskBarTextConverter value)
 Sets user-defined converter to get text to render on the top of the task's bar. Overrides the value of TopField property. More...
 
TaskBarTextConverter get_RightBarTextConverter () const
 Gets user-defined converter to get text to render on the right of the task's bar. Overrides the value of RightField property. More...
 
void set_RightBarTextConverter (TaskBarTextConverter value)
 Sets user-defined converter to get text to render on the right of the task's bar. Overrides the value of RightField property. More...
 
TaskBarTextConverter get_BottomBarTextConverter () const
 Gets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of BottomField property. More...
 
void set_BottomBarTextConverter (TaskBarTextConverter value)
 Sets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of BottomField property. More...
 
TaskBarTextConverter get_InsideBarTextConverter () const
 Gets user-defined converter to get text to render inside of the task's bar. Overrides the value of InsideField property. More...
 
void set_InsideBarTextConverter (TaskBarTextConverter value)
 Sets user-defined converter to get text to render inside of the task's bar. Overrides the value of InsideField property. More...
 
int32_t get_Row () const
 Gets a row number. More...
 
void set_Row (int32_t value)
 Sets a row number. More...
 
const System::SharedPtr< System::Collections::Generic::IList< GanttBarShowFor > > & get_ShowForCategories () const
 Gets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart (see GanttChartView::BarStyles). More...
 
void set_ShowForCategories (const System::SharedPtr< System::Collections::Generic::IList< GanttBarShowFor >> &value)
 Sets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart (see GanttChartView::BarStyles). More...
 
System::Nullable< int32_t > get_ShowForTaskUid () const
 Gets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see GanttChartView::CustomBarStyles). More...
 
void set_ShowForTaskUid (System::Nullable< int32_t > value)
 Sets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see GanttChartView::CustomBarStyles). More...
 
GanttBarEndShape get_StartShape () const
 Gets a start shape of the bar. More...
 
void set_StartShape (GanttBarEndShape value)
 Sets a start shape of the bar. More...
 
System::Drawing::Color get_StartShapeColor () const
 Gets a color of the start shape. More...
 
void set_StartShapeColor (System::Drawing::Color value)
 Sets a color of the start shape. More...
 
GanttBarType get_StartShapeType () const
 Gets a type of the start shape. More...
 
void set_StartShapeType (GanttBarType value)
 Sets a type of the start shape. More...
 
Field get_To () const
 Gets a finish point position of the gantt bar. More...
 
void set_To (Field value)
 Sets a finish point position of the gantt bar. More...
 
Field get_TopField () const
 Gets data to be displayed on the top of the bar. More...
 
void set_TopField (Field value)
 Sets data to be displayed on the top of the bar. More...
 
System::SharedPtr< GanttBarStyleget_ParentStyle () const
 Gets parent (or common) style for custom task-specific style. More...
 
void set_ParentStyle (const System::SharedPtr< GanttBarStyle > &value)
 Sets parent (or common) style for custom task-specific style. More...
 
 GanttBarStyle ()
 Initializes a new instance of the GanttBarStyle class. More...
 

Detailed Description

Represents a bar style used by MSP in Gantt Chart view.

Constructor & Destructor Documentation

◆ GanttBarStyle()

Aspose::Tasks::Visualization::GanttBarStyle::GanttBarStyle ( )

Initializes a new instance of the GanttBarStyle class.

Member Function Documentation

◆ get_BottomBarTextConverter()

TaskBarTextConverter Aspose::Tasks::Visualization::GanttBarStyle::get_BottomBarTextConverter ( ) const

Gets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of BottomField property.

Is not persisted to MPP format.

◆ get_BottomField()

Field Aspose::Tasks::Visualization::GanttBarStyle::get_BottomField ( ) const

Gets data to be displayed on the bottom of the bar. Field.

◆ get_EndShape()

GanttBarEndShape Aspose::Tasks::Visualization::GanttBarStyle::get_EndShape ( ) const

Gets an end shape of the bar.

◆ get_EndShapeColor()

System::Drawing::Color Aspose::Tasks::Visualization::GanttBarStyle::get_EndShapeColor ( ) const

Gets a color of the end shape.

◆ get_EndShapeType()

GanttBarType Aspose::Tasks::Visualization::GanttBarStyle::get_EndShapeType ( ) const

Gets a type of the end shape. GanttBarType.

◆ get_From()

Field Aspose::Tasks::Visualization::GanttBarStyle::get_From ( ) const

Gets a start point position of the gantt bar. Field.

◆ get_InsideBarTextConverter()

TaskBarTextConverter Aspose::Tasks::Visualization::GanttBarStyle::get_InsideBarTextConverter ( ) const

Gets user-defined converter to get text to render inside of the task's bar. Overrides the value of InsideField property.

Is not persisted to MPP format.

◆ get_InsideField()

Field Aspose::Tasks::Visualization::GanttBarStyle::get_InsideField ( ) const

Gets data to be displayed inside of the bar. Field.

◆ get_LeftBarTextConverter()

TaskBarTextConverter Aspose::Tasks::Visualization::GanttBarStyle::get_LeftBarTextConverter ( ) const

Gets user-defined converter to get text to render on the left of the task's bar. Overrides the value of LeftField property.

Is not persisted to MPP format.

◆ get_LeftField()

Field Aspose::Tasks::Visualization::GanttBarStyle::get_LeftField ( ) const

Gets data to be displayed on the left of the bar. Field.

◆ get_MiddleFillPattern()

GanttBarFillPattern Aspose::Tasks::Visualization::GanttBarStyle::get_MiddleFillPattern ( ) const

Gets a fill pattern of the gantt bar.

◆ get_MiddleShape()

GanttBarMiddleShape Aspose::Tasks::Visualization::GanttBarStyle::get_MiddleShape ( ) const

Gets a middle shape of the bar.

◆ get_MiddleShapeColor()

System::Drawing::Color Aspose::Tasks::Visualization::GanttBarStyle::get_MiddleShapeColor ( ) const

Gets a color of the middle shape.

◆ get_Name()

System::String Aspose::Tasks::Visualization::GanttBarStyle::get_Name ( ) const

Gets a name of the style.

◆ get_ParentStyle()

System::SharedPtr<GanttBarStyle> Aspose::Tasks::Visualization::GanttBarStyle::get_ParentStyle ( ) const

Gets parent (or common) style for custom task-specific style.

Task can have multiple custom styles with different parent styles. For example consider task having custom style with "Critical" parent style and another style with "Normal" parent style. Simply put, if task is critical, the first style is applied. If task becomes non-critical, the second style is applied (this logic is inherited from Microsoft Project Professional).

◆ get_RightBarTextConverter()

TaskBarTextConverter Aspose::Tasks::Visualization::GanttBarStyle::get_RightBarTextConverter ( ) const

Gets user-defined converter to get text to render on the right of the task's bar. Overrides the value of RightField property.

Is not persisted to MPP format.

◆ get_RightField()

Field Aspose::Tasks::Visualization::GanttBarStyle::get_RightField ( ) const

Gets data to be displayed on the right of the bar. Field.

◆ get_Row()

int32_t Aspose::Tasks::Visualization::GanttBarStyle::get_Row ( ) const

Gets a row number.

Can be from 1 to 4 (1 is default value).

◆ get_ShowForCategories()

const System::SharedPtr<System::Collections::Generic::IList<GanttBarShowFor> >& Aspose::Tasks::Visualization::GanttBarStyle::get_ShowForCategories ( ) const

Gets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart (see GanttChartView::BarStyles).

◆ get_ShowForTaskUid()

System::Nullable<int32_t> Aspose::Tasks::Visualization::GanttBarStyle::get_ShowForTaskUid ( ) const

Gets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see GanttChartView::CustomBarStyles).

◆ get_StartShape()

GanttBarEndShape Aspose::Tasks::Visualization::GanttBarStyle::get_StartShape ( ) const

Gets a start shape of the bar.

◆ get_StartShapeColor()

System::Drawing::Color Aspose::Tasks::Visualization::GanttBarStyle::get_StartShapeColor ( ) const

Gets a color of the start shape.

◆ get_StartShapeType()

GanttBarType Aspose::Tasks::Visualization::GanttBarStyle::get_StartShapeType ( ) const

Gets a type of the start shape.

◆ get_To()

Field Aspose::Tasks::Visualization::GanttBarStyle::get_To ( ) const

Gets a finish point position of the gantt bar.

◆ get_TopBarTextConverter()

TaskBarTextConverter Aspose::Tasks::Visualization::GanttBarStyle::get_TopBarTextConverter ( ) const

Gets user-defined converter to get text to render on the top of the task's bar. Overrides the value of TopField property.

Is not persisted to MPP format.

◆ get_TopField()

Field Aspose::Tasks::Visualization::GanttBarStyle::get_TopField ( ) const

Gets data to be displayed on the top of the bar.

◆ set_BottomBarTextConverter()

void Aspose::Tasks::Visualization::GanttBarStyle::set_BottomBarTextConverter ( TaskBarTextConverter  value)

Sets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of BottomField property.

Is not persisted to MPP format.

◆ set_BottomField()

void Aspose::Tasks::Visualization::GanttBarStyle::set_BottomField ( Field  value)

Sets data to be displayed on the bottom of the bar. Field.

◆ set_EndShape()

void Aspose::Tasks::Visualization::GanttBarStyle::set_EndShape ( GanttBarEndShape  value)

Sets an end shape of the bar.

◆ set_EndShapeColor()

void Aspose::Tasks::Visualization::GanttBarStyle::set_EndShapeColor ( System::Drawing::Color  value)

Sets a color of the end shape.

◆ set_EndShapeType()

void Aspose::Tasks::Visualization::GanttBarStyle::set_EndShapeType ( GanttBarType  value)

Sets a type of the end shape. GanttBarType.

◆ set_From()

void Aspose::Tasks::Visualization::GanttBarStyle::set_From ( Field  value)

Sets a start point position of the gantt bar. Field.

◆ set_InsideBarTextConverter()

void Aspose::Tasks::Visualization::GanttBarStyle::set_InsideBarTextConverter ( TaskBarTextConverter  value)

Sets user-defined converter to get text to render inside of the task's bar. Overrides the value of InsideField property.

Is not persisted to MPP format.

◆ set_InsideField()

void Aspose::Tasks::Visualization::GanttBarStyle::set_InsideField ( Field  value)

Sets data to be displayed inside of the bar. Field.

◆ set_LeftBarTextConverter()

void Aspose::Tasks::Visualization::GanttBarStyle::set_LeftBarTextConverter ( TaskBarTextConverter  value)

Sets user-defined converter to get text to render on the left of the task's bar. Overrides the value of LeftField property.

Is not persisted to MPP format.

◆ set_LeftField()

void Aspose::Tasks::Visualization::GanttBarStyle::set_LeftField ( Field  value)

Sets data to be displayed on the left of the bar. Field.

◆ set_MiddleFillPattern()

void Aspose::Tasks::Visualization::GanttBarStyle::set_MiddleFillPattern ( GanttBarFillPattern  value)

Sets a fill pattern of the gantt bar.

◆ set_MiddleShape()

void Aspose::Tasks::Visualization::GanttBarStyle::set_MiddleShape ( GanttBarMiddleShape  value)

Sets a middle shape of the bar.

◆ set_MiddleShapeColor()

void Aspose::Tasks::Visualization::GanttBarStyle::set_MiddleShapeColor ( System::Drawing::Color  value)

Sets a color of the middle shape.

◆ set_Name()

void Aspose::Tasks::Visualization::GanttBarStyle::set_Name ( const System::String &  value)

Sets a name of the style.

◆ set_ParentStyle()

void Aspose::Tasks::Visualization::GanttBarStyle::set_ParentStyle ( const System::SharedPtr< GanttBarStyle > &  value)

Sets parent (or common) style for custom task-specific style.

Task can have multiple custom styles with different parent styles. For example consider task having custom style with "Critical" parent style and another style with "Normal" parent style. Simply put, if task is critical, the first style is applied. If task becomes non-critical, the second style is applied (this logic is inherited from Microsoft Project Professional).

◆ set_RightBarTextConverter()

void Aspose::Tasks::Visualization::GanttBarStyle::set_RightBarTextConverter ( TaskBarTextConverter  value)

Sets user-defined converter to get text to render on the right of the task's bar. Overrides the value of RightField property.

Is not persisted to MPP format.

◆ set_RightField()

void Aspose::Tasks::Visualization::GanttBarStyle::set_RightField ( Field  value)

Sets data to be displayed on the right of the bar. Field.

◆ set_Row()

void Aspose::Tasks::Visualization::GanttBarStyle::set_Row ( int32_t  value)

Sets a row number.

Can be from 1 to 4 (1 is default value).

◆ set_ShowForCategories()

void Aspose::Tasks::Visualization::GanttBarStyle::set_ShowForCategories ( const System::SharedPtr< System::Collections::Generic::IList< GanttBarShowFor >> &  value)

Sets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart (see GanttChartView::BarStyles).

◆ set_ShowForTaskUid()

void Aspose::Tasks::Visualization::GanttBarStyle::set_ShowForTaskUid ( System::Nullable< int32_t >  value)

Sets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see GanttChartView::CustomBarStyles).

◆ set_StartShape()

void Aspose::Tasks::Visualization::GanttBarStyle::set_StartShape ( GanttBarEndShape  value)

Sets a start shape of the bar.

◆ set_StartShapeColor()

void Aspose::Tasks::Visualization::GanttBarStyle::set_StartShapeColor ( System::Drawing::Color  value)

Sets a color of the start shape.

◆ set_StartShapeType()

void Aspose::Tasks::Visualization::GanttBarStyle::set_StartShapeType ( GanttBarType  value)

Sets a type of the start shape.

◆ set_To()

void Aspose::Tasks::Visualization::GanttBarStyle::set_To ( Field  value)

Sets a finish point position of the gantt bar.

◆ set_TopBarTextConverter()

void Aspose::Tasks::Visualization::GanttBarStyle::set_TopBarTextConverter ( TaskBarTextConverter  value)

Sets user-defined converter to get text to render on the top of the task's bar. Overrides the value of TopField property.

Is not persisted to MPP format.

◆ set_TopField()

void Aspose::Tasks::Visualization::GanttBarStyle::set_TopField ( Field  value)

Sets data to be displayed on the top of the bar.