Master Object Members
Visio Automation Reference |
Represents a master in a stencil.
Methods
Name | Description | |
---|---|---|
![]() |
AddGuide | Adds a guide to a master. |
![]() |
BoundingBox | Returns a rectangle that tightly encloses the shapes of a master. |
![]() |
CenterDrawing | Centers a page's, master's, or group's shapes with respect to the extent of the page, master, or group. |
![]() |
Close | Closes a master. |
![]() |
CreateSelection | Creates various types of Selection objects. |
![]() |
CreateShortcut | Creates a shortcut for a master. |
![]() |
DataGraphicDelete | Deletes the Master of type visTypeDataGraphic from the Masters collection of the document. |
![]() |
Delete | Deletes an object. |
![]() |
DrawArcByThreePoints | Creates a new shape whose path consists of an arc defined by the three points passed as parameters. |
![]() |
DrawBezier | Creates a new shape whose path is defined by the supplied sequence of Bezier control points. |
![]() |
DrawCircularArc | Creates a new shape whose path consists of a circular arc defined by its center, radius, and start and end angles. |
![]() |
DrawLine | Adds a line to the Shapes collection of a master. |
![]() |
DrawNURBS | Creates a new shape whose path consists of a single NURBS (nonuniform rational B-spline) segment. |
![]() |
DrawOval | Adds an oval (ellipse) to the Shapes collection of a master. |
![]() |
DrawPolyline | Creates a new shape whose path is a polyline along a given set of points. |
![]() |
DrawQuarterArc | Creates a new shape whose path consists of an elliptical arc defined by the two points and the flag passed in as arguments. |
![]() |
DrawRectangle | Adds a rectangle to the Shapes collection of a page, master, or group. |
![]() |
DrawSpline | Creates a new shape whose path follows a given sequence of points. |
![]() |
Drop | Creates one or more new Shape objects by dropping an object onto a receiving object such as a master, drawing page, shape, or group. |
![]() |
DropMany | Creates one or more new Shape objects in a master. It returns an array of the IDs of the Shape objects it produces. |
![]() |
DropManyU | Creates one or more new Shape objects on a page, in a master, or in a group. It returns an array of the IDs of the Shape objects it produces. |
![]() |
Export | Exports an object from Microsoft Office Visio to a file format such as .bmp, .dib, .dwg, .dxf, .emf, .emz, .gif, .htm, .jpg, .png, .svg, .svgz, .tif, or .wmf. |
![]() |
ExportIcon | Exports the icon for a Master object to a named file or the Clipboard. |
![]() |
GetFormulas | Returns the formulas of many cells. |
![]() |
GetFormulasU | Returns the formulas of many cells. |
![]() |
GetResults | Gets the results or formulas of many cells. |
![]() |
Import | Imports a file into the current document. |
![]() |
ImportIcon | Imports the icon for a Master object from a named file. |
![]() |
InsertFromFile | Adds a linked or embedded object to a page, master, or group. |
![]() |
InsertObject | Adds a new embedded object or ActiveX control to a page, master, or group. |
![]() |
Layout | Lays out the shapes and/or reroutes the connectors for the page, master, group, or selection. |
![]() |
Open | Opens an existing master so that it can be edited. |
![]() |
OpenDrawWindow | Opens a new drawing window that displays a master. |
![]() |
OpenIconWindow | Opens an icon window that shows a master's icon. |
![]() |
Paste | Pastes the contents of the Clipboard into an object. |
![]() |
PasteSpecial | Inserts the contents of the Clipboard, allowing you to control the format of the pasted information and (optionally) establish a link to the source file (for example, a Microsoft Word document). |
![]() |
ResizeToFitContents | Resizes the page, or the master's page, to fit tightly around the shapes or master that are on it. |
![]() |
SetFormulas | Sets the formulas of one or more cells. |
![]() |
SetResults | Sets the results or formulas of one or more cells. |
Properties
Name | Description | |
---|---|---|
![]() |
AlignName | Gets or sets the position of a master name in a stencil window. Read/write. |
![]() |
Application | Read-only. Returns the instance of Microsoft Office Visio that is associated with an object. |
![]() |
BaseID | Returns a base ID for a master. Read-only. |
![]() |
Connects | Returns a Connects collection for a shape, page, or master. Read-only. |
![]() |
DataGraphicHidden | Hides or displays a data graphic in the Data Graphics task pane in the Microsoft Office Visio user interface. Read/write. |
![]() |
DataGraphicHidesText | Displays or hides the text of a shape or of the primary shape in a selection when a data graphic is applied to the shape or to the selection. Read/write. |
![]() |
DataGraphicHorizontalPosition | Gets or sets the default horizontal callout position for members of the GraphicItems collection of the Master object of type visTypeDataGraphic. Read/write. |
![]() |
DataGraphicShowBorder | Gets or sets whether a border is displayed around the graphic items contained in the data graphic that are in default positions. Read/write. |
![]() |
DataGraphicVerticalPosition | Gets or sets the default vertical callout position for members of the GraphicItems collection of the Master object of type visTypeDataGraphic. Read/write. |
![]() |
Document | Gets the Document object that is associated with an object. Read-only. |
![]() |
EditCopy | Returns a master that is open for editing and originally copied from this master. Read-only. |
![]() |
EventList | Returns the EventList collection of an object or the EventList collection that contains an Event object. Read-only. |
![]() |
GraphicItems | Returns the GraphicItems collection that the master contains. Read-only. |
![]() |
Hidden | Hides or shows a master on a stencil or a style in the user interface. Read/write. |
![]() |
Icon | Returns the icon contained in a master. Read/write |
![]() |
IconSize | Gets or sets the size of a master icon. Read/write. |
![]() |
IconUpdate | Determines whether a master icon is updated manually or automatically. Read/write. |
![]() |
ID | Gets the ID of an object. Read-only. |
![]() |
Index | Gets the ordinal position of a Master object in the Masters collection. Read-only. |
![]() |
IndexInStencil | Gets or sets the index of a master or master shortcut object within its stencil. Read/write. |
![]() |
IsChanged | Indicates whether a master has changed since it was opened. Read-only. |
![]() |
Layers | Returns the Layers collection of an object. Read-only. |
![]() |
MatchByName | Determines how the application decides if a document master is already present when an instance of a master is dropped on the drawing page. It allows changes made to a document master to apply to new instances of the master, even if the instances are dragged from a stand-alone stencil file. Read/write. |
![]() |
Name | Specifies the name of an object. Read-only. |
![]() |
NameU | Specifies the universal name of a Master object. Read/write. |
![]() |
NewBaseID | Generates a new base ID for a master. Read-only. |
![]() |
ObjectType | Returns an object's type. Read-only. |
![]() |
OLEObjects | Returns the OLEObjects collection of a master. Read-only. |
![]() |
OneD | Determines whether an object behaves as a one-dimensional (1-D) object. Read-only. |
![]() |
Original | Returns the original master that produced this open master. Read-only. |
![]() |
PageSheet | Returns the page sheet (an object that represents the ShapeSheet spreadsheet) of a master. Read-only. |
![]() |
PatternFlags | Determines whether a master behaves as a custom pattern. Read/write. |
![]() |
PersistsEvents | Indicates whether an object is capable of containing persistent events in its EventList collection. Read-only. |
![]() |
Picture | Returns a picture that represents an enhanced metafile (EMF) contained in a master, shape, selection, or page. Read-only. |
![]() |
Prompt | Gets or sets the prompt string for a master or master shortcut. Read/write. |
![]() |
Shapes | Returns the Shapes collection for a page, master, or group. Read-only. |
![]() |
SpatialSearch | Returns a Selection object whose shapes meet certain criteria in relation to a point that is expressed in the coordinate space of a page, master, or group. Read-only. |
![]() |
Stat | Returns status information for an object. Read-only. |
![]() |
Type | Returns the type of the Master object. Read-only. |
![]() |
UniqueID | Returns the unique ID of a master. Read-only. |
Events
Name | Description | |
---|---|---|
![]() |
BeforeMasterDelete | Occurs before a master is deleted from a document. |
![]() |
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. |
![]() |
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. |
![]() |
ConvertToGroupCanceled | Occurs after an event handler has returned True (cancel) to a QueryCancelConvertToGroup event. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
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. |
![]() |
ShapeParentChanged | Occurs after shapes are grouped or a group is ungrouped. |
![]() |
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. |