Window Object Members

Visio Automation Reference

Represents an open window in a Microsoft Office Visio instance.

Methods

	Name	Description
	Activate	Activates a window.
	Close	Closes a window.
	DeselectAll	Deselects all shapes in a window or selection.
	DockedStencils	Returns the names of all stencils docked in a Microsoft Office Visio drawing window.
	GetViewRect	Returns the page coordinates of a window's borders.
	GetWindowRect	Gets the size and position of the client area of a window.
	NewWindow	Opens a new Microsoft Office Visio window.
	Scroll	Scrolls the contents of a window vertically, horizontally, or both.
	ScrollViewTo	Scrolls a window to a particular page coordinate.
	Select	Selects or deselects an object.
	SelectAll	Selects all possible shapes in a window or selection.
	SetViewRect	Sets the page coordinates of a window's borders by adjusting the zoom level and center scroll position.
	SetWindowRect	Sets the size and position of the client area of a window.

Properties

	Name	Description
	AllowEditing	Determines whether the Edit Stencil command is enabled or disabled in a stencil window. Read/write.
	Application	Read-only. Returns the instance of Microsoft Office Visio that is associated with an object.
	BackgroundColor	Determines the background color of the active Microsoft Office Visio drawing window and its associated print preview and full-screen view windows. Read/write.
	BackgroundColorGradient	Determines the background gradient color of the active Microsoft Office Visio drawing window and its associated print preview and full-screen view windows. Read/write.
	Caption	Gets or sets the caption for an object. Read/write.
	Document	Gets the Document object that is associated with an object. Read-only.
	EventList	Returns the EventList collection of an object or the EventList collection that contains an Event object. Read-only.
	ID	Gets the ID of an object. Read-only.
	Index	Gets the ordinal position of a Window object in the Windows collection. Read-only.
	InPlace	Specifies whether a window is open in place, or whether a document is being viewed through a window that is open in place. Read-only.
	IsEditingOLE	Determines whether a drawing window contains an ActiveX control that has focus or an embedded or linked object that is being edited. Read-only.
	IsEditingText	Determines whether a text editing session is active in the drawing window. Read-only.
	Master	Gets the master that is displayed in a window. Read-only.
	MasterShortcut	Gets the master shortcut that is displayed in a window. Read-only.
	MergeCaption	Gets or sets the abbreviated caption that appears on the page tab when the window is merged with other windows. Read/write.
	MergeClass	Specifies a list of window classes that this anchored window can merge with. Read/write.
	MergeID	Specifies the string version of a merged window's globally unique identifier (GUID). Read/write.
	MergePosition	Specifies the left-to-right tab position of a merged anchored window. Read/write.
	ObjectType	Returns an object's type. Read-only.
	Page	Gets or sets the page that is displayed in a window. Read/write.
	PageTabWidth	Gets or sets the width of the page tab control in a drawing window. Read/write.
	Parent	Determines the parent of an object. Read-only.
	ParentWindow	Returns the Window object that is the parent of another Window object. Read-only.
	PersistsEvents	Indicates whether an object is capable of containing persistent events in its EventList collection. Read-only.
	ReviewerMarkupVisible	Determines whether reviewer markup, for a particular reviewer or all reviewers, is visible in a Microsoft Office Visio window that displays a drawing page. Read/write.
	ScrollLock	Determines whether scrolling is disabled in a Microsoft Office Visio window. Read/write.
	SelectedCell	Returns the selected cell in the ShapeSheet window. Read-only.
	SelectedDataRecordset	Gets or sets the data recordset that is displayed on the active tab of the External Data Window in the Microsoft Office Visio user interface (UI). Read/write.
	SelectedDataRowID	Gets or sets the ID of the data row that is selected (or that is the primary row selected, when multiple rows are selected) on the active tab of the External Data Window in the Microsoft Office Visio user interface (UI). Read/write.
	SelectedMasters	Returns an array of the masters or master shortcuts selected in a Microsoft Office Visio stencil window. Read-only
	SelectedText	Returns the selected text in the Microsoft Office Visio drawing window as a Characters object. Read/write.
	Selection	Returns a Selection object that represents what is presently selected in the window, or assigns a selection created by the CreateSelection method to a Selection object. Read/write.
	Shape	Returns the Shape object that owns a Cell, Characters, Row, or Section object or that is associated with a Hyperlink or OLEObject object or with the Hyperlinks collection. Read-only.
	ShowConnectPoints	Determines whether connection points are shown in a window. Read/write.
	ShowGrid	Determines whether a grid is shown in a window. Read/write.
	ShowGuides	Determines whether guides are shown in a window. Read/write.
	ShowPageBreaks	Determines whether page breaks are shown in a window. Read/write.
	ShowPageOutline	Determines whether the drawing page outline is displayed in the Microsoft Office Visio drawing window. Read/write.
	ShowPageTabs	Determines whether page tab controls are shown in the drawing window. Read/write.
	ShowRulers	Determines whether rulers are shown in the drawing window. Read/write.
	ShowScrollBars	Determines whether scroll bars are shown in the drawing window. Read/write.
	Stat	Returns status information for an object. Read-only.
	SubType	Returns the subtype of a Window object that represents a drawing window. Read-only.
	Type	Returns the type of the object. Read-only.
	ViewFit	Determines which auto-fit mode a window is in, if any. Read/write.
	Visible	Determines whether an object is visible. Read/write.
	WindowHandle32	Returns the 32-bit handle of a Microsoft Office Visio window. Read-only.
	Windows	Returns the Windows collection for a Microsoft Office Visio instance or window. Read-only.
	WindowState	Gets or sets the state of a window. Read/write.
	Zoom	Gets or sets the current display size (magnification factor) for a page in a window. Read/write.
	ZoomBehavior	Determines the zoom behavior for a Microsoft Office Visio document or window. Read/write.
	ZoomLock	Determines whether zooming is disabled in a Microsoft Office Visio drawing window. Read/write.

Events

	Name	Description
	BeforeWindowClosed	Occurs before a window is closed.
	BeforeWindowPageTurn	Occurs before a window is about to show a different page.
	BeforeWindowSelDelete	Occurs before the shapes in the selection of a window are deleted.
	KeyDown	Occurs when a keyboard key is pressed.
	KeyPress	Occurs when a keyboard key is pressed.
	KeyUp	Occurs when a keyboard key is released.
	MouseDown	Occurs when a mouse button is clicked.
	MouseMove	Occurs when the mouse is moved.
	MouseUp	Occurs when a mouse button is released.
	OnKeystrokeMessageForAddon	Occurs when Microsoft Office Visio receives a keystroke message from Microsoft Windows that is targeted at an add-on window or child of an add-on window.
	QueryCancelWindowClose	Occurs before the application closes a window in response to a user action in the interface. If any event handler returns True, the operation is canceled.
	SelectionChanged	Occurs after a set of shapes selected in a window changes.
	ViewChanged	Occurs when the zoom level or scroll position of a drawing window changes.
	WindowActivated	Occurs after the active window changes in a Microsoft Office Visio instance.
	WindowChanged	Occurs when the size or position of a window changes.
	WindowCloseCanceled	Occurs after an event handler has returned True (cancel) to a QueryCancelWindowClose event.
	WindowTurnedToPage	Occurs after a window shows a different page.