Represents an update to a container subject. More...

Inheritance diagram for Caplin.StreamLink.IContainerEvent:

Public Member Functions
void	UpdateModel (Caplin.StreamLink.IContainerModel containerModel)
	Update your implementation of IContainerModel with the contents of this ContainerEvent. More...

Properties
int	Size `[get]`
	Gets the size of the container. More...

int	WindowEnd `[get]`
	Gets the index of the end of the container window. More...

int	WindowStart `[get]`
	Gets the index of the start of the window. More...

Properties inherited from Caplin.StreamLink.IDataEvent
bool	IsImage `[get]`
	Returns whether this was an image event or an update event. More...

string	Subject `[get]`
	Returns the subject to which the event relates. More...

Detailed Description

Represents an update to a container subject.

The ContainerEvent will be provided on a onContainerUpdate callback to a ISubscriptionListener.

Member Function Documentation

void Caplin.StreamLink.IContainerEvent.UpdateModel ( Caplin.StreamLink.IContainerModel containerModel )

Update your implementation of IContainerModel with the contents of this ContainerEvent.

Parameters

containerModel Your implementation of IContainerModel that should be updated with the contents of this ContainerEvent.

int Caplin.StreamLink.IContainerEvent.Size

get

Gets the size of the container.

The value returned here is the true size of the container, which may be larger than the size of the container window that you have subscribed to.

The value returned here is useful for sizing the scroll bars of a data view showing the elements within a container.

The size of the container.

int Caplin.StreamLink.IContainerEvent.WindowEnd

get

Gets the index of the end of the container window.

The end of the window, or -1 if no window has been specified.

int Caplin.StreamLink.IContainerEvent.WindowStart

get

Gets the index of the start of the window.

The start of the window, or -1 if no window has been specified.