New Members and Constants

Publisher Developer Reference

New Members

The following properties, methods, and events are added to existing objects in Microsoft Office Publisher 2007.

AdvancedPrintOptions

Properties Description
BackSideInsertFaceUp Gets or sets whether envelopes fed to the printer's manual feed should be inserted back-side first and face up. Read/write.
ManualFeedAlign Gets or sets the alignment (left, right, or center) of text printed on envelopes fed to the printer's manual feed. Read/write.
ManualFeedDirection Gets or sets the orientation (landscape or portrait) of text printed on envelopes fed to the printer's manual feed. Read/write.
PageRotated Gets or sets whether the printed page is rotated 180 degrees. Read/write.

Application

Properties Description
Assistance Gets a reference to the Microsoft Office (MSO) IAssistance object, which provides a means for developers to create a customized Help experience for users within Microsoft Office. Read-only.
AutomationSecurity Specifies the security mode that Microsoft Office Publisher uses when programmatically opening files. Read/write.
InsertBarcodeVisible Determines whether Add a postal bar code is available under More Items on the Mail Merge and Catalog Merge task panes in the Microsoft Office Publisher user interface (UI); and whether Add postal bar codes is available under Prepare for Mailing on the Publisher Tasks task pane in the Publisher UI. Read/write.
InstalledPrinters Gets the names of all printers installed on the computer and to which the application can print the publication. Read-only.
ShowFollowUpCustom Gets or sets the string, if any, that appears as the fourth item under Prepare to follow-up on this mailing on the third Mail Merge task pane in the Microsoft Office Publisher user interface. Read/write.
ValidateAddressVisible Determines whether Validate addresses is available under Refine recipients in the Mail Merge Recipients dialog box in the Microsoft Office Publisher user interface (UI); and whether Validate addresses is available under Prepare for Mailing on the Publisher Tasks task pane in the Publisher UI. Read/write.
Methods Description
ShowWizardCatalog Displays the Publication Types catalog for the wizard of the specified type.
Events Description
AfterPrint Occurs after all variables and fields are printed. User interface control does not return to the user until the event handler is executed. The event is called after all the drawing operations are complete (in other words, after the software's job is complete and the printing hardware takes over).
BeforePrint Occurs before the publication is printed or previewed. This event fires only after the document fully loads and the onload events are returned. Printing does not occur until the event handler executes.
HideCatalogUI Occurs when the catalog of publication wizards is hidden in the Microsoft Office Publisher user interface.
MailMergeGenerateBarcode Occurs when Microsoft Office Publisher requires data to generate barcodes in a mail-merge publication, in particular when the mail-merge recipient list changes.
MailMergeInsertBarcode Occurs when the user issues the command to insert postal barcodes into a mail-merge publication, either in the Microsoft Office Publisher user interface (UI), or programmatically.
MailMergeRecipientListClose Fires when the user closes the Mail Merge Recipients dialog box. (From the Mail Merge or E-mail Merge task pane, click Edit Recipient List). Also fires when the user closes the Catalog Merge Product List dialog box, which opens when the user clicks Edit Product List in the Catalog Merge task pane.
MailMergeWizardFollowUpCustom Fires when the string that appears as the fourth item under Prepare to follow-up on this mailing on the third Mail Merge task pane in the Microsoft Office Publisher user interface is clicked.
ShowCatalogUI Fires when the catalog of publication wizards is displayed in the Microsoft Office Publisher user interface.

ColorFormat

Properties Description
BaseCMYK Returns the base cyan-magenta-yellow-black (CMYK) color value of the parent ColorFormat object before any tinting or shading is applied to the color. Read-only.
Transparency Returns or sets a Single indicating the degree of transparency of the specified fill, shadow, or line as a value between 0.0 (opaque) and 1.0 (clear). Read/write.

Document

Properties Description
SurplusShapes Returns a ShapeRange object that represents the collection of surplus shapes that Microsoft Office Publisher places under Extra Content in the Format Publication task pane after the document template (wizard) is changed by using the Document.ChangeDocument method or by using the Change Template command in the user interface. Read-only.
Methods Description
ChangeDocument Changes the current publication to one that uses the wizard, and optionally the design, that you specify.
ExportAsFixedFormat This method converts a Microsoft Office Publisher publication into PDF format. The conversion readies the document to be sent to commercial presses, to copy shops, for desktop printing, or for electronic distribution.
SetBusinessInformation The method helps store the business information. Business information consists of a logo image and business contact information, such as the company name and address.

MailMerge

Properties Description
EmailMergeEnvelope Returns the EmailMergeEnvelope object associated with the parent MailMerge object. Read-only.
Type Gets or sets the type of mail merge represented by the parent MailMerge object. Read/write.
Methods Description
CreateShortcut Creates a shortcut to the file that contains the list of recipients or products for a mail merge publication.
ExportRecipientList Exports the list of mail-merge recipients to a Microsoft Office Access (.mdb) file or to a comma-delimited text (.csv) file.

MailMergeDataField

Properties Description
IsMapped Indicates if the parent MailMergeDataField object is mapped to a recipient field in the master data source (combined mail-merge recipient list). Read-only.
MappedTo Returns the name of the recipient field (column) in the master data source (combined mail-merge recipient list) that the parent MailMergeDataField object is mapped to. Read-only.
Methods Description
AddToRecipientFields Adds the parent MailMergeDataField object from a particular data source to the master data source (collection of data fields) for a mail-merge publication.
MapToRecipientField Maps a field (column) in a particular data source represented by the parent MailMergeDataField object to a recipient field (column) in the master data source (combined mail-merge recipient list).
UnMapRecipientField Undoes the mapping between the parent MailMergeDataField object in a particular data source and the recipient field in the master data source (combined mail-merge recipient list) to which it is currently mapped.

MailMergeDataSource

Properties Description
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 was ever validated. 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.
ValidatedClean Indicates whether all recipient addresses in the the parent MailMergeDataSource object were successfully validated, and whether any changes were made to the list since the last validation that require the list to be validated again. Read/write.
Methods Description
EditRecord Changes one of the data fields in one of the records in the master data source (the combined mail-merge recipient list).

Options

Properties Description
UseWizardForBlankPublication Gets or sets whether to use a wizard for blank publications. Read/Write.

PageSetup

Properties Description
AvailablePageSizes Returns the PageSizes collection that contains all the PageSize objects available in the current publication.
PageSize Returns or sets the page size for the specified custom mailing label. Read/write.

PictureFormat

Properties Description
IsRecolored Returns True if the image represented by the parent PictureFormat object was recolored, either in the user interface or by using the PictureFormat.Recolor method. Read-only.
LeaveBlackAsBlack Returns True if, while recoloring, the black portion of the original image should be left as black. Read-only.
RecoloredPictureColor Returns the color that is applied to the image represented by the parent PictureFormat object. Read-only.
Methods Description
Recolor Changes the color of a picture in a publication.
RestoreOriginalColors Restores the original colors of a picture that was recolored.

Shape

Properties Description
IsExcess Indicates whether the parent Shape object is an excess shape after the document template (wizard) is changed by using the Document.ChangeDocument method or by using the Change Template command in the user interface. Microsoft Office Publisher places any excess shape under Extra Content in the Format Publication task pane. Read-only.
Methods Description
MoveToPage The function is used to move a shape to the page specified in the argument.
SaveAsPicture Saves a shape to a picture file.

ShapeRange

Methods Description
SaveAsPicture Saves multiple shapes to a picture file.

TextFrame

Properties Description
IncludeContinuedFromPage Determines whether the text "Continued from page pagenumber" appears in a text box when Microsoft Office Publisher automatically fits text to the text box. Read/write.
IncludeContinuedOnPage Determines whether the text "Continued on page pagenumber" appears in a text box when Microsoft Office Publisher automatically fits text to the text box. Read/write.

TextRange

Properties Description
LinesCount Returns the number of lines of text in the text range represented by the parent TextRange object. Read-only.
ParagraphsCount Returns the number of paragraphs of text in the text range represented by the parent TextRange object. Read-only.
WordsCount Returns the number of words in the text range represented by the parent TextRange object. Read-only.
Methods Description
InsertBarcode Inserts a bar code field at the end of the text range represented by the parent TextRange object.

Wizard

Methods Description
SetId Specifies the type of the wizard (template) to which to convert the current publication type.

New Constants

The following constants are added to existing enumerations in Microsoft Office Publisher 2007.

Enumeration New Constants
PbFieldType pbFieldPersonalizedHyperlinkURL
PbFileFormat pbFilePlainText pbFileUnicodeText
PbHlinkTargetType pbHlinkTargetTypePersonalized
PbMailMergeDataSource pbMergeInfoSubODSO
PbMailMergeDestination pbSendEmail
PbWizard pbWizardEmailAutomatic