MailMergeDataSource Object Members
Publisher Developer Reference |
Represents the data source in a mail merge or catalog merge operation.
Methods
Name | Description | |
---|---|---|
ApplyFilter | Applies a filter to a mail merge data source to remove (or filter out) specified records containing (or not containing) specific data. | |
Close | Closes the specified mail merge data source, cancels the mail merge, and converts all mail merge data fields to plain text. | |
EditRecord | Changes one of the data fields in one of the records in the master data source (the combined mail-merge recipient list). | |
FindRecord | Searches the contents of the specified mail merge data source for text in a particular field. Returns a Boolean indicating whether the search text is found; True if the search text is found. | |
OpenRecipientsDialog | Displays the Recipients dialog box for a mail merge publication. | |
SetAllErrorFlags | Marks all records in a mail merge data source as containing invalid data in an address field. | |
SetAllIncludedFlags | True to include all data source records in a mail merge. | |
SetSortOrder | Sets the sort order for mail merge data. |
Properties
Name | Description | |
---|---|---|
ActiveRecord | Returns or sets a Long that represents the active mail merge data record. Read/write. | |
Application | Used without an object qualifier, this property returns an Application object that represents the current instance of Publisher. Used with an object qualifier, this property returns an Application object that represents the creator of the specified object. When used with an OLE Automation object, it returns the object's application. | |
ConnectString | Returns a String that represents the connection to the specified mail merge data source. Read-only. | |
DataFields | Returns a MailMergeDataFields collection that represents the fields in the specified data source. | |
DataSources | Returns the MailMergeDataSources collection that includes the parent MailMergeDataSource object. Read-only. | |
EverValidated | Indicates whether the list of recipient addresses in the parent MailMergeDataSource object has ever been validated. Read/write. | |
Filters | Returns a MailMergeFilters object that represents filters applied to the mail merge or catalog merge data source. | |
FirstRecord | Returns or sets a Long that represents the number of the first data record to be merged in a mail merge or catalog merge operation. Read/write. | |
Included | True if a record is included in a mail merge. Read/write Boolean. | |
InvalidAddress | True to mark a record in a mail merge data source if it contains invalid data. Read/write Boolean. | |
InvalidComments | If the InvalidAddress property is True, this property returns or sets a String that describes invalid data in a mail merge record. Read/write. | |
IsMaster | Indicates whether the parent MailMergeDataSource object is a master data source (a combination of all data sources connected to the current publication). Read-only. | |
LastRecord | Returns or sets a Long that represents the number of the last data record to be merged in a mail merge or catalog merge operation. Read/write. | |
MappedDataFields | Returns a MailMergeMappedDataFields object that represents the mapped data fields available in Microsoft Office Publisher. | |
Name | Returns a String value indicating the name of the specified object. Read-only. | |
Parent | Returns an object that represents the parent object of the specified object. For example, for a TextFrame object, returns a Shape object representing the parent shape of the text frame. Read-only. | |
RecordCount | Returns a Long that represents the number of records in the data source. Read-only. | |
TableName | Returns a String that represents the name of the table within the data source file that contains the mail merge records. The returned value may be blank if the table name is unknown or not applicable to the current data source. Read-only. | |
Type | Returns a Long that represents the type of mail merge or catalog merge data source. Read-only. | |
ValidatedClean | Indicates whether all recipient addresses in the the parent MailMergeDataSource object were successfully validated, and whether any changes have been made to the list since the last validation that require the list to be validated again. Read/write. |