Table of Contents

Class PipelineGraphicBlock

Namespace
Sage.CRM.Blocks
Assembly
SageCRMNet.dll

The PipelineGraphicBlock is an implementation of the Graphic Block that includes extra functionality. You use the PipelineGraphicBlock to create cross-sectional diagrams that can represent data from an Application Extension or data from a table. You use the parameters of this block to change the look and feel of the pipeline.

public class PipelineGraphicBlock : GraphicBlock
Inheritance
PipelineGraphicBlock
Inherited Members

Constructors

PipelineGraphicBlock()

Initializes a new instance of PipelineGraphicBlock.

public PipelineGraphicBlock()

PipelineGraphicBlock(string)

Initializes a new instance of PipelineGraphicBlock.

public PipelineGraphicBlock(string blockName)

Parameters

blockName string

Block Name.

Properties

Selected

Sets a section of the pipeline so that you can alter the style of that section when it is clicked on. Value is the number of the section that you are selecting.

public int Selected { get; set; }

Property Value

int

Summary

Enables you to enter HTML text that displays to the right of a pipeline section when the section is selected. You can also use this property to display a legend/description of what is selected.

public string Summary { get; set; }

Property Value

string

Methods

AddPipeEntry(string, int, string, string, int)

Overload of AddPipeEntry to allow a color index to be set on a section of the pipeline

public void AddPipeEntry(string name, int value, string description, string url, int colorIndex)

Parameters

name string

The name of the section of the pipe that is shown in the Legend for the pipeline.

value int

The value determines the size that this particular pipeline takes. Each section of pipe fills a percentage of the image width that is directly determined by its value.

description string

The text that appears when the user hovers over that section of pipe.

url string

The Web address (or ASP page) to link to should the user click on that section of the pipe.

colorIndex int

Index of color.

Examples

SageCrmPipelineGraphicBlock MyPipe;
MyPipe = New PipelineGraphicBlock();
MyPipe.AddPipeEntry("Sold", 100,"100items sold", "http://www.eware.com");
MyPipe.AddPipeEntry("Prospect", 40,"40prospects", "http://www.yahoo.com");
AddContent(MyPipe.Execute());

AddPipeEntry(string, int, string, string)

Overload of AddPipeEntry to allow description and URLs to be added to the pipeline sections.

public void AddPipeEntry(string name, int value, string description, string url)

Parameters

name string

The name of the section of the pipe that is shown in the Legend for the pipeline.

value int

The value determines the size that this particular pipeline takes. Each section of pipe fills a percentage of the image width that is directly determined by its value.

description string

The text that appears when the user hovers over that section of pipe.

url string

The Web address (or ASP page) to link to should the user click on that section of the pipe.

AddPipeEntry(string, int)

The easiest way to create a pipeline diagram is to build it up one section at a time using the AddPipeEntry command.

public void AddPipeEntry(string name, int value)

Parameters

name string

The name of the section of the pipe that is shown in the Legend for the pipeline.

value int

The value determines the size that this particular pipeline takes. Each section of pipe fills a percentage of the image width that is directly determined by its value.

ChooseBackground(int)

Sets the background of the pipeline graphic. Default is white.

public bool ChooseBackground(int value)

Parameters

value int

Integer value for different background images. The images are loaded by default into the CRM images directory during installation.

Returns

bool

~PipelineGraphicBlock()

Destructor for the PipelineGraphicBlock.

protected ~PipelineGraphicBlock()

PipelineStyle(PipelineStyles, string)

You can set various parameters of the PipelineGraphic block to change the appearance and size of individual sections of the pipeline. These parameters include adding gradients, displaying legends and adjusting diameters.

public bool PipelineStyle(PipelineStyles property, string value)

Parameters

property PipelineStyles

Sage.Graphics.PipelineStyles

value string

Returns

bool

PipelineStyle(string, string)

You can set various parameters of the PipelineGraphic block to change the appearance and size of individual sections of the pipeline. These parameters include adding gradients, displaying legends and adjusting diameters.

public bool PipelineStyle(string property, string value)

Parameters

property string

See Sage.Graphics.PipelineStyles for details

value string

Returns

bool

Examples

SageCrmPipelineGraphicBlock MyPipe; MyPipe = new PipelineGraphicBlock(); MyPipe.AddPipeEntry("Sold", 100,"100items sold", "http://www.eware.com"); MyPipe.AddPipeEntry("Prospect", 40,"40prospects", "http://www.yahoo.com"); MyPipe.PipelineStyle("Shape","Circle"); MyPipe.PipelineStyle("UseGradient","False"); MyPipe.PipelineStyle("Animated","False"); MyPipe.PipelineStyle("Selected","Sold"); MyPipe.PipelineStyle("SelectedWidth","10"); MyPipe.PipelineStyle("SelectedHeight","10"); MyPipe.PipelineStyle("PipeWidth","40"); MyPipe.PipelineStyle("PipeHeight","60"); MyPipe.PipelineStyle("ShowLegend","True"); AddContent(MyPipe.Execute());