BarStyle

BarStyle class

Change the visual style of the bar for the item in the project view.

public class BarStyle

Constructors

Name Description
BarStyle() Initializes a new instance of the BarStyle class.

Properties

Name Description
BarColor { get; set; } Gets or sets Color of the bar style.
BarShape { get; set; } Gets or sets BarShape of the bar style.
BottomBarTextConverter { get; set; } Gets or sets user-defined converter to get text to render on the bottom of the task’s bar. Overrides the value of BottomField property.
BottomField { get; set; } Gets or sets a field to be displayed on the bottom of the bar.
EndShape { get; set; } Gets or sets Shape at the end of the bar.
EndShapeColor { get; set; } Gets or sets Color of the shape at the end of the bar.
InsideBarTextConverter { get; set; } Gets or sets user-defined converter to get text to render inside of the task’s bar. Overrides the value of InsideField property.
InsideField { get; set; } Gets or sets a field to be displayed inside of the bar.
ItemType { get; set; } Gets or sets BarItemType of the bar style.
LeftBarTextConverter { get; set; } Gets or sets user-defined converter to get text to render on the left of the task’s bar. Overrides the value of LeftField property.
LeftField { get; set; } Gets or sets a field to be displayed on the left of the bar.
RightBarTextConverter { get; set; } Gets or sets user-defined converter to get text to render on the right of the task’s bar. Overrides the value of RightField property.
RightField { get; set; } Gets or sets a field to be displayed on the right of the bar.
StartShape { get; set; } Gets or sets Shape at the beginning of the bar.
StartShapeColor { get; set; } Gets or sets Color of the shape at the beginning of the bar.
TextStyle { get; set; } Gets or sets style of the bar’s text.
TopBarTextConverter { get; set; } Gets or sets user-defined converter to get text to render on the top of the task’s bar. Overrides the value of TopField property.
TopField { get; set; } Gets or sets a field to be displayed on the top of the bar.

Examples

Shows how to use custom bar styles.

var project = new Project(DataDir + "Project2.mpp");
SaveOptions options = new PdfSaveOptions
{
    BarStyles = new List<BarStyle>()
};

// add a bar style for milestone tasks
var style = new BarStyle();
// set <see cref="T:Aspose.Tasks.Visualization.BarItemType" /> of the bar style
style.ItemType = BarItemType.Milestone;
// set <see cref="T:System.Drawing.Color" /> of the bar style.
style.BarColor = Color.Green;
// set <see cref="P:Aspose.Tasks.Visualization.BarStyle.BarShape" /> of the bar style
style.BarShape = BarShape.HalfHeight;
// set <see cref="T:Aspose.Tasks.Visualization.Shape" /> at the beginning of the bar
style.StartShape = Shape.LeftBracket;
// set <see cref="T:System.Drawing.Color" /> of the shape at the beginning of the bar
style.StartShapeColor = Color.Aqua;
// set <see cref="T:Aspose.Tasks.Visualization.Shape" /> at the end of the bar
style.EndShape = Shape.RightBracket;
// set <see cref="T:System.Drawing.Color" /> of the shape at the end of the bar
style.EndShapeColor = Color.Aquamarine;
// set of the text to render on the right of the bar.
style.TextStyle = new TextStyle();
style.TextStyle.BackgroundColor = Color.Black;

// there is exists a feature that allow to convert a text of the bar
// lets set converter to get text for the bar to render.
style.LeftBarTextConverter = task =>
{
    if (!task.Get(Tsk.Name).StartsWith("T"))
    {
        task.Set(Tsk.Name, "T" + task.Get(Tsk.Name));
    }

    return task.Get(Tsk.Name);
};

options.BarStyles.Add(style);

// save the project
project.Save(OutDir + "WorkWithBarStyle_out.mpp", options);

See Also