PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T > Interface Template Reference

An object that may be used to update a paged topic. More...

Public Member Functions
void	Add (T line)
	Add a line to the data. More...
void	Add (int index, T line)
	Add (insert) a line to the data at the specified index. More...
void	Add (ICollection< T > lines)
	Add one more lines to the data. More...
void	Add (int index, ICollection< T > lines)
	Add (insert) one or more lines to the data at the specified index. More...
void	Update (int index, T line)
	Update the line at the specified index with a given value. More...
void	Update (T line)
	Update a line of data. More...
void	Update (ICollection< T > lines)
	Update one or more lines of data. More...
void	Remove (T line)
	Remove a line of data. More...
void	Remove (ICollection< T > lines)
	Remove one or more lines of data. More...
void	Remove (int index, int number)
	Removes one or more lines from the data. More...

Properties
ITopicPathSelector	Topic [get]
	Returns the topic that the updater is associated with. More...

Detailed Description

An object that may be used to update a paged topic.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Add

(

T

line

)

Add a line to the data.

If the data is ordered then the line will be inserted at the position indicated by its comparator. For unordered data the line is added to the end of the data.

Parameters

line	The line to add.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Add	(	int	index,
		T	line
	)

Add (insert) a line to the data at the specified index.

Parameters

index	The index (zero-based).
line	The line to add.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Add

(

ICollection< T >

lines

)

Add one more lines to the data.

If the data is ordered then the lines will be inserted one by one at the position indicated by the comparator. For unordered data the lines are added to the end of the data.

Parameters

lines

The lines to add.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Add	(	int	index,
		ICollection< T >	lines
	)

Add (insert) one or more lines to the data at the specified index.

This may only be used for unordered data.

Parameters

index	The index (zero-based) to add lines at.
lines	The lines to add.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Remove

(

T

line

)

Remove a line of data.

This only applies to ordered data. This will remove the line that matches the specified record.

Parameters

line	The line to remove.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Remove

(

ICollection< T >

lines

)

Remove one or more lines of data.

This only applies to ordered data and is effectively the same as multiple removes performed one at a time.

Parameters

lines

The lines to use for removes.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Remove	(	int	index,
		int	number
	)

Removes one or more lines from the data.

This may be used on ordered as well as non-ordered data.

Parameters

index	The first index to remove. If this is negative then 0 is assumed. If this is beyond the last line then no lines are removed.
number	The number of lines to remove. If this is negative or more than the number of lines after the specified index then all lines to the end are removed.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Update	(	int	index,
		T	line
	)

Update the line at the specified index with a given value.

Parameters

index	The index of the line to update.
line	The new value. Specifying a value of null will remove the line.

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Update

(

T

line

)

Update a line of data.

This only applies to ordered data. The action of an update will be to remove any line that matches the supplied record and then add the record.

Parameters

line

void PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Update

(

ICollection< T >

lines

)

Update one or more lines of data.

This only applies to ordered data and is effectively the same as multiple updates performed one at a time.

Parameters

lines

The lines to use for updates.

Property Documentation

ITopicPathSelector PushTechnology.ClientInterface.Client.Features.Control.Topics.IPagingControlUpdater< T >.Topic

get

Returns the topic that the updater is associated with.

---

The documentation for this interface was generated from the following file:

• UCIStack/Client/Features/Control/Topics/IPagingControlUpdater.cs