Documents Object Members

  • Article
Visio Automation Reference

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

Methods

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

Properties

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

Events

  Name Description
Aa342243.events(en-us,office.12).gif AfterRemoveHiddenInformation Occurs when hidden information is removed from the document.
Aa342243.events(en-us,office.12).gif BeforeDataRecordsetDelete Occurs before a DataRecordset object is deleted from the DataRecordsets collection.
Aa342243.events(en-us,office.12).gif BeforeDocumentClose Occurs before a document is closed.
Aa342243.events(en-us,office.12).gif BeforeDocumentSave Occurs before a document is saved.
Aa342243.events(en-us,office.12).gif BeforeDocumentSaveAs Occurs just before a document is saved by using the Save As command.
Aa342243.events(en-us,office.12).gif BeforeMasterDelete Occurs before a master is deleted from a document.
Aa342243.events(en-us,office.12).gif BeforePageDelete Occurs before a page is deleted.
Aa342243.events(en-us,office.12).gif BeforeSelectionDelete Occurs before selected objects are deleted.
Aa342243.events(en-us,office.12).gif BeforeShapeDelete Occurs before a shape is deleted.
Aa342243.events(en-us,office.12).gif BeforeShapeTextEdit Occurs before a shape is opened for text editing in the user interface.
Aa342243.events(en-us,office.12).gif BeforeStyleDelete Occurs before a style is deleted.
Aa342243.events(en-us,office.12).gif CellChanged Occurs after the value changes in a cell in a document.
Aa342243.events(en-us,office.12).gif ConnectionsAdded Occurs after connections have been established between shapes.
Aa342243.events(en-us,office.12).gif ConnectionsDeleted Occurs after connections between shapes have been removed.
Aa342243.events(en-us,office.12).gif ConvertToGroupCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelConvertToGroup event.
Aa342243.events(en-us,office.12).gif DataRecordsetAdded Occurs when a DataRecordset object is added to a DataRecordsets collection.
Aa342243.events(en-us,office.12).gif DataRecordsetChanged Occurs when a data recordset changes as a result of being refreshed.
Aa342243.events(en-us,office.12).gif DesignModeEntered Occurs before a document enters design mode.
Aa342243.events(en-us,office.12).gif DocumentChanged Occurs after certain properties of a document are changed.
Aa342243.events(en-us,office.12).gif DocumentCloseCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelDocumentClose event.
Aa342243.events(en-us,office.12).gif DocumentCreated Occurs after a document is created.
Aa342243.events(en-us,office.12).gif DocumentOpened Occurs after a document is opened.
Aa342243.events(en-us,office.12).gif DocumentSaved Occurs after a document is saved.
Aa342243.events(en-us,office.12).gif DocumentSavedAs Occurs after a document is saved by using the Save As command.
Aa342243.events(en-us,office.12).gif FormulaChanged Occurs after a formula changes in a cell in the object that receives the event.
Aa342243.events(en-us,office.12).gif GroupCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelGroup event.
Aa342243.events(en-us,office.12).gif MasterAdded Occurs after a new master is added to a document.
Aa342243.events(en-us,office.12).gif MasterChanged Occurs after properties of a master are changed and propagated to its instances.
Aa342243.events(en-us,office.12).gif MasterDeleteCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelMasterDelete event.
Aa342243.events(en-us,office.12).gif PageAdded Occurs after a new page is added to a document.
Aa342243.events(en-us,office.12).gif PageChanged Occurs after the name of a page, the background page associated with a page, or the page type (foreground or background) changes.
Aa342243.events(en-us,office.12).gif PageDeleteCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelPageDelete event.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif RunModeEntered Occurs after a document enters run mode.
Aa342243.events(en-us,office.12).gif SelectionAdded Occurs after one or more shapes are added to a document.
Aa342243.events(en-us,office.12).gif SelectionDeleteCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelSelectionDelete event.
Aa342243.events(en-us,office.12).gif ShapeAdded Occurs after one or more shapes are added to a document.
Aa342243.events(en-us,office.12).gif ShapeChanged Occurs after a property of a shape that is not stored in a cell is changed in a document.
Aa342243.events(en-us,office.12).gif ShapeDataGraphicChanged Occurs after a data graphic is applied to or deleted from a shape.
Aa342243.events(en-us,office.12).gif ShapeExitedTextEdit Occurs after a shape is no longer open for interactive text editing.
Aa342243.events(en-us,office.12).gif ShapeLinkAdded Occurs after a shape is linked to a data row.
Aa342243.events(en-us,office.12).gif ShapeLinkDeleted Occurs after the link between a shape and a data row is deleted.
Aa342243.events(en-us,office.12).gif ShapeParentChanged Occurs after shapes are grouped or a group is ungrouped.
Aa342243.events(en-us,office.12).gif StyleAdded Occurs after a new style is added to a document.
Aa342243.events(en-us,office.12).gif 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.
Aa342243.events(en-us,office.12).gif StyleDeleteCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelStyleDelete event.
Aa342243.events(en-us,office.12).gif TextChanged Occurs after the text of a shape is changed in a document.
Aa342243.events(en-us,office.12).gif UngroupCanceled Occurs after an event handler has returned True (cancel) to a QueryCancelUngroup event.