ClassMailMergeDataSource
Represents a data source for performing mail merge operations in Telerik's document model.
Definition
Namespace:Telerik.Windows.Documents.Model
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class MailMergeDataSource : DependencyObjectInheritance: objectMailMergeDataSource
Constructors
MailMergeDataSource()
Declaration
public MailMergeDataSource()Fields
ItemsSourceProperty
Declaration
public static readonly DependencyProperty ItemsSourcePropertyField Value
DependencyProperty
Properties
CurrentItem
Gets the current item in the data source for the mail merge operation.
CurrentItemIndex
Gets or sets the zero-based index of the current item in the mail merge data source.
Declaration
public int CurrentItemIndex { get; }Property Value
The zero-based index of the current item. A value of -1 indicates that no item is currently selected.
ItemsSource
Gets or sets the collection of data items that will be used as the source for the mail merge operation.
Declaration
public IEnumerable ItemsSource { get; set; }Property Value
Methods
GetColumnNames()
Retrieves the names of the columns available in the mail merge data source.
Declaration
public string[] GetColumnNames()Returns
string[]
An array of strings containing the names of the columns.
MoveToFirst()
Moves the cursor to the first element in the Mail Merge data source.
Declaration
public bool MoveToFirst()Returns
True if the cursor was successfully moved to the first element; otherwise, false.
MoveToIndex(int)
Moves the data source to the specified index.
MoveToLast()
Moves the data source to the last record in the collection.
Declaration
public bool MoveToLast()Returns
True if the operation was successful; otherwise, false.
Remarks
This method allows you to navigate to the last item of the mail merge data source.
MoveToNext()
Moves the data source to the next record, preparing it for the next data retrieval operation.
Declaration
public bool MoveToNext()Returns
A boolean value indicating whether the move was successful and there is a next record available.
MoveToPrevious()
Moves the data source cursor to the previous record in the mail merge data source.
Declaration
public bool MoveToPrevious()Returns
Returns a boolean value indicating whether the cursor was successfully moved to the previous record.