Caplin.DataSource.Messaging.Page.IPageMessage Interface Reference

An instance of IPageElement represents an update to a region of a Page. More...

Inheritance diagram for Caplin.DataSource.Messaging.Page.IPageMessage:

Public Member Functions
void	AddField (string fieldName, string value)
	Allows non-text fields to be added to the page. More...
void	Set (int column, int row, string content)
	Updates the contents of the page at the specified location. More...

Properties
int	Height [get, set]
	Gets or sets the height of the page, in text rows. More...
string	PageType [get, set]
	Gets or sets the type of the page. More...
IList< IPageElement >	UpdatedElements [get]
	Gets a read-only list of the updated page elements. More...
int	Width [get, set]
	Gets or sets the width of the page, in text columns. More...
Properties inherited from Caplin.DataSource.Messaging.IMessage
bool	Image [get, set]
	Gets or sets a boolean value indicating whether this IMessage represents an image or an update. More...
string	Subject [get]
	Gets the subject of this message. More...

Detailed Description

An instance of IPageElement represents an update to a region of a Page.

An object implementing this interface can not be instantiated directly, but can be constructed using the IMessageFactory that is available on the IPublisher interface.

If you call Set more than once, and the page regions updated by one or more calls overlap, the updates are still held separately in the message; they are not merged together.

Member Function Documentation

void Caplin.DataSource.Messaging.Page.IPageMessage.AddField	(	string	fieldName,
		string	value
	)

Allows non-text fields to be added to the page.

Parameters

fieldName	Field name to be added.
value	Field value to be added.

Note: The field number corresponding to the fieldName being added must be in the range 0 - 16383

void Caplin.DataSource.Messaging.Page.IPageMessage.Set	(	int	column,
		int	row,
		string	content
	)

Updates the contents of the page at the specified location.

Parameters

column	The column at which the content is to be updated. The leftmost column of the page is column 0.
row	The row at which the content is/IPermissionMessage.cs#3 to be updated. The top row of the page is row 0.
content	The page content to be placed at the specified row and column.

Property Documentation

int Caplin.DataSource.Messaging.Page.IPageMessage.Height

getset

Gets or sets the height of the page, in text rows.

This value is valid on all IPageMessage instances created using the IMessageFactory interface, however it may be undefined (and hence have a value of -1) on instances received by an implementation of ISubscriptionListener.

The first character on a page is at row zero. Therefore the maximum modifiable column is at row (Height - 1).

string Caplin.DataSource.Messaging.Page.IPageMessage.PageType

getset

Gets or sets the type of the page.

The type of the page.

The type of the page is available to StreamLink clients and can be used to control the display of the page.

IList<IPageElement> Caplin.DataSource.Messaging.Page.IPageMessage.UpdatedElements

get

Gets a read-only list of the updated page elements.

The updated page elements.

int Caplin.DataSource.Messaging.Page.IPageMessage.Width

getset

Gets or sets the width of the page, in text columns.

This value is valid on all IPageMessage instances created using the IMessageFactory interface. However it may be undefined (and hence have a value of -1) on instances received by an implementation of ISubscriptionListener.

The first character on a page is at column zero. Therefore the maximum modifiable column is at position (Width - 1).