Document Members (Visio)
.png "GitHub-Mark-64px") |
Contribute to this content Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation. |
Represents a drawing file (.vsd or .vdx), stencil file (.vss or .vsx), or template file (.vst or .vtx) that is open in an instance of Microsoft Visio. A Document object is a member of the Documents collection of an Application object.
Events
Name |
Description |
|---|---|
Occurs when Visio incorporates changes from other users? versions of a document into a merged, co-authored document. |
|
Occurs when hidden information is removed from the document. |
|
Occurs before a DataRecordset object is deleted from the DataRecordsets collection. |
|
Occurs before a document is closed. |
|
Occurs before a document is saved. |
|
Occurs just before a document is saved by using the Save As command. |
|
Occurs before a master is deleted from a document. |
|
Occurs before a page is deleted. |
|
Occurs before selected objects are deleted. |
|
Occurs before a shape is opened for text editing in the user interface. |
|
Occurs before a style is deleted. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelConvertToGroup event. |
|
Occurs when a DataRecordset object is added to a DataRecordsets collection. |
|
Occurs before a document enters design mode. |
|
Occurs after certain properties of a document are changed. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelDocumentClose event. |
|
Occurs after a document is created. |
|
Occurs after a document is opened. |
|
Occurs after a document is saved. |
|
Occurs after a document is saved by using the Save As command. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelGroup event. |
|
Occurs after a new master is added to a document. |
|
Occurs after properties of a master are changed and propagated to its instances. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelMasterDelete event. |
|
Occurs after a new page is added to a document. |
|
Occurs after the name of a page, the background page associated with a page, or the page type (foreground or background) changes. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelPageDelete event. |
|
Occurs before the application converts a selection of shapes to a group in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs before the application closes a document in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs before the application groups a selection of shapes in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs before the application deletes a master in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs before the application deletes a page in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs before the application deletes a selection of shapes in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs before the application deletes a style in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs before the application ungroups a selection of shapes in response to a user action in the interface. If any event handler returns True, the operation is canceled. |
|
Occurs when a rule set is validated. |
|
Occurs after a document enters run mode. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelSelectionDelete event. |
|
Occurs after one or more shapes are added to a document. |
|
Occurs after a data graphic is applied to or deleted from a shape. |
|
Occurs after a shape is no longer open for interactive text editing. |
|
Occurs after shapes are grouped or a group is ungrouped. |
|
Occurs after a new style is added to a document. |
|
Occurs after the name of a style is changed or a change to the style propagates to objects to which the style is applied. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelStyleDelete event. |
|
Occurs after an event handler has returned True (cancel) to a QueryCancelUngroup event. |
Methods
Name |
Description |
|---|---|
Adds an object that supports the IOleUndoUnit or IVBUndoUnit interface to the Microsoft Visio undo queue. |
|
Starts a transaction with a unique scope ID for an instance of Microsoft Visio. |
|
Specifies whether a document can be checked into a Microsoft SharePoint Server computer. |
|
Determines whether a Microsoft Visio document is checked out from a Microsoft SharePoint Server site, so that if it is, the check-out can be subsequently undone. |
|
Returns a document from a local computer to a Microsoft SharePoint Server computer. |
|
Examines, reports, and repairs selected conditions in a document. |
|
Restores the built-in Microsoft Visio user interface. |
|
Restores the built-in Microsoft Visio user interface. |
|
Clears local formatting in a document's Gesture Format sheet. |
|
Closes a document. |
|
Copies the preview picture from another document into the current document. |
|
Deletes the named SolutionXML element. |
|
Creates a new Master object by dropping an object onto a receiving object such as a stencil or document, or the Masters or MasterShortcuts collection. |
|
Ends or cancels a transaction that has a unique scope. |
|
Executes a line of Microsoft Visual Basic code. |
|
Exports a Microsoft Visio document as a file in a fixed format, either PDF or XPS. |
|
Navigates to an arbitrary hyperlink. |
|
Returns a locale-specific array of names of themes contained in the document. |
|
Returns a locale-independent array of names of themes contained in the document. |
|
Opens a stencil window that shows the masters in the document. |
|
Parses a line of Microsoft Visual Basic code. |
|
Prints the contents of an object to the default printer. |
|
Prints the contents of the active document and provides various printing options. |
|
Empties the Microsoft Visio queue of undo actions. |
|
Removes hidden information, such as personal information and external data, from a Microsoft Visio document. |
|
Renames the top-level open undo scope. |
|
Saves a document. |
|
Saves a document and gives it a file name. |
|
Saves a document with a file name using extra information passed in an argument. |
|
Replaces the current built-in or custom menus of an application or document. |
|
Replaces the current built-in or custom toolbars of an application or document. |
|
Closes a Microsoft Visio document checked out from a Microsoft SharePoint Server site, deletes the local copy of the document, discarding any changes, undoes the checkout, and then reopens the document. |
Properties
Name |
Description |
|---|---|
Gets or sets the alternate names for a document. Read/write. |
|
Returns the instance of Microsoft Visio that is associated with an object. Read-only. |
|
Determines whether an open document that has unsaved changes is copied when automatic recovery is enabled. Read/write. |
|
Specifies the bottom margin when printing the pages in a document. Read/write. |
|
Returns the build number of the instance used to create the document. Read-only. |
|
Returns the build number of the instance last used to edit the document. Read-only. |
|
Gets or sets the value of a document's category, one of the document properties. Read/write. |
|
Returns the class ID string of the container application in which the document is embedded. Read-only. |
|
Returns the Colors collection of a Document object. Read-only. |
|
Returns a Comments object that represents the collection of all the reviewer comments in the document. Read-only. |
|
Gets or sets the name of the company the document belongs to, one of the document's properties. Read/write. |
|
Returns a Boolean that indicates whether the specified document is in compatibility mode. Read-only. |
|
Returns an IDispatch interface on the ActiveX container in which the document is contained or Nothing if the document is not in a container. Read-only. |
|
Gets or sets whether workspace information is saved with the document. Read/write. |
|
Gets or sets the value of a document's author—one of the document's properties. Read/write. |
|
Gets a UIObject object that represents the current custom menus and accelerators of a Document object. Read-only. |
|
Gets or sets the name of the file that defines custom menus and accelerators for a Document object. Read/write. |
|
Gets a UIObject object that represents the current custom toolbars and status bars of a Document object. Read-only. |
|
Returns or sets the name of the file that defines custom toolbars and status bars for a Document object. Read/write. |
|
Gets or sets the Ribbon XML string that is passed to the document to customize the Microsoft Office Fluent user interface. Read/write. |
|
Returns the DataRecordsets collection contained in the document. Read-only. |
|
Gets or sets the default fill style of a document. Read/write. |
|
Gets or sets the default guide style of a document. Read/write. |
|
Gets or sets the default line style of a document. Read/write. |
|
Gets or sets the path to the location where Microsoft Visio saves the current document by default. Read/write. |
|
Gets the default fill style of a document or sets the default fill, line, and text styles of a document. Read/write. |
|
Gets or sets the default text style of a document. Read/write. |
|
Gets or sets the description of a document, one of a document's properties. Read/write. |
|
Determines which, if any, diagram services are enabled for the document. Read/write. |
|
Returns a Shape object whose cells represent properties of the document. Read-only. |
|
Determines whether the dynamic grid is enabled. Read/write. |
|
Returns a Long that represents the number of editors of a co-authored document. Read-only. |
|
Returns e-mail routing data for a document. Read-only. |
|
Returns the EventList collection of an object or the EventList collection that contains an Event object. Read-only. |
|
Returns the Fonts collection of a Document object. Read-only. |
|
Gets or sets the text string that appears in the center portion of a document's footer. Read/write. |
|
Gets or sets the text string that appears on the left side of a document's footer. Read/write. |
|
Gets or sets the margin of a document's footer. Read/write. |
|
Gets or sets the text string that appears in the right portion of a document's footer. Read/write. |
|
Returns the full build number of the instance used to create the document. Read-only. |
|
Returns the full build number of the instance last used to edit the document. Read-only. |
|
Returns the name of a document, including the drive and path. Read-only. |
|
Returns a reference to a document's Gesture Format sheet, which contains the line, fill, and text formatting that is applied to shapes drawn on the page. Read-only. |
|
Determines whether glue is enabled in the document. Read/write. |
|
Determines the objects that shapes glue to when glue is enabled in the document. Read/write. |
|
Contains the text string that appears in the center portion of a document's header. Read/write. |
|
Specifies the color of the header and footer text. Read/write. |
|
Specifies the font used for the header and footer text. Read/write. |
|
Gets or sets the text string that appears in the left portion of a document's header. Read/write. |
|
Gets or sets the margin of a document's header. Read/write. |
|
Gets or sets the text string that appears in the right portion of a document's header. Read/write. |
|
Gets or sets the value of the Hyperlink base box in a document's Properties dialog box (click the File tab, click Info, click Properties, and then click Advanced Properties). Read/write. |
|
Gets the ID of an object. Read-only. |
|
Gets the ordinal position of a Document object in the Documents collection. Read-only. |
|
Specifies whether a document is open in place, or whether a document is being viewed through a window that is open in place. Read-only. |
|
Gets or sets the value of the Keywords box in a document's Properties dialog box. Read/write. |
|
Represents the language ID of the version of the Microsoft Visio instance represented by the parent object. Read/write. |
|
Specifies the left margin, which is used when printing. Read/write. |
|
Specifies whether you can execute macros and process events in a document's Microsoft Visual Basic for Applications (VBA) project. Read-only. |
|
Gets or sets the value of the Manager box in a document's Properties dialog box. Read/write. |
|
Returns the Masters collection for a document's stencil. Read-only. |
|
Returns the MasterShortcuts collection for a document stencil. Read-only. |
|
Determines whether a document is in run mode or design mode. Read/write. |
|
Specifies the name of an object. Read-only. |
|
Returns an object's type. Read-only. |
|
Returns the OLEObjects collection of a document. Read-only. |
|
Returns the Pages collection for a document. Read-only. |
|
Returns the height of a document's printed page. Read-only. |
|
Gets or sets the paper size of a document. Read/write. |
|
Returns the width of a document's printed page. Read-only. |
|
Returns the drive and folder path of the Microsoft Visio document. Read-only. |
|
Indicates whether an object is capable of containing persistent events in its EventList collection. Read-only. |
|
Gets or sets the preview picture shown in the Open dialog box and when you click the File tab, and then click New. Read/write. |
|
Indicates whether drawings are centered between the left and right edges of the paper when printed. Read/write. |
|
Indicates whether drawings are centered between the top and bottom edges of the paper when printed. Read/write. |
|
Specifies the name of the printer to use when printing the document. Read/write. |
|
Indicates whether drawings in a document are printed on a specified number of sheets across and down. Read/write. |
|
Indicates whether a document's drawings are printed in landscape or portrait orientation. Read/write. |
|
Indicates the number of sheets of paper on which a drawing is printed horizontally. Read/write. |
|
Gets or sets the number of sheets of paper on which a drawing is printed vertically. Read/write. |
|
Gets or sets how much drawings are reduced or enlarged when printed. Read/write. |
|
Returns the programmatic identifier of a shape that represents an ActiveX control, an embedded object, or linked object. Read-only. |
|
Determines how a document is protected from user customization. Read/write. |
|
Indicates whether a file is open as read-only. Read-only. |
|
Determines if personal information about a file is saved when the user saves the file in Microsoft Visio. Read/write. |
|
Specifies the right margin, which is used when printing. Read/write. |
|
Indicates whether a document has any unsaved changes. Read/write. |
|
Determines whether and how a preview picture is saved in a file. Read/write. |
|
Returns a ServerPublishOptions object that you can use to specify the settings to apply when you save a document as a Web drawing (as a .vdw file), then publish and use it on a Microsoft SharePoint site in conjunction with Visio Services. Read-only. |
|
Returns a Microsoft Office SharedWorkspace object that provides access to the Office Document Workspace object model. Read-only. |
|
Determines the degree of the angle that is drawn when isometric angle lines is chosen as a shape extension option. Read/write. |
|
Determines whether snap is active in the document. Read/write. |
|
Determines the shape extensions that are active in a document. Read/write. |
|
Determines the objects that shapes snap to when snap is active in the document. Read/write. |
|
Contains solution-specific, well-formed XML data stored with a document. Read/write. |
|
Returns the number of SolutionXML elements in a document. Read-only. |
|
Indicates whether a named SolutionXML element exists in the document. Read-only. |
|
Returns the name of the SolutionXML element. Read-only. |
|
Returns status information for an object. Read-only. |
|
Returns the Styles collection for a document. Read-only. |
|
Gets or sets the value of the Subject field in a document's properties. Read/write. |
|
Returns a Microsoft Office Sync object that provides information about the status of the active document in a shared workspace and the ability to perform a set of actions. Read-only. |
|
Returns the name of the template from which the document was created. Read-only. |
|
Returns the most recently recorded date and time. Read-only. |
|
Returns the date and time the document was created. Read-only. |
|
Returns the date and time the document was last edited. Read-only. |
|
Returns the date and time the document was last printed. Read-only. |
|
Returns the date and time the document was last saved. Read-only. |
|
Gets or sets the value of the Title field in a document's properties. Read/write. |
|
Specifies the top margin when printing a document. Read/write. |
|
Returns the type of the Document object. Read-only. |
|
Determines whether undo information is maintained in memory. Read/write. |
|
Gets or sets the Ribbon XML string that is passed to the document to customize the Quick Access toolbar or the Ribbon. Read/write. |
|
Returns the Validation object that is associated with the document. Read-only. |
|
Returns an automation object that you can use to control the Microsoft Visual Basic for Applications (VBA) project of the document. Read-only. |
|
Returns the Microsoft Visual Basic project data stored with a document. Read-only. |
|
Gets the version of a saved document or sets the version in which to save a document. Read/write. |
|
Determines the zoom behavior for a Microsoft Visio document or window. Read/write. |
|
Returns the Permission object of the document. |