Table of contents
TOC
Collapse the table of content
Expand the table of content

Document Object (Visio)

office 365 dev account|Last Updated: 6/12/2017
|
1 Contributor

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.

Remarks

The default property of a Document object is Name.

Use the Open method of a Documents collection to open an existing document.

Use the Add method of a Documents collection to create a new document.

Use the ActiveDocument property of an Application object to retrieve the active document in an instance.

Use the Pages, Masters, and Styles properties of a Document object to retrieve Page, Master, and Style objects, respectively.

Note

Use the CustomMenus or CustomToolbars properties of a Document object to access the custom menus or toolbars.

Note The Microsoft Visual Basic for Applications (VBA) project of every Visio document also has a class module called ThisDocument. When you reference the ThisDocument module from code in a VBA project, it returns a reference to the project's Document object. For example, the code in a document's project can display the name of the project's document in a message box with this statement:

    MsgBox ThisDocument.Name

If your Visual Studio solution includes the Microsoft.Office.Interop.Visio reference, this object maps to the following types:

  • Microsoft.Office.Interop.Visio.IVDocument

Events

Name
AfterDocumentMerge
AfterRemoveHiddenInformation
BeforeDataRecordsetDelete
BeforeDocumentClose
BeforeDocumentSave
BeforeDocumentSaveAs
BeforeMasterDelete
BeforePageDelete
BeforeSelectionDelete
BeforeShapeTextEdit
BeforeStyleDelete
ConvertToGroupCanceled
DataRecordsetAdded
DesignModeEntered
DocumentChanged
DocumentCloseCanceled
DocumentCreated
DocumentOpened
DocumentSaved
DocumentSavedAs
GroupCanceled
MasterAdded
MasterChanged
MasterDeleteCanceled
PageAdded
PageChanged
PageDeleteCanceled
QueryCancelConvertToGroup
QueryCancelDocumentClose
QueryCancelGroup
QueryCancelMasterDelete
QueryCancelPageDelete
QueryCancelSelectionDelete
QueryCancelStyleDelete
QueryCancelUngroup
RuleSetValidated
RunModeEntered
SelectionDeleteCanceled
ShapeAdded
ShapeDataGraphicChanged
ShapeExitedTextEdit
ShapeParentChanged
StyleAdded
StyleChanged
StyleDeleteCanceled
UngroupCanceled

Methods

Name
AddUndoUnit
BeginUndoScope
CanCheckIn
CanUndoCheckOut
CheckIn
Clean
ClearCustomMenus
ClearCustomToolbars
ClearGestureFormatSheet
Close
CopyPreviewPicture
DeleteSolutionXMLElement
Drop
EndUndoScope
ExecuteLine
ExportAsFixedFormat
FollowHyperlink
GetThemeNames
GetThemeNamesU
OpenStencilWindow
ParseLine
Print
PrintOut
PurgeUndo
RemoveHiddenInformation
RenameCurrentScope
Save
SaveAs
SaveAsEx
SetCustomMenus
SetCustomToolbars
UndoCheckOut

Properties

Name
AlternateNames
Application
AutoRecover
BottomMargin
BuildNumberCreated
BuildNumberEdited
Category
ClassID
Colors
Comments
Company
CompatibilityMode
Container
ContainsWorkspaceEx
Creator
CustomMenus
CustomMenusFile
CustomToolbars
CustomToolbarsFile
CustomUI
DataRecordsets
DefaultFillStyle
DefaultGuideStyle
DefaultLineStyle
DefaultSavePath
DefaultStyle
DefaultTextStyle
Description
DiagramServicesEnabled
DocumentSheet
DynamicGridEnabled
EditorCount
EmailRoutingData
EventList
Fonts
FooterCenter
FooterLeft
FooterMargin
FooterRight
FullBuildNumberCreated
FullBuildNumberEdited
FullName
GestureFormatSheet
GlueEnabled
GlueSettings
HeaderCenter
HeaderFooterColor
HeaderFooterFont
HeaderLeft
HeaderMargin
HeaderRight
HyperlinkBase
ID
Index
InPlace
Keywords
Language
LeftMargin
MacrosEnabled
Manager
Masters
MasterShortcuts
Mode
Name
ObjectType
OLEObjects
Pages
PaperHeight
PaperSize
PaperWidth
Path
PersistsEvents
PreviewPicture
PrintCenteredH
PrintCenteredV
Printer
PrintFitOnPages
PrintLandscape
PrintPagesAcross
PrintPagesDown
PrintScale
ProgID
Protection
ReadOnly
RemovePersonalInformation
RightMargin
Saved
SavePreviewMode
ServerPublishOptions
SharedWorkspace
SnapAngles
SnapEnabled
SnapExtensions
SnapSettings
SolutionXMLElement
SolutionXMLElementCount
SolutionXMLElementExists
SolutionXMLElementName
Stat
Styles
Subject
Sync
Template
Time
TimeCreated
TimeEdited
TimePrinted
TimeSaved
Title
TopMargin
Type
UndoEnabled
UserCustomUI
Validation
VBProject
VBProjectData
Version
ZoomBehavior
Permission
© 2017 Microsoft