Document Object Members

  • Article
Publisher Developer Reference

Represents a publication.

Methods

  Name Description
Aa437613.methods(en-us,office.12).gif BeginCustomUndoAction Specifies the starting point and label (textual description) of a group of actions that are wrapped to create a single undo action. The EndCustomUndoAction method is used to specify the end point of the actions used to create the single undo action. The wrapped group of actions can be undone with a single undo.
Aa437613.methods(en-us,office.12).gif ChangeDocument Changes the current publication to one that uses the wizard, and optionally the design, that you specify.
Aa437613.methods(en-us,office.12).gif Close Closes the current publication and creates a blank one in its place.
Aa437613.methods(en-us,office.12).gif ConvertPublicationType Converts the specified publication to the specified publication type.
Aa437613.methods(en-us,office.12).gif CreatePlateCollection Returns a Plates collection that represents a new collection of plates for commercial print separations.
Aa437613.methods(en-us,office.12).gif EndCustomUndoAction Specifies the end point of a group of actions that are wrapped to create a single undo action. The BeginCustomUndoAction Method method is used to specify the starting point and label (textual description) of the actions used to create the single undo action. The wrapped group of actions can be undone with a single undo.
Aa437613.methods(en-us,office.12).gif EnterColorMode Accesses the color mode for the publication.
Aa437613.methods(en-us,office.12).gif 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.
Aa437613.methods(en-us,office.12).gif FindShapeByWizardTag Returns a ShapeRange object representing one or all of the shapes placed in a publication by a wizard and bearing the specified wizard tag.
Aa437613.methods(en-us,office.12).gif FindShapesByTag Returns a ShapeRange object that represents the shapes with the specified tag.
Aa437613.methods(en-us,office.12).gif PrintOutEx Prints all or part of the specified publication.
Aa437613.methods(en-us,office.12).gif Redo Redoes the last action or a specified number of actions. Corresponds to the list of items that appears when you click the arrow beside the Redo button on the Standard toolbar. Calling this method reverses the Undo Method method.
Aa437613.methods(en-us,office.12).gif Save Saves the specified publication.
Aa437613.methods(en-us,office.12).gif SaveAs Saves the specified publication with a new name or format.
Aa437613.methods(en-us,office.12).gif 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.
Aa437613.methods(en-us,office.12).gif Undo Undoes the last action or a specified number of actions. Corresponds to the list of items that appears when you click the arrow beside the Undo button on the Standard toolbar.
Aa437613.methods(en-us,office.12).gif UndoClear Clears the list of actions that can be undone for the specified publication. Corresponds to the list of items that appears when you click the arrow beside the Undo button on the Standard toolbar.
Aa437613.methods(en-us,office.12).gif UpdateOLEObjects Updates linked and embedded OLE objects.
Aa437613.methods(en-us,office.12).gif WebPagePreview Generates a Web page preview of the specified publication in Internet Explorer.

Properties

  Name Description
Aa437613.properties(en-us,office.12).gif ActiveView Returns a View object representing the view attributes for the specified document. Read-only.
Aa437613.properties(en-us,office.12).gif ActiveWindow Returns a Window object that represents the window with the focus. Because Microsoft Publisher only has one window, there is only one Window object to return.
Aa437613.properties(en-us,office.12).gif AdvancedPrintOptions Returns an AdvancedPrintOptions object that represents the advanced print settings for a publication. Read-only.
Aa437613.properties(en-us,office.12).gif 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.
Aa437613.properties(en-us,office.12).gif BorderArts Returns a BorderArts collection that represents the BorderArt types available for use in the specified publication. Read-only.
Aa437613.properties(en-us,office.12).gif ColorMode Returns a PbColorMode constant that represents the color mode for the publication. Read-only.
Aa437613.properties(en-us,office.12).gif ColorScheme Returns or sets the ColorScheme object that represents the scheme colors for the specified publication. Read/write.
Aa437613.properties(en-us,office.12).gif ColorsInUse Returns a ColorsInUse collection that represents the colors present in the current publication. Read-only.
Aa437613.properties(en-us,office.12).gif DefaultTabStop Returns or sets a Variant corresponding to the default tab stop for all text in the active publication. Valid range is 1 to 1584 points (0.014" to 22"). Once set, numeric values are considered to be in points. String values may be in any unit supported by Microsoft Office Publisher. Point values are always returned. If values are outside the valid range, an error is returned. Read/write.
Aa437613.properties(en-us,office.12).gif DocumentDirection Returns or sets a PbDirectionType constant that indicates whether text in the document is read from left to right or from right to left. Read/write.
Aa437613.properties(en-us,office.12).gif EnvelopeVisible Returns or sets a Boolean indicating whether the e-mail message header is visible in the publication window. Read/write.
Aa437613.properties(en-us,office.12).gif Find Returns a FindReplace object. The FindReplace object is used to perform a text search and replace in the specified document.
Aa437613.properties(en-us,office.12).gif FullName Returns a String representing the full file name of the saved active publication, including its path and file name. Read-only.
Aa437613.properties(en-us,office.12).gif IsDataSourceConnected True if the specified publication is connected to a data source. Read-only.
Aa437613.properties(en-us,office.12).gif IsWizard Returns True if the specified publication is a publication generated by a Microsoft Office Publisher wizard. Read-only Boolean.
Aa437613.properties(en-us,office.12).gif LayoutGuides Returns a LayoutGuides object consisting of the margin and grid layout guides for all pages including master pages in the publication.
Aa437613.properties(en-us,office.12).gif MailEnvelope Returns an MsoEnvelope object that represents an e-mail header for a publication.
Aa437613.properties(en-us,office.12).gif MailMerge Returns a MailMerge object that represents the mail merge functionality for the specified publication.
Aa437613.properties(en-us,office.12).gif MasterPages Returns the MasterPages collection for the specified publication.
Aa437613.properties(en-us,office.12).gif Name Returns a String value indicating the name of the specified object. Read-only.
Aa437613.properties(en-us,office.12).gif Pages Returns a Pages collection representing all the pages in the specified publication.
Aa437613.properties(en-us,office.12).gif PageSetup Returns a PageSetup object representing a publication’s page size, page layout and paper settings. Read-only.
Aa437613.properties(en-us,office.12).gif 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.
Aa437613.properties(en-us,office.12).gif Path Returns a String indicating the full path to the file of the saved active publication, not including the last separator or file name.
Aa437613.properties(en-us,office.12).gif Plates Returns a Plates collection representing the color plates for the specified publication.
Aa437613.properties(en-us,office.12).gif PrintPageBackgrounds Returns or sets True to include page backgrounds when printing pages from the specified publication. Default is True. Read/write Boolean.
Aa437613.properties(en-us,office.12).gif PublicationType Returns a PbPublicationType constant that represents the type of the specified publication. Read-only.
Aa437613.properties(en-us,office.12).gif ReadOnly Returns True if the publication is read-only; False if it is read-write. Read-only Boolean.
Aa437613.properties(en-us,office.12).gif RedoActionsAvailable Returns the number of actions available on the redo stack. Read-only Long.
Aa437613.properties(en-us,office.12).gif RemovePersonalInformation Returns or sets a Boolean that represents whether to save personal information when the file is saved. Read/write.
Aa437613.properties(en-us,office.12).gif Saved Returns True if no changes have been made to a publication since it was last saved. Read-only Boolean.
Aa437613.properties(en-us,office.12).gif SaveFormat Returns a PbFileFormat constant indicating the file format of the specified document. Read-only.
Aa437613.properties(en-us,office.12).gif ScratchArea Returns a ScratchArea object for an a given document.
Aa437613.properties(en-us,office.12).gif Sections Returns a Sections object representing a collection of Section objects in the specified document. Read-only Sections.
Aa437613.properties(en-us,office.12).gif Selection Returns a Selection object that represents a selected range or the insertion point.
Aa437613.properties(en-us,office.12).gif Stories Returns a Stories collection containing all stories in the publication.
Aa437613.properties(en-us,office.12).gif 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.
Aa437613.properties(en-us,office.12).gif Tags Returns a Tags collection representing tags or custom properties applied to a shape, shape range, page, or publication.
Aa437613.properties(en-us,office.12).gif TextStyles Returns a TextStyles collection that contains a publication's text styles.
Aa437613.properties(en-us,office.12).gif UndoActionsAvailable Returns the number of actions available on the undo stack. Read-only Long.
Aa437613.properties(en-us,office.12).gif ViewBoundariesAndGuides Returns True if boundaries and guides are visible in the specified publication. Read/write Boolean.
Aa437613.properties(en-us,office.12).gif ViewHorizontalBaseLineGuides Sets or returns a Boolean that represents whether or not the horizontal baseline guides are visible in the specified Document object. True if they are visible. False if they are not visible. Read/write.
Aa437613.properties(en-us,office.12).gif ViewTwoPageSpread Returns True if the specified publication should be viewed as a two-page spread. Read/write Boolean.
Aa437613.properties(en-us,office.12).gif ViewVerticalBaseLineGuides Sets or returns a Boolean that represents whether or not the vertical baseline guides are visible in the specified Document object. True if they are visible. False if they are not visible. Read/write.
Aa437613.properties(en-us,office.12).gif WebNavigationBarSets Returns a WebNavigationBarSets object representing a collection of all WebNavigationBarSet objects in the specified document. Read-only.
Aa437613.properties(en-us,office.12).gif Wizard Returns a Wizard object representing the publication design associated with the specified publication or the wizard associated with the specified Design Gallery object.

Events

  Name Description
Aa437613.events(en-us,office.12).gif BeforeClose Occurs immediately before any open document closes.
Aa437613.events(en-us,office.12).gif Open Occurs when a publication is opening.
Aa437613.events(en-us,office.12).gif Redo Occurs when reversing the last action that was undone.
Aa437613.events(en-us,office.12).gif ShapesAdded Occurs when one or more new shapes are added to a publication. This event occurs whether shapes are added manually or programmatically.
Aa437613.events(en-us,office.12).gif ShapesRemoved Occurs when a shape is deleted from a publication.
Aa437613.events(en-us,office.12).gif Undo Occurs when a user undoes the last action performed.
Aa437613.events(en-us,office.12).gif WizardAfterChange Occurs after the user chooses an option in the wizard pane that changes any of the following settings in the publication: page layout (page size, fold type, orientation, label product), print setup (paper size, print tiling), adding or deleting objects, adding or deleting pages, or object or page formatting (size, position, fill, border, background, default text, text formatting).