Class MarqueeBlock

Namespace

Sage.CRM.Blocks

Assembly

SageCRMNet.dll

You use the MarqueeBlock object to add scrolling text, for example a news ticker, to a page. The Marquee block reads from the Custom Captions table for news headlines and news story links and builds a scrolling display. You can control the direction of the scrolling, the positioning, the speed, and the style sheet used. The news content is maintained in CRM in Administration | Translations. The object provides a dismiss button which is overwritten when the news changes.

public class MarqueeBlock : SageCrmBlock

Inheritance

object

SageCrmBlock

MarqueeBlock

Inherited Members

SageCrmBlock.Execute()

SageCrmBlock.Execute(string)

SageCrmBlock.DisplayForm

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

MarqueeBlock()

Initializes a new instance of MarqueeBlock.

public MarqueeBlock()

MarqueeBlock(string)

Initializes a new instance of MarqueeBlock.

public MarqueeBlock(string blockName)

Parameters

blockName string

Block Name.

Properties

HorizontalMax

Specifies the X boundary to the right of the screen for the marquee. The default value is 800. Where HorizontalMin and HorizontalMax differ, the marquee moves horizontally when scrolling.

public int HorizontalMax { get; set; }

Property Value

int

HorizontalMin

The horizontal minimum is the starting point of the marquee on the X-axis. The default value is 0. Where HorizontalMin and HorizontalMax differ, the marquee moves horizontally when scrolling.

public int HorizontalMin { get; set; }

Property Value

int

NewsFamily

Use this to specify a different family of captions to be used to generate the headings for the marquee block. The default value is 'news'.

public string NewsFamily { get; set; }

Property Value

string

ScrollSpeed

Determines the speed of the text as it moves on the screen.

public int ScrollSpeed { get; set; }

Property Value

int

StyleSheet

Allows the alteration of the way the text is displayed. Specify a cascading style sheet that includes the styles you require for the marquee.

public string StyleSheet { get; set; }

Property Value

string

Title

The title of the marquee block.

public string Title { get; set; }

Property Value

string

VerticalMax

Specifies the maximum vertical position of the marquee before returning to the VerticalMin value. The default value is 300. Where VerticalMin and VerticalMax differ, the marquee moves vertically when scrolling.

public int VerticalMax { get; set; }

Property Value

int

VerticalMin

Specifies the Y location of the marquee as it appears in the browser window, where 0 is at the top of the screen. The default value is 300. Where VerticalMin and VerticalMax differ, the marquee moves vertically when scrolling.

public int VerticalMin { get; set; }

Property Value

int

Methods

~MarqueeBlock()

Releases all resources that have been acquired by the MarqueeBlock class.

protected ~MarqueeBlock()

ScrollSideways(int)

Sets the marquee block to scroll from side to side at a given height.

public void ScrollSideways(int rowPos)

Parameters

rowPos int

The height at which the line should scroll.

ScrollUpAndDown(int)

Sets the marquee block to scroll up and down at a given position.

public void ScrollUpAndDown(int colPos)

Parameters

colPos int

The column position at which to scroll.