Documents Members (Visio)

Article
05/05/2016

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

Includes a Document object for each open document in a Microsoft Visio instance.

Events

Name	Description
AfterDocumentMerge	Occurs when Visio incorporates changes from other users? versions of a document into a merged, co-authored document.
AfterRemoveHiddenInformation	Occurs when hidden information is removed from the document.
AfterReplaceShapes	Occurs after a shape-replacement operation.
BeforeDataRecordsetDelete	Occurs before a DataRecordset object is deleted from the DataRecordsets collection.
BeforeDocumentClose	Occurs before a document is closed.
BeforeDocumentSave	Occurs before a document is saved.
BeforeDocumentSaveAs	Occurs just before a document is saved by using the Save As command.
BeforeMasterDelete	Occurs before a master is deleted from a document.
BeforePageDelete	Occurs before a page is deleted.
BeforeReplaceShapes	Occurs just before a shape-replacement operation.
BeforeSelectionDelete	Occurs before selected objects are deleted.
BeforeShapeDelete	Occurs before a shape is deleted.
BeforeShapeTextEdit	Occurs before a shape is opened for text editing in the user interface.
BeforeStyleDelete	Occurs before a style is deleted.
CalloutRelationshipAdded	Occurs when a new callout relationship is added to a document.
CalloutRelationshipDeleted	Occurs when a callout relationship is deleted from a document.
CellChanged	Occurs after the value changes in a cell in a document.
ConnectionsAdded	Occurs after connections have been established between shapes.
ConnectionsDeleted	Occurs after connections between shapes have been removed.
ContainerRelationshipAdded	Occurs when a new container relationship is added to the document.
ContainerRelationshipDeleted	Occurs when a container relationship is deleted from the document.
ConvertToGroupCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelConvertToGroup event.
DataRecordsetAdded	Occurs when a DataRecordset object is added to a DataRecordsets collection.
DataRecordsetChanged	Occurs when a data recordset changes as a result of being refreshed.
DesignModeEntered	Occurs before a document enters design mode.
DocumentChanged	Occurs after certain properties of a document are changed.
DocumentCloseCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelDocumentClose event.
DocumentCreated	Occurs after a document is created.
DocumentOpened	Occurs after a document is opened.
DocumentSaved	Occurs after a document is saved.
DocumentSavedAs	Occurs after a document is saved by using the Save As command.
FormulaChanged	Occurs after a formula changes in a cell in the object that receives the event.
GroupCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelGroup event.
MasterAdded	Occurs after a new master is added to a document.
MasterChanged	Occurs after properties of a master are changed and propagated to its instances.
MasterDeleteCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelMasterDelete event.
PageAdded	Occurs after a new page is added to a document.
PageChanged	Occurs after the name of a page, the background page associated with a page, or the page type (foreground or background) changes.
PageDeleteCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelPageDelete event.
QueryCancelConvertToGroup	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.
QueryCancelDocumentClose	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.
QueryCancelGroup	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.
QueryCancelMasterDelete	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.
QueryCancelPageDelete	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.
QueryCancelReplaceShapes	Occurs immediately after a shape-replacement operation is requested. If any event handler returns True, the operation is canceled.
QueryCancelSelectionDelete	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.
QueryCancelStyleDelete	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.
QueryCancelUngroup	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.
ReplaceShapesCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelReplaceShapes event.
RuleSetValidated	Occurs when a rule set is validated.
RunModeEntered	Occurs after a document enters run mode.
SelectionAdded	Occurs after one or more shapes are added to a document.
SelectionDeleteCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelSelectionDelete event.
ShapeAdded	Occurs after one or more shapes are added to a document.
ShapeChanged	Occurs after a property of a shape that is not stored in a cell is changed in a document.
ShapeDataGraphicChanged	Occurs after a data graphic is applied to or deleted from a shape.
ShapeExitedTextEdit	Occurs after a shape is no longer open for interactive text editing.
ShapeLinkAdded	Occurs after a shape is linked to a data row.
ShapeLinkDeleted	Occurs after the link between a shape and a data row is deleted.
ShapeParentChanged	Occurs after shapes are grouped or a group is ungrouped.
StyleAdded	Occurs after a new style is added to a document.
StyleChanged	Occurs after the name of a style is changed or a change to the style propagates to objects to which the style is applied.
StyleDeleteCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelStyleDelete event.
TextChanged	Occurs after the text of a shape is changed in a document.
UngroupCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelUngroup event.

Methods

Name	Description
Add	Adds a new Document object to the Documents collection.
AddEx	Adds a new stencil or drawing to the Documents collection, while permitting extra information to be passed in an argument.
CanCheckOut	Specifies whether a document can be checked out from a Microsoft SharePoint Server computer.
CheckOut	Marks a specified document as checked out and assigns edit privileges to the current user.
GetNames	Returns the names of all items in a collection.
Open	Opens an existing file so that it can be edited.
OpenEx	Opens an existing Microsoft Visio file, using extra information passed in as an argument.

Properties

Name	Description
Application	Returns the instance of Microsoft Visio that is associated with an object. Read-only.
Count	Returns the number of objects in a collection. Read-only.
EventList	Returns the EventList collection of an object or the EventList collection that contains an Event object. Read-only.
Item	Returns an item from a collection. The Item property is the default property for all collections. Read-only.
ItemFromID	Returns an item of a collection using the ID of the item. Read-only.
ObjectType	Returns an object's type. Read-only.
PersistsEvents	Indicates whether an object is capable of containing persistent events in its EventList collection. Read-only.

Documents Members (Visio)

Events

Methods

Properties

Additional resources